com.mapbox.api.geocoding.v5.models

Class CarmenFeature.Builder

java.lang.Object

com.mapbox.api.geocoding.v5.models.CarmenFeature.Builder

Enclosing class:

CarmenFeature

public abstract static class CarmenFeature.Builder
extends java.lang.Object

This builder can be used to set the values describing the CarmenFeature.

Since:

3.0.0

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
abstract CarmenFeature.Builder	address(java.lang.String address) A string of the house number for the returned address feature.
abstract CarmenFeature.Builder	bbox(com.mapbox.geojson.BoundingBox bbox) A Feature might have a member named bbox to include information on the coordinate range for it's Features.
abstract CarmenFeature	build() Build a new CarmenFeature object.
abstract CarmenFeature.Builder	context(java.util.List<CarmenContext> contexts) A list representing the hierarchy of encompassing parent features.
abstract CarmenFeature.Builder	geometry(com.mapbox.geojson.Geometry geometry) The geometry which makes up this feature.
abstract CarmenFeature.Builder	id(java.lang.String id) A feature may have a commonly used identifier which is either a unique String or number.
abstract CarmenFeature.Builder	language(java.lang.String language) A string of the IETF language tag of the query's primary language.
abstract CarmenFeature.Builder	matchingPlaceName(java.lang.String matchingPlaceName) A string analogous to the CarmenFeature.placeName() field that more closely matches the query than results in the specified language.
abstract CarmenFeature.Builder	matchingText(java.lang.String matchingText) A string analogous to the CarmenFeature.text() field that more closely matches the query than results in the specified language.
abstract CarmenFeature.Builder	placeName(java.lang.String placeName) A string representing the feature in the requested language, if specified, and its full result hierarchy.
abstract CarmenFeature.Builder	placeType(java.util.List<java.lang.String> placeType) A list of feature types describing the feature.
abstract CarmenFeature.Builder	properties(com.google.gson.JsonObject properties) This contains the JSON object which holds the feature properties.
abstract CarmenFeature.Builder	rawCenter(double[] center) A Point object which represents the center point inside the CarmenFeature.bbox() if one is provided.
abstract CarmenFeature.Builder	relevance(java.lang.Double relevance) A numerical score from 0 (least relevant) to 0.99 (most relevant) measuring how well each returned feature matches the query.
abstract CarmenFeature.Builder	text(java.lang.String text) A string representing the feature in the requested language.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

bbox

public abstract CarmenFeature.Builder bbox(@Nullable
                                           com.mapbox.geojson.BoundingBox bbox)

A Feature might have a member named bbox to include information on the coordinate range for it's Features. The value of the bbox member MUST be a list of size 2*n where n is the number of dimensions represented in the contained feature geometries, with all axes of the most southwesterly point followed by all axes of the more northeasterly point. The axes order of a bbox follows the axes order of geometries.

Parameters:

bbox - a list of double coordinate values describing a bounding box

Returns:

this builder for chaining options together

Since:

3.0.0

id

public abstract CarmenFeature.Builder id(@Nullable
                                         java.lang.String id)

A feature may have a commonly used identifier which is either a unique String or number.

Parameters:

id - a String containing this features unique identification or null if one wasn't given during creation.

Returns:

this builder for chaining options together

Since:

3.0.0

geometry

public abstract CarmenFeature.Builder geometry(@Nullable
                                               com.mapbox.geojson.Geometry geometry)

The geometry which makes up this feature. A Geometry object represents points, curves, and surfaces in coordinate space. One of the seven geometries provided inside this library can be passed in through one of the static factory methods.

Parameters:

geometry - a single defined Geometry which makes this feature spatially aware

Returns:

this builder for chaining options together

Since:

3.0.0

properties

public abstract CarmenFeature.Builder properties(@Nullable
                                                 com.google.gson.JsonObject properties)

This contains the JSON object which holds the feature properties. The value of the properties member is a JsonObject and might be empty if no properties are provided.

Parameters:

properties - a JsonObject which holds this features current properties

Returns:

