buri.ddmsence.ddms.summary.gml

Class Point

Object

buri.ddmsence.AbstractBaseComponent

buri.ddmsence.ddms.summary.gml.Point

All Implemented Interfaces:

IDDMSComponent

public final class Point
extends AbstractBaseComponent

An immutable implementation of gml:Point.

Strictness
DDMSence is stricter than the specification in the following ways: The srsName must also be non-empty.

Nested Elements
gml:pos: the position (exactly 1 required), implemented as a Position

Attributes
gml:id: unique ID (required) SRSAttributes

Since:

0.9.b

Author:

Brian Uri!

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Point.Builder Builder for this DDMS component.

Constructor Summary

Constructors

Constructor and Description
Point(nu.xom.Element element) Constructor for creating a component from a XOM Element
Point(Position position, SRSAttributes srsAttributes, String id) Constructor for creating a component from raw data

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj) Test for logical equality.
String	getId() Accessor for the ID
static String	getName(DDMSVersion version) Accessor for the element name of this component, based on the version of DDMS used
protected List<IDDMSComponent>	getNestedComponents() Accessor for a collection of nested components.
String	getOutput(boolean isHTML, String prefix, String suffix) Renders this component as HTML or Text, with an optional prefix to nest it.
Position	getPosition() Accessor for the coordinates of the position.
SRSAttributes	getSRSAttributes() Accessor for the SRS Attributes.
int	hashCode() Returns a hashcode for the component.
protected void	validate() Validates the component.
protected void	validateWarnings() Validates any conditions that might result in a warning.

Methods inherited from class buri.ddmsence.AbstractBaseComponent

addDdms40Warning, addWarning, addWarnings, buildIndex, buildOutput, buildOutput, buildPrefix, getAttributeValue, getAttributeValue, getChild, getChildTextAsDouble, getDDMSVersion, getLocatorSuffix, getName, getNamespace, getPrefix, getQualifiedName, getSecurityAttributes, getStringAsDouble, getValidationWarnings, getXOMElement, getXOMElementCopy, requireVersion, setXOMElement, toHTML, toString, toText, toXML

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Point

public Point(nu.xom.Element element)
      throws InvalidDDMSException

Constructor for creating a component from a XOM Element

Parameters:

element - the XOM element representing this

Throws:

InvalidDDMSException - if any required information is missing or malformed

Point

public Point(Position position,
     SRSAttributes srsAttributes,
     String id)
      throws InvalidDDMSException

Constructor for creating a component from raw data

Parameters:

position - the position of the Point (required)

srsAttributes - the attribute group containing srsName, srsDimension, axisLabels, and uomLabels (srsName required)

id - the id value (required)

Throws:

InvalidDDMSException - if any required information is missing or malformed

Method Detail

validate

protected void validate()
                 throws InvalidDDMSException

Validates the component.

Rules
The qualified name of the element is correct. The srsName is required. The ID is required, and must be a valid NCName. If the position has an srsName, it matches the srsName of this Point. Does not perform any special validation on the third coordinate (height above ellipsoid).

Overrides:

validate in class AbstractBaseComponent

Throws:

InvalidDDMSException

See Also:

AbstractBaseComponent.validate()

validateWarnings

protected void validateWarnings()

Validates any conditions that might result in a warning.

Rules
Include any validation warnings from the SRS attributes.

Overrides:

validateWarnings in class AbstractBaseComponent

getOutput

public String getOutput(boolean isHTML,
               String prefix,
               String suffix)

Description copied from class: AbstractBaseComponent

Renders this component as HTML or Text, with an optional prefix to nest it.

Specified by:

getOutput in class AbstractBaseComponent

Parameters:

isHTML - true for HTML, false for Text.

prefix - an optional prefix to put on each name.

suffix - an optional suffix to append to each name, such as an index.

Returns:

the HTML or Text representation of this component

See Also:

AbstractBaseComponent.getOutput(boolean, String, String)

getNestedComponents

protected List<IDDMSComponent> getNestedComponents()

Description copied from class: AbstractBaseComponent

Accessor for a collection of nested components. A list such as this is useful for bulk actions, such as checking emptiness, equality, generating hash codes, or applying mass validation.

Overrides:

getNestedComponents in class AbstractBaseComponent

See Also:

AbstractBaseComponent.getNestedComponents()

equals

public boolean equals(Object obj)

Description copied from class: AbstractBaseComponent

Test for logical equality.

The base case tests against the name value and namespaceURI, as well as any child components classified as "nested components" and any security attributes. Extending classes may require additional rules for equality. This case automatically includes any nested components or security attributes.

Overrides:

equals in class AbstractBaseComponent

See Also:

Object.equals(Object)

hashCode

public int hashCode()

Description copied from class: AbstractBaseComponent

Returns a hashcode for the component.

This automatically includes any nested components or security attributes.

Overrides:

hashCode in class AbstractBaseComponent

See Also:

Object.hashCode()

getName

public static String getName(DDMSVersion version)

Accessor for the element name of this component, based on the version of DDMS used

Parameters:

version - the DDMSVersion

Returns:

an element name

getSRSAttributes

public SRSAttributes getSRSAttributes()

Accessor for the SRS Attributes. Will always be non-null.

getId

public String getId()

Accessor for the ID

getPosition

public Position getPosition()

Accessor for the coordinates of the position. May return null, but cannot happen after instantiation.