buri.ddmsence

Class AbstractTspiShape

Object

buri.ddmsence.AbstractBaseComponent

buri.ddmsence.AbstractTspiShape

All Implemented Interfaces:

IDDMSComponent, ITspiShape

Direct Known Subclasses:

Circle, Ellipse, Envelope, Point, Polygon

public abstract class AbstractTspiShape
extends AbstractBaseComponent
implements ITspiShape

Base class for TSPI shapes.

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

Extensions of this class are generally expected to be immutable, and the underlying XOM element MUST be set before the component is used.

For the initial support of DDMS 5.0 TSPI shapes, the DDMSence component will only return the raw XML of a shape. The TSPI specification is incredibly complex and multi-layered, and it is unclear how much value full-fledged classes would have. As use cases refine and more organizations adopt DDMS 5.0, the components can be revisited to provide more value-add.

History
None.

Nested Elements
Name Cardinality Availability None.

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 Component must not be used before the DDMS version in which it was introduced. 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 the gml:pos has an srsName, it must match the srsName of this Point. 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 No additional validation is done on the TSPI shape at this time.

Since:

2.2.0

Author:

Brian Uri!

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractTspiShape(nu.xom.Element element) Base constructor which works from a XOM element.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj) Test for logical equality.
String	getId() Accessor for the ID
SRSAttributes	getSRSAttributes() Accessor for the SRS Attributes.
int	hashCode() Returns a hashcode for the component.
protected void	validate() Base case for validation.

Methods inherited from class buri.ddmsence.AbstractBaseComponent

addDdms40Warning, addWarning, addWarnings, buildIndex, buildOutput, buildOutput, buildPrefix, getAttributeValue, getAttributeValue, getChild, getChildTextAsDouble, getDDMSVersion, getLocatorSuffix, getName, getNamespace, getNestedComponents, getOutput, getPrefix, getQualifiedName, getSecurityAttributes, getValidationWarnings, getXOMElement, getXOMElementCopy, requireAtLeastVersion, requireAtMostVersion, setXOMElement, toHTML, toString, toText, toXML, validateWarnings

Methods inherited from class Object

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

Methods inherited from interface buri.ddmsence.ddms.ITspiShape

getOutput

Methods inherited from interface buri.ddmsence.ddms.IDDMSComponent

getName, getNamespace, getPrefix, getQualifiedName, getSecurityAttributes, getValidationWarnings, getXOMElementCopy, toHTML, toText, toXML

Constructor Detail

AbstractTspiShape

protected AbstractTspiShape(nu.xom.Element element)
                     throws InvalidDDMSException

Base constructor which works from a XOM element.

Parameters:

element - the XOM element

Throws:

InvalidDDMSException

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()

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()

getId

public String getId()

Accessor for the ID

getSRSAttributes

public SRSAttributes getSRSAttributes()

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