com.mapbox.services.commons.geojson

Class Feature

java.lang.Object

com.mapbox.services.commons.geojson.Feature

All Implemented Interfaces:

GeoJSON

public class Feature
extends java.lang.Object
implements GeoJSON

A GeoJSON object with the type "Feature" is a feature object.

Since:

1.0.0

See Also:

Official GeoJSON Feature Specifications

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Feature(Geometry geometry, com.google.gson.JsonObject properties, java.lang.String id) Private constructor.

Method Summary

Modifier and Type	Method and Description
void	addBooleanProperty(java.lang.String key, java.lang.Boolean value) Convenience method to add a Boolean member.
void	addCharacterProperty(java.lang.String key, java.lang.Character value) Convenience method to add a Character member.
void	addNumberProperty(java.lang.String key, java.lang.Number value) Convenience method to add a Number member.
void	addProperty(java.lang.String key, com.google.gson.JsonElement value) Convenience method to add a JsonElement member.
void	addStringProperty(java.lang.String key, java.lang.String value) Convenience method to add a String member.
static Feature	fromGeometry(Geometry geometry) Create a feature from geometry.
static Feature	fromGeometry(Geometry geometry, com.google.gson.JsonObject properties) Create a feature from geometry.
static Feature	fromGeometry(Geometry geometry, com.google.gson.JsonObject properties, java.lang.String id) Create a feature from geometry.
static Feature	fromJson(java.lang.String json) Create a GeoJSON feature object from JSON.
java.lang.Boolean	getBooleanProperty(java.lang.String key) Convenience method to get a Boolean member.
java.lang.Character	getCharacterProperty(java.lang.String key) Convenience method to get a Character member.
Geometry	getGeometry() Get the features Geometry.
java.lang.String	getId() The optional, common identifier of this feature.
java.lang.Number	getNumberProperty(java.lang.String key) Convenience method to get a Number member.
com.google.gson.JsonObject	getProperties() Returns the optional properties of this feature as JSON.
com.google.gson.JsonElement	getProperty(java.lang.String key) Convenience method to get a JsonElement member.
java.lang.String	getStringProperty(java.lang.String key) Convenience method to get a String member.
java.lang.String	getType() Should always be "Feature".
boolean	hasNonNullValueForProperty(java.lang.String key) Convenience method to check for a member by name as well as non-null value.
boolean	hasProperty(java.lang.String key) Convenience method to check if a member with the specified name is present in this object.
com.google.gson.JsonElement	removeProperty(java.lang.String key) Removes the property from the object properties
void	setGeometry(Geometry geometry)
void	setId(java.lang.String id)
void	setProperties(com.google.gson.JsonObject properties)
java.lang.String	toJson() Convert feature into JSON.

Methods inherited from class java.lang.Object

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

Constructor Detail

Feature

protected Feature(Geometry geometry,
                  com.google.gson.JsonObject properties,
                  java.lang.String id)

Private constructor.

Parameters:

geometry - Geometry object.

properties - of this feature as JSON.

id - common identifier of this feature.

Since:

1.0.0

Method Detail

getType

public java.lang.String getType()

Should always be "Feature".

Specified by:

getType in interface GeoJSON

Returns:

String "Feature".

Since:

1.0.0

getGeometry

public Geometry getGeometry()

Get the features Geometry.

Returns:

Geometry of the feature or null if not set.

Since:

1.0.0

setGeometry

public void setGeometry(Geometry geometry)

getProperties

public com.google.gson.JsonObject getProperties()

Returns the optional properties of this feature as JSON.

Returns:

the properties of this feature

Since:

1.0.0

setProperties

public void setProperties(com.google.gson.JsonObject properties)

getId

public java.lang.String getId()

The optional, common identifier of this feature.

Returns:

The common identifier of this feature, if set.

Since:

1.0.0

setId

public void setId(java.lang.String id)

fromGeometry

public static Feature fromGeometry(Geometry geometry)

Create a feature from geometry.

Parameters:

geometry - Geometry object.

Returns:

Feature