this builder for chaining options together

Since:

3.0.0

text

public abstract CarmenFeature.Builder text(@Nullable
                                           java.lang.String text)

A string representing the feature in the requested language.

Parameters:

text - text representing the feature (e.g. "Austin")

Returns:

this builder for chaining options together

Since:

3.0.0

placeName

public abstract CarmenFeature.Builder placeName(@Nullable
                                                java.lang.String placeName)

A string representing the feature in the requested language, if specified, and its full result hierarchy.

Parameters:

placeName - human-readable text representing the full result hierarchy (e.g. "Austin, Texas, United States")

Returns:

this builder for chaining options together

Since:

3.0.0

placeType

public abstract CarmenFeature.Builder placeType(@Nullable
                                                java.util.List<java.lang.String> placeType)

A list of feature types describing the feature. Options are one of the following types defined in the GeocodingCriteria.GeocodingTypeCriteria. Most features have only one type, but if the feature has multiple types, (for example, Vatican City is a country, region, and place), all applicable types will be provided in the list.

Parameters:

placeType - a list containing the place type

Returns:

this builder for chaining options together

Since:

3.0.0

address

public abstract CarmenFeature.Builder address(@Nullable
                                              java.lang.String address)

A string of the house number for the returned address feature. Note that unlike the address property for poi features, this property is outside the properties object.

Parameters:

address - while the string content isn't guaranteed, and might return null, in many cases, this will be the house number

Returns:

this builder for chaining options together

Since:

3.0.0

rawCenter

public abstract CarmenFeature.Builder rawCenter(@Nullable
                                                double[] center)

A Point object which represents the center point inside the CarmenFeature.bbox() if one is provided.

Parameters:

center - a GeoJson Point which defines the center location of this feature

Returns:

this builder for chaining options together

Since:

3.0.0

context

public abstract CarmenFeature.Builder context(@Nullable
                                              java.util.List<CarmenContext> contexts)

A list representing the hierarchy of encompassing parent features. This is where you can find telephone, address, and other information pertaining to this feature.

Parameters:

contexts - a list made up of CarmenContext which might contain additional information about this specific feature

Returns:

this builder for chaining options together

Since:

3.0.0

relevance

public abstract CarmenFeature.Builder relevance(@Nullable
                                                java.lang.Double relevance)

A numerical score from 0 (least relevant) to 0.99 (most relevant) measuring how well each returned feature matches the query. You can use this property to remove results which don't fully match the query.

Parameters:

relevance - the relevant score between 0 and 1

Returns:

this builder for chaining options together

Since:

1.0.0

matchingText

public abstract CarmenFeature.Builder matchingText(@Nullable
                                                   java.lang.String matchingText)

A string analogous to the CarmenFeature.text() field that more closely matches the query than results in the specified language. For example, querying "Köln, Germany" with language set to English might return a feature with the CarmenFeature.text() "Cologne" and this would be "Köln".

Parameters:

matchingText - a string containing the matching text

Returns:

this builder for chaining options together

Since:

3.0.0

matchingPlaceName

public abstract CarmenFeature.Builder matchingPlaceName(@Nullable
                                                        java.lang.String matchingPlaceName)

A string analogous to the CarmenFeature.placeName() field that more closely matches the query than results in the specified language. For example, querying "Köln, Germany" with language set to English might return a feature with the CarmenFeature.placeName() "Cologne, Germany" and this would return "Köln, North Rhine-Westphalia, Germany".

Parameters:

matchingPlaceName - a string containing the matching place name

Returns:

this builder for chaining options together

Since:

3.0.0

language

public abstract CarmenFeature.Builder language(@Nullable
                                               java.lang.String language)

A string of the IETF language tag of the query's primary language.

Parameters:

language - string containing the query's primary language

Returns:

this builder for chaining options together

Since:

2.2.0

See Also:

IETF language tag Wikipedia page

build

public abstract CarmenFeature build()

Build a new CarmenFeature object.

Returns:

a new CarmenFeature using the provided values in this builder

Since:

3.0.0