gov.usgs.earthquake.nshmp.geo.json

Class Feature

java.lang.Object

gov.usgs.earthquake.nshmp.geo.json.Feature

public class Feature
extends Object

A GeoJSON feature.

This class provides factory methods to create single-use GeoJSON feature builders for different geometries.

See GeoJson for examples.

Author:

Peter Powers, Brandon Clayton

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Feature.Builder A single-use feature builder.

Method Summary

Modifier and Type	Method and Description
LocationList	asLineString() Return the geometry of this feature as a line string.
Location	asPoint() Return the geometry of this feature as a point.
LocationList	asPolygonBorder() Return the border of this polygon feature.
double[]	bbox() The bounding box value array; may be null.
boolean	hasId() Return whether this feature has a non-null 'id' member.
int	idAsInt() The 'id' of this feature as an integer.
String	idAsString() The 'id' of this feature as a string.
static Feature.Builder	lineString(LocationList line) Create a single-use line string feature builder.
static Feature.Builder	point(Location location) Create a single-use point feature builder.
static Feature.Builder	polygon(LocationList exterior, LocationList... interiors) Create a single-use polygon feature builder.
Properties	properties() Get the property map associated with this feature as a Properties helper object.
GeoJson.Type	type() The GeoJSON geometry type of this feature, one of: [POINT, LINE_STRING, POLYGON].

Methods inherited from class java.lang.Object

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

Method Detail

point

public static Feature.Builder point(Location location)

Create a single-use point feature builder.

Parameters:

location - of point

lineString

public static Feature.Builder lineString(LocationList line)

Create a single-use line string feature builder.

Parameters:

line - locations

polygon

public static Feature.Builder polygon(LocationList exterior,
                                      LocationList... interiors)

Create a single-use polygon feature builder.

Parameters:

exterior - linear ring boundary of polygon

interiors - optional interior linear rings

hasId

public boolean hasId()

Return whether this feature has a non-null 'id' member.

idAsString

public String idAsString()

The 'id' of this feature as a string.

Throws:

NullPointerException - if this feature does not contain an 'id' member. Use hasId() to test whether 'id' member exists.

idAsInt

public int idAsInt()

The 'id' of this feature as an integer.

Throws:

NullPointerException - if this feature does not contain an 'id' member. Use hasId() to test whether 'id' member exists.

bbox

public double[] bbox()

The bounding box value array; may be null.

properties

public Properties properties()

Get the property map associated with this feature as a Properties helper object. May be null or empty.

type

public GeoJson.Type type()

The GeoJSON geometry type of this feature, one of: [POINT, LINE_STRING, POLYGON].

See Also:

GeoJson.Type

asPoint

public Location asPoint()

Return the geometry of this feature as a point.

Throws:

UnsupportedOperationException - if feature is not a point.

asLineString

public LocationList asLineString()

Return the geometry of this feature as a line string.

Throws:

UnsupportedOperationException - if feature is not a line string.

asPolygonBorder

public LocationList asPolygonBorder()

Return the border of this polygon feature.

Throws:

UnsupportedOperationException - if feature is not a polygon.