GeospatialCoverage (DDMSence 2.6.0 API)

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. *

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

History
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. The introduction of TSPI deprecated the boundingBox and verticalExtent components in DDMS 5.0.

History

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.

The introduction of TSPI deprecated the boundingBox and verticalExtent components in DDMS 5.0.

Nested Elements

Name

Cardinality

Availability

ddms:geographicIdentifier

0..1

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

ddms:boundingBox

0..1

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

ddms:boundingGeometry

0..1

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

ddms:postalAddress

0..1

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

ddms:verticalExtent

0..1

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

Attributes

Name

Cardinality

Availability

ddms:precedence

0..1

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

ddms:order

0..1

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

ism:<securityAttributes>

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

This component must contain at least 1 child element.

Error

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

Only 1 of each type of child element must be used.

Error

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

If a ddms:geographicIdentifier is used and contains a ddms:facilityIdentifier, no other child elements must be used.

Error

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

ddms:order 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

ddms:precedence 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

If set, ddms:precedence must be a valid token.

Error

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

If ddms:precedence exists, this component must contain a ddms:geographicIdentifier with a ddms:countryCode.

Error

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

Security attributes must not be used before the DDMS version in which they were introduced.

Error

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

Does not validate the value of the order attribute (this is done at the Resource level).

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.

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

Field Summary
- Fields inherited from class buri.ddmsence.AbstractBaseComponent
  OUTPUT_TEMPLATES

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

All Methods Static Methods Instance Methods Concrete 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.
`String`	`getHTMLTextOutput(OutputFormat format, String prefix, String suffix)` Renders this component as HTML or Text, with an optional prefix to nest it.
`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.
`Integer`	`getOrder()` Accessor for the order attribute.
`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()` Base case for validation.

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, getValidationWarnings, getXOMElement, getXOMElementCopy, requireAtLeastVersion, requireAtMostVersion, setXOMElement, toHTML, toJSON, 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
    
    boundingBox - a bounding box
    
    boundingGeometry - a set of bounding geometry
    
    postalAddress - an address
    
    verticalExtent - an extent
    
    precedence - the precedence attribute
    
    order - the order attribute
    
    securityAttributes - any security attributes
    
    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()
  - 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
  - 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

Class GeospatialCoverage

Nested Class Summary

Field Summary

Fields inherited from class buri.ddmsence.AbstractBaseComponent

Constructor Summary

Method Summary

Methods inherited from class buri.ddmsence.AbstractBaseComponent

Methods inherited from class Object

Constructor Detail

GeospatialCoverage

GeospatialCoverage

Method Detail

validate

getLocatorSuffix

getJSONObject

getHTMLTextOutput

getNestedComponents

equals

hashCode

getName

getPrecedence

getOrder

hasFacilityIdentifier

getGeographicIdentifier

getBoundingBox

getBoundingGeometry

getPostalAddress

getVerticalExtent

getSecurityAttributes