buri.ddmsence.ddms.summary.gml

Class Polygon

Object

buri.ddmsence.AbstractBaseComponent

buri.ddmsence.ddms.summary.gml.Polygon

All Implemented Interfaces:

IDDMSComponent

public final class Polygon
extends AbstractBaseComponent

An immutable implementation of gml:Polygon.

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

A Polygon element contains a nested gml:exterior element, which itself contains a nested gml:LinearRing element. The points which mark the boundaries of the polygon should be provided in counter-clockwise order. Because DDMS does not decorate these elements with any special attributes, they are not implemented as Java objects.

History
The GML profile was removed in favour of TSPI in DDMS 5.0.

Nested Elements
Name Cardinality Availability gml:pos 4..* In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0

Attributes
Name Cardinality Availability gml:id 1 In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 <srsAttributes> 0..* In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0

Validation Rules

Rule Type Applicability The qualified name of this element must be correct. Error In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 The srsName must exist. Error In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 The gml:id must exist, and must be a valid NCName. Error In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 If a gml:pos has an srsName, it must match the srsName of this Polygon. Error In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 The first and last position coordinates must be identical (a closed polygon). Error In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 Warnings from any SRS attributes are claimed by this component. Warning In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0

Since:

0.9.b

Author:

Brian Uri!

Nested Class Summary

Nested Classes

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

Field Summary

Fields inherited from class buri.ddmsence.AbstractBaseComponent

OUTPUT_TEMPLATES

Constructor Summary

Constructors

Constructor and Description
Polygon(nu.xom.Element element) Constructor for creating a component from a XOM Element
Polygon(List<Position> positions, SRSAttributes srsAttributes, String id) Constructor for creating a component from raw data

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Test for logical equality.
String	getHTMLTextOutput(OutputFormat format, String prefix, String suffix) Renders this component as HTML or Text, with an optional prefix to nest it.
String	getId() Accessor for the ID
com.google.gson.JsonObject	getJSONObject() Renders this component as a JSON object, which can either be converted to a JSON string or inserted into the parent JSON object.
protected String	getLocatorSuffix() Can be overridden to change the locator string used in warnings and errors.
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.
List<Position>	getPositions() Accessor for the coordinates.
SRSAttributes	getSRSAttributes() Accessor for the SRS Attributes.
int	hashCode() Returns a hashcode for the component.
protected void	validate() Base case for validation.
protected void	validateWarnings() Base case for warnings.

Methods inherited from class buri.ddmsence.AbstractBaseComponent

addDdms40Warning, addJson, addJson, addJson, addJson, addWarning, addWarnings, buildHTMLTextOutput, buildHTMLTextOutput, buildIndex, buildPrefix, getAttributeValue, getAttributeValue, getChild, getChildTextAsDouble, getDDMSVersion, getName, getNamespace, getPrefix, getQualifiedName, getSecurityAttributes, getValidationWarnings, getXOMElement, getXOMElementCopy, requireAtLeastVersion, requireAtMostVersion, setXOMElement, toHTML, toJSON, toString, toText, toXML

Methods inherited from class Object

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

Constructor Detail

Polygon

public Polygon(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

Polygon

public Polygon(List<Position> positions,
               SRSAttributes srsAttributes,
               String id)
        throws InvalidDDMSException

Constructor for creating a component from raw data

Parameters:

positions - the positions of the Polygon

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

id - the id value

Throws:

InvalidDDMSException - if any required information is missing or malformed

Method Detail

validate

protected void validate()
                 throws InvalidDDMSException

Description copied from class: AbstractBaseComponent

Base case for validation. This method can be overridden for more in-depth validation. It is always assumed that the subcomponents of a component are already valid.

Overrides:

validate in class AbstractBaseComponent

Throws:

InvalidDDMSException

See Also:

AbstractBaseComponent.validate()

validateWarnings

protected void validateWarnings()

Description copied from class: AbstractBaseComponent

Base case for warnings. This method can be overridden for more in-depth validation. It is always assumed that the subcomponents of a component are already valid.

Overrides:

validateWarnings in class AbstractBaseComponent

See Also:

AbstractBaseComponent.validateWarnings()

getLocatorSuffix

protected String getLocatorSuffix()

Description copied from class: AbstractBaseComponent

Can be overridden to change the locator string used in warnings and errors.

For components such as Format, there are wrapper elements that are not implemented as Java objects. These elements should be included in the XPath string used to identify the source of the error.

For example, if a ddms:extent element has a warning and the ddms:format element reports it, the locator information should be "/ddms:format/ddms:Media/ddms:extent" and not the default of "/ddms:format/ddms:extent"

Overrides:

getLocatorSuffix in class AbstractBaseComponent

Returns:

an empty string, unless overridden.

See Also:

AbstractBaseComponent.getLocatorSuffix()

getJSONObject

public com.google.gson.JsonObject getJSONObject()

Description copied from class: AbstractBaseComponent

Renders this component as a JSON object, which can either be converted to a JSON string or inserted into the parent JSON object. Although this method is marked a public, it is only intended to be used internally, and is not part of the IDDMSComponent interface. Use the toJSON() method as the public way to get JSON output.

Specified by:

getJSONObject in class AbstractBaseComponent

See Also:

AbstractBaseComponent.getJSONObject()

getHTMLTextOutput

public String getHTMLTextOutput(OutputFormat format,
                                String prefix,
                                String suffix)

Description copied from class: AbstractBaseComponent

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

I consider this to be an internal method, that unfortunately must be marked as public to allow cross-package access when generating output. Use toHTML() and toText() as the formal, public methods to generate output.

Specified by:

getHTMLTextOutput in class AbstractBaseComponent

Parameters:

format - the desired format of this output

prefix - an optional prefix to put on each name.

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

Returns:

the representation of this component in the specified format

See Also:

AbstractBaseComponent.getHTMLTextOutput(OutputFormat, 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

getPositions

public List<Position> getPositions()

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