us.gov.dod.standard.ssrf._3_1.location

Class PolygonPoint

java.lang.Object

us.gov.dod.standard.ssrf._3_1.location.PolygonPoint

public class PolygonPoint
extends Object

PolygonPoint contains the coordinates (WGS 84) of point(s) that represent a vertex of the polygon. Polygon points are described in a clockwise direction. If the last point is different from the first point, it is assumed that they are connected to complete the boundary of the polygon.

Element of Polygon

Version:

3.1.0, 03/30/2015

Author:

Key Bridge LLC

Constructor Summary

Constructors

Constructor and Description
PolygonPoint()

Method Summary

Modifier and Type	Method and Description
Lat	getLat() Get the geographical latitude (degrees, minutes, seconds and hemisphere N or S) of the Point or center of the Ellipse.
Lon	getLon() Get the geographical longitude (degrees, minutes, seconds, and hemisphere E or W) of the Point or center of the Ellipse.
BigInteger	getSequence() Get a unique, sequenced, index for each point describing the current polygon..
boolean	isSet() Determine if the required fields in this SSRF data type instance are set.
boolean	isSetLat() Determine if the Lat is configured.
boolean	isSetLon() Determine if the Lon is configured.
boolean	isSetSequence() Determine if the Sequence is configured.
void	setLat(Lat value) Set the geographical latitude (degrees, minutes, seconds and hemisphere N or S) of the Point or center of the Ellipse.
void	setLon(Lon value) Set the geographical longitude (degrees, minutes, seconds, and hemisphere E or W) of the Point or center of the Ellipse.
void	setSequence(BigInteger value) Set a unique, sequenced, index for each point describing the current polygon..
String	toString() Get a string representation of this PolygonPoint instance configuration.
PolygonPoint	withLat(Double value) Set the geographical latitude in decimal degrees.
PolygonPoint	withLat(String value) Set the geographical latitude (degrees, minutes, seconds and hemisphere N or S) of the Point or center of the Ellipse.
PolygonPoint	withLon(Double value) Set the geographical longitude in decimal degrees.
PolygonPoint	withLon(String value) Set the geographical longitude (degrees, minutes, seconds, and hemisphere E or W) of the Point or center of the Ellipse.
PolygonPoint	withSequence(BigInteger value) Set a unique, sequenced, index for each point describing the current polygon.

Methods inherited from class java.lang.Object

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

Constructor Detail

PolygonPoint

public PolygonPoint()

Method Detail

getLon

public Lon getLon()

Get the geographical longitude (degrees, minutes, seconds, and hemisphere E or W) of the Point or center of the Ellipse. If the seconds are not known, use 00, except in the case of navigation aid systems, geostationary satellites, and microwave facilities where seconds are required. Use leading zeros as appropriate for degrees, minutes, or seconds. Degrees longitude require three digits. Seconds may have a decimal point followed by up to two decimals. enter E or W immediately following the seconds. The format is: dddmmss.hhH (where ".hh" is optional and H = E or W)..

Returns:

a Lon instance

Since:

3.1.0

setLon

public void setLon(Lon value)

Set the geographical longitude (degrees, minutes, seconds, and hemisphere E or W) of the Point or center of the Ellipse. If the seconds are not known, use 00, except in the case of navigation aid systems, geostationary satellites, and microwave facilities where seconds are required. Use leading zeros as appropriate for degrees, minutes, or seconds. Degrees longitude require three digits. Seconds may have a decimal point followed by up to two decimals. enter E or W immediately following the seconds. The format is: dddmmss.hhH (where ".hh" is optional and H = E or W)..

Parameters:

value - a Lon instance

Since:

3.1.0

isSetLon

public boolean isSetLon()

Determine if the Lon is configured.

Returns:

TRUE if the field is set, FALSE if the field is null

getLat

public Lat getLat()

Get the geographical latitude (degrees, minutes, seconds and hemisphere N or S) of the Point or center of the Ellipse. Same remarks for seconds and leading zeros. enter N or S immediately following the seconds. The format is: ddmmss.hhH (where ".hh" is optional and H = N or S)..

Returns:

a Lat instance

Since:

3.1.0

setLat

public void setLat(Lat value)

Set the geographical latitude (degrees, minutes, seconds and hemisphere N or S) of the Point or center of the Ellipse. Same remarks for seconds and leading zeros. enter N or S immediately following the seconds. The format is: ddmmss.hhH (where ".hh" is optional and H = N or S)..

Parameters:

value - a Lat instance

Since:

3.1.0

isSetLat

public boolean isSetLat()

Determine if the Lat is configured.

Returns:

TRUE if the field is set, FALSE if the field is null

getSequence

public BigInteger getSequence()

Get a unique, sequenced, index for each point describing the current polygon..

Returns:

a BigInteger instance

Since:

3.1.0

setSequence

public void setSequence(BigInteger value)

Set a unique, sequenced, index for each point describing the current polygon..

Parameters:

value - a BigInteger instance

Since:

3.1.0

isSetSequence

public boolean isSetSequence()

Determine if the Sequence is configured.

Returns:

TRUE if the field is set, FALSE if the field is null

withLon

public PolygonPoint withLon(String value)
                     throws Exception

Set the geographical longitude (degrees, minutes, seconds, and hemisphere E or W) of the Point or center of the Ellipse. If the seconds are not known, use 00, except in the case of navigation aid systems, geostationary satellites, and microwave facilities where seconds are required. Use leading zeros as appropriate for degrees, minutes, or seconds. Degrees longitude require three digits. Seconds may have a decimal point followed by up to two decimals. enter E or W immediately following the seconds. The format is: dddmmss.hhH (where ".hh" is optional and H = E or W).

Parameters:

value - An instances of type String.

Returns:

The current PolygonPoint object instance.

Throws:

Exception

Since:

3.1.0

withLon

public PolygonPoint withLon(Double value)

Set the geographical longitude in decimal degrees.

Parameters:

value - The coordinate value in decimal degrees

Returns:

The current PolygonPoint object instance.

Since:

3.1.0

withLat

public PolygonPoint withLat(String value)
                     throws Exception

Set the geographical latitude (degrees, minutes, seconds and hemisphere N or S) of the Point or center of the Ellipse. Same remarks for seconds and leading zeros. enter N or S immediately following the seconds. The format is: ddmmss.hhH (where ".hh" is optional and H = N or S).

Parameters:

value - An instances of type String.

Returns:

The current PolygonPoint object instance.

Throws:

Exception

Since:

3.1.0

withLat

public PolygonPoint withLat(Double value)

Set the geographical latitude in decimal degrees.

Parameters:

value - The coordinate value in decimal degrees

Returns:

The current PolygonPoint object instance.

Since:

3.1.0

withSequence

public PolygonPoint withSequence(BigInteger value)

Set a unique, sequenced, index for each point describing the current polygon.

Parameters:

value - An instances of type BigInteger.

Returns:

The current PolygonPoint object instance.

Since:

3.1.0

toString

public String toString()

Get a string representation of this PolygonPoint instance configuration.

Overrides:

toString in class Object

Returns:

The current object instance configuration as a non-null String

isSet

public boolean isSet()

Determine if the required fields in this SSRF data type instance are set.

PolygonPoint requires Lat, Lon, sequence.

Note that this method only checks for the presence of required information; this method does not validate the information format.

Returns:

TRUE if required fields are set, otherwise FALSE