Since:

1.0.0

fromGeometry

public static Feature fromGeometry(Geometry geometry,
                                   com.google.gson.JsonObject properties)

Create a feature from geometry.

Parameters:

geometry - Geometry object.

properties - of this feature as JSON.

Returns:

Feature

Since:

1.0.0

fromGeometry

public static Feature fromGeometry(Geometry geometry,
                                   com.google.gson.JsonObject properties,
                                   java.lang.String id)

Create a feature from geometry.

Parameters:

geometry - Geometry object.

properties - of this feature as JSON.

id - common identifier of this feature.

Returns:

Feature

Since:

1.0.0

fromJson

public static Feature fromJson(java.lang.String json)

Create a GeoJSON feature object from JSON.

Parameters:

json - String of JSON making up a feature.

Returns:

Feature GeoJSON object.

Since:

1.0.0

toJson

public java.lang.String toJson()

Convert feature into JSON.

Specified by:

toJson in interface GeoJSON

Returns:

String containing feature JSON.

Since:

1.0.0

addStringProperty

public void addStringProperty(java.lang.String key,
                              java.lang.String value)

Convenience method to add a String member.

Parameters:

key - name of the member

value - the String value associated with the member

Since:

1.0.0

addNumberProperty

public void addNumberProperty(java.lang.String key,
                              java.lang.Number value)

Convenience method to add a Number member.

Parameters:

key - name of the member

value - the Number value associated with the member

Since:

1.0.0

addBooleanProperty

public void addBooleanProperty(java.lang.String key,
                               java.lang.Boolean value)

Convenience method to add a Boolean member.

Parameters:

key - name of the member

value - the Boolean value associated with the member

Since:

1.0.0

addCharacterProperty

public void addCharacterProperty(java.lang.String key,
                                 java.lang.Character value)

Convenience method to add a Character member.

Parameters:

key - name of the member

value - the Character value associated with the member

Since:

1.0.0

addProperty

public void addProperty(java.lang.String key,
                        com.google.gson.JsonElement value)

Convenience method to add a JsonElement member.

Parameters:

key - name of the member

value - the JsonElement value associated with the member

Since:

1.0.0

getStringProperty

public java.lang.String getStringProperty(java.lang.String key)

Convenience method to get a String member.

Parameters:

key - name of the member

Returns:

the value of the member, null if it doesn't exist

Since:

1.0.0

getNumberProperty

public java.lang.Number getNumberProperty(java.lang.String key)

Convenience method to get a Number member.

Parameters:

key - name of the member

Returns:

the value of the member, null if it doesn't exist

Since:

1.0.0

getBooleanProperty

public java.lang.Boolean getBooleanProperty(java.lang.String key)

Convenience method to get a Boolean member.

Parameters:

key - name of the member

Returns:

the value of the member, null if it doesn't exist

Since:

1.0.0

getCharacterProperty

public java.lang.Character getCharacterProperty(java.lang.String key)

Convenience method to get a Character member.

Parameters:

key - name of the member

Returns:

the value of the member, null if it doesn't exist

Since:

1.0.0

getProperty

public com.google.gson.JsonElement getProperty(java.lang.String key)

Convenience method to get a JsonElement member.

Parameters:

key - name of the member

Returns:

the value of the member, null if it doesn't exist

Since:

1.0.0

removeProperty

public com.google.gson.JsonElement removeProperty(java.lang.String key)

Removes the property from the object properties

Parameters:

key - name of the member

Returns:

Removed property from the key string passed in through the parameter.

Since:

1.0.0

hasProperty

public boolean hasProperty(java.lang.String key)

Convenience method to check if a member with the specified name is present in this object.

Parameters:

key - name of the member

Returns:

true if there is the member has the specified name, false otherwise.

Since:

1.0.0

hasNonNullValueForProperty

public boolean hasNonNullValueForProperty(java.lang.String key)

Convenience method to check for a member by name as well as non-null value.

Parameters:

key - name of the member

Returns:

true if member is present with non-null value, false otherwise.

Since:

1.3.0