senselogic.sitevision.api.metadata.builder

Interface GeolocationValueBuilder

All Superinterfaces:

Builder<GeolocationValue>

@Requireable(value="GeolocationValueBuilder")
public interface GeolocationValueBuilder
extends Builder<GeolocationValue>

Builder to create GeolocationValue instances that can be used to set geolocation metadata.

GeolocationValueBuilder has three mandatory attributes:

• name - The location name. Must not be null or blank.
• latitude - The Latitude. Must be a double value within range [-90.0 ... 90.0].
• longitude - The Longitude. Must be a double value within range [-180.0 ... 180.0].

Using the GeolocationValueBuilder is pretty straightforward, if you remember that it is stateful. Conceptually you would typically use it like this:

1. Get the GeolocationValueBuilder
2. Set the name
3. Set the latitude
4. Set the longitude
5. Do build

When you have built a GeolocationValue instance, you can re-use the GeolocationValueBuilder to build more instances. Something like:

1. Possibly set a new name
2. Possibly set a new latitude
3. Possibly set a new longitude
4. Do build

Tip! The Builder interface documentation contains more information about Builders and how to work with them!

An instance of the Sitevision class implementing this interface can be obtained via MetadataUtil.getGeolocationValueBuilder(). See MetadataUtil for how to obtain an instance of the MetadataUtil interface.

Since:

Sitevision 2025.11.1

Author:

Magnus Lövgren

Method Summary

Modifier and Type	Method and Description
GeolocationValue	build() Creates a GeolocationValue instance using current state of this builder.
GeolocationValueBuilder	setLatitude(double aLatitude) Sets the latitude.
GeolocationValueBuilder	setLongitude(double aLongitude) Sets the longitude.
GeolocationValueBuilder	setName(String aLocationName) Sets the location name.

Method Detail

setName

GeolocationValueBuilder setName(String aLocationName)

Sets the location name.

Parameters:

aLocationName - the location name, must not be null or blank

Returns:

this builder

setLatitude

GeolocationValueBuilder setLatitude(double aLatitude)

Sets the latitude.

Parameters:

aLatitude - the latitude, must be within range [-90.0 ... 90.0]

Returns:

this builder

setLongitude

GeolocationValueBuilder setLongitude(double aLongitude)

Sets the longitude.

Parameters:

aLongitude - the longitude, must be within range [-180.0 ... 180.0]

Returns:

this builder

build

GeolocationValue build()
                throws IllegalStateException

Creates a GeolocationValue instance using current state of this builder.

Specified by:

build in interface Builder<GeolocationValue>

Returns:

a geolocation value

Throws:

IllegalStateException - if the name, longitude or latitude value are invalid