buri.ddmsence.ddms.summary

Class GeospatialCoverage

Object

buri.ddmsence.AbstractBaseComponent

buri.ddmsence.ddms.summary.GeospatialCoverage

All Implemented Interfaces:

IDDMSComponent

public final class GeospatialCoverage
extends AbstractBaseComponent

An immutable implementation of ddms:geospatialCoverage.

Before DDMS 4.0.1, a geospatialCoverage element contains a nested GeospatialExtent element. Because DDMS does not decorate this element with any special attributes, it is not implemented as a Java object. Starting in DDMS 4.0.1, the GeospatialExtent wrapper has been removed.

Strictness

DDMSence is stricter than the specification in the following ways: No more than 1 each of geographicIdentifier, boundingBox, boundingGeometry, postalAddress, or verticalExtent can be used. The schema seems to support this assertion with explicit restrictions on those elements, but the enclosing xs:choice element allows multiples. From the specification, "The intent of Geospatial Coverage is to provide logically and semantically consistent information. Flexibility in the specification does not absolve end users using Geospatial Coverage from expressing information in a meaningful manner. Users should ensure that combinations of elements are appropriately relatable, consistent, meaningful, and useful for enterprise discovery."

Nested Elements

ddms:geographicIdentifier: an identifier (0-1 optional) implemented as a GeographicIdentifier ddms:boundingBox: a bounding box (0-1 optional) implemented as a BoundingBox ddms:boundingGeometry: a set of bounding geometry (0-1 optional) implemented as a BoundingGeometry ddms:postalAddress: an address (0-1 optional), implemented as a (@link PostalAddress) ddms:verticalExtent: an extent (0-1 optional), implemented as a (@link VerticalExtent)

Attributes
ddms:precedence: priority claimed or received as a result of preeminence. Used with country codes (optional, starting in DDMS 4.0.1) ddms:order: specifies a user-defined order of an element within the given document (optional, starting in DDMS 4.0.1) SecurityAttributes: The classification and ownerProducer attributes are optional. (starting in DDMS 3.0)

Since:

0.9.b

Author:

Brian Uri!

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
GeospatialCoverage(nu.xom.Element element) Constructor for creating a component from a XOM Element
GeospatialCoverage(GeographicIdentifier geographicIdentifier, BoundingBox boundingBox, BoundingGeometry boundingGeometry, PostalAddress postalAddress, VerticalExtent verticalExtent, String precedence, Integer order, SecurityAttributes securityAttributes) 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.
BoundingBox	getBoundingBox() Accessor for the boundingBox.
BoundingGeometry	getBoundingGeometry() Accessor for the boundingGeometry.
GeographicIdentifier	getGeographicIdentifier() Accessor for the geographicIdentifier.
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.
Integer	getOrder() Accessor for the order attribute.
String	getOutput(boolean isHTML, String prefix, String suffix) Renders this component as HTML or Text, with an optional prefix to nest it.
PostalAddress	getPostalAddress() Accessor for the postalAddress.
String	getPrecedence() Accessor for the precedence attribute.
SecurityAttributes	getSecurityAttributes() Accessor for the Security Attributes.
VerticalExtent	getVerticalExtent() Accessor for the verticalExtent.
boolean	hasFacilityIdentifier() Accessor for whether this geospatialCoverage is using a facility identifier.
int	hashCode() Returns a hashcode for the component.
protected void	validate() Validates the component.

Methods inherited from class buri.ddmsence.AbstractBaseComponent

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

Methods inherited from class Object

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

Constructor Detail

GeospatialCoverage

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

GeospatialCoverage

public GeospatialCoverage(GeographicIdentifier geographicIdentifier,
                  BoundingBox boundingBox,
                  BoundingGeometry boundingGeometry,
                  PostalAddress postalAddress,
                  VerticalExtent verticalExtent,
                  String precedence,
                  Integer order,
                  SecurityAttributes securityAttributes)
                   throws InvalidDDMSException

Constructor for creating a component from raw data

Parameters:

geographicIdentifier - an identifier (0-1 optional)

boundingBox - a bounding box (0-1 optional)

boundingGeometry - a set of bounding geometry (0-1 optional)

postalAddress - an address (0-1 optional)

verticalExtent - an extent (0-1 optional)

precedence - the precedence attribute (optional, starting in DDMS 4.0.1)

order - the order attribute (optional, starting in DDMS 4.0.1)

securityAttributes - any security attributes (optional)

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. At least 1 of geographicIdentifier, boundingBox, boundingGeometry, postalAddress, or verticalExtent must be used. No more than 1 geographicIdentifier, boundingBox, boundingGeometry, postalAddress, or verticalExtent can be used. If a geographicIdentifer is used and contains a facilityIdentifier, no other subcomponents can be used. The order and precedence cannot be used until DDMS 4.0.1 or later. If set, the precedence must be "Primary" or "Secondary". If a precedence is set, this coverage must contain a geographicIdentifier with a countryCode. Does not validate the value of the order attribute (this is done at the Resource level). The SecurityAttributes do not exist until DDMS 3.0 or later.

Overrides:

validate in class AbstractBaseComponent

Throws:

InvalidDDMSException - if any required information is missing or malformed

See Also:

AbstractBaseComponent.validate()

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

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

getPrecedence

public String getPrecedence()

Accessor for the precedence attribute.

getOrder

public Integer getOrder()

Accessor for the order attribute.

hasFacilityIdentifier

public boolean hasFacilityIdentifier()

Accessor for whether this geospatialCoverage is using a facility identifier.

getGeographicIdentifier

public GeographicIdentifier getGeographicIdentifier()

Accessor for the geographicIdentifier. May return null if not used.

getBoundingBox

public BoundingBox getBoundingBox()

Accessor for the boundingBox. May return null if not used.

getBoundingGeometry

public BoundingGeometry getBoundingGeometry()

Accessor for the boundingGeometry. May return null if not used.

getPostalAddress

public PostalAddress getPostalAddress()

Accessor for the postalAddress. May return null if not used.

getVerticalExtent

public VerticalExtent getVerticalExtent()

Accessor for the verticalExtent. May return null if not used.

getSecurityAttributes

public SecurityAttributes getSecurityAttributes()

Accessor for the Security Attributes. Will always be non-null, even if it has no values set.

Specified by:

getSecurityAttributes in interface IDDMSComponent

Overrides:

getSecurityAttributes in class AbstractBaseComponent