com.cocoahero.android.geojson

Class Feature

java.lang.Object

com.cocoahero.android.geojson.GeoJSONObject

com.cocoahero.android.geojson.Feature

All Implemented Interfaces:

Parcelable

public class Feature
extends GeoJSONObject

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

Parcelable.ClassLoaderCreator<T>, Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static Parcelable.Creator<Feature>	CREATOR

Fields inherited from class com.cocoahero.android.geojson.GeoJSONObject

JSON_TYPE

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
Feature() Creates an empty Feature without a geometry.
Feature(Geometry geometry) Creates a new GeoJSON Feature object with the given geometry.
Feature(JSONObject json) Parses the given JSONObject as a GeoJSON Feature.

Method Summary

Modifier and Type	Method and Description
Geometry	getGeometry() Returns the geometry of this feature.
String	getIdentifier() The optional, common identifier of this feature.
JSONObject	getProperties() Returns the optional properties of this feature as JSON.
String	getType() The type of GeoJSON object.
void	setGeometry(Geometry geometry) Sets the Geometry of this feature.
void	setIdentifier(String identifier) Sets the optional, common identifier of this feature.
void	setProperties(JSONObject properties) Sets the properties of this feature.
JSONObject	toJSON() Formats the object's attributes as GeoJSON.

Methods inherited from class com.cocoahero.android.geojson.GeoJSONObject

describeContents, readParcel, writeToParcel

Methods inherited from class java.lang.Object

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

Field Detail

CREATOR

public static final Parcelable.Creator<Feature> CREATOR

Constructor Detail

Feature

public Feature()

Creates an empty Feature without a geometry.

Feature

public Feature(JSONObject json)

Parses the given JSONObject as a GeoJSON Feature.

Parameters:

json -

Feature

public Feature(Geometry geometry)

Creates a new GeoJSON Feature object with the given geometry.

Parameters:

geometry -

Method Detail

getIdentifier

public String getIdentifier()

The optional, common identifier of this feature.

Returns:

The common identifier of this feature, if set.

setIdentifier

public void setIdentifier(String identifier)

Sets the optional, common identifier of this feature.

Parameters:

identifier -

getGeometry

public Geometry getGeometry()

Returns the geometry of this feature. It will be a concrete instance of Geometry.

Returns:

the geometry of this feature, or null if not set.

setGeometry

public void setGeometry(Geometry geometry)

Sets the Geometry of this feature.

Parameters:

geometry -

getProperties

public JSONObject getProperties()

Returns the optional properties of this feature as JSON.

Returns:

the properties of this feature

setProperties

public void setProperties(JSONObject properties)

Sets the properties of this feature.

Parameters:

properties -

getType

public String getType()

The type of GeoJSON object. This will be one of the constants defined in GeoJSON, such as GeoJSON.TYPE_FEATURE.

Specified by:

getType in class GeoJSONObject

Returns:

The type of GeoJSON object.

toJSON

public JSONObject toJSON()
                  throws JSONException

Formats the object's attributes as GeoJSON.

Overrides:

toJSON in class GeoJSONObject

Returns:

A GeoJSON formatted JSONObject

Throws:

JSONException