buri.ddmsence.ddms.summary

Class VerticalExtent

Object

buri.ddmsence.AbstractBaseComponent

buri.ddmsence.ddms.summary.VerticalExtent

All Implemented Interfaces:

IDDMSComponent

public final class VerticalExtent
extends AbstractBaseComponent

An immutable implementation of ddms:verticalExtent.

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

The optional unitOfMeasure and datum on the minVerticalExtent/maxVerticalExtent child elements MUST match the values on the required attributes of the same name on this element. It does not seem logical to specify these attributes on the parent element and then express the actual values with a different measure. Note that because DDMSence is giving precedence to the top-level unitOfMeasure and datum attributes, those attributes on the children are not displayed in HTML/JSON/Text. However, they are still rendered in XML, if present in an existing document.

The above design decision dictates that VerticalDistance (the type behind minVerticalExtent and maxVerticalExtent) does not need to be implemented as a Java class.

History
The names of the nested elements were made lowercase in DDMS 4.0.1. This component is functionally replaced by a TSPI Point in DDMS 5.0.

Nested Elements
Name Cardinality Availability ddms:minVerticalExtent 1 In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 ddms:maxVerticalExtent 1 In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0

Attributes
Name Cardinality Availability ddms:unitOfMeasure 1 In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 ddms:datum 1 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 after the DDMS version in which it was removed. Error In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 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 ddms:minVerticalExtent must exist. Error In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 ddms:maxVerticalExtent must exist. Error In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 ddms:unitOfMeasure must exist, and must be a valid token. Error In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 ddms:datum must exist, and must be a valid token. Error In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 If a minVerticalExtent has unitOfMeasure or datum set, its values must match the parent attribute values. Error In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 If a maxVerticalExtent has unitOfMeasure or datum set, its values must match the parent attribute values. Error In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 ddms:minVerticalExtent must be less than ddms:maxVerticalExtent. Error 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	VerticalExtent.Builder Builder for this DDMS component.

Field Summary

Fields inherited from class buri.ddmsence.AbstractBaseComponent

OUTPUT_TEMPLATES

Constructor Summary

Constructors

Constructor and Description
VerticalExtent(double minVerticalExtent, double maxVerticalExtent, String unitOfMeasure, String datum) Constructor for creating a component from raw data
VerticalExtent(nu.xom.Element element) Constructor for creating a component from a XOM Element

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Test for logical equality.
String	getDatum() Accessor for the vertical datum attribute
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.
Double	getMaxVerticalExtent() Accessor for the maximum extent
Double	getMinVerticalExtent() Accessor for the minimum extent
static String	getName(DDMSVersion version) Accessor for the element name of this component, based on the version of DDMS used
String	getUnitOfMeasure() Accessor for the unitOfMeasure attribute
int	hashCode() Returns a hashcode for the component.
protected void	validate() Base case for validation.
static void	validateLengthMeasureType(String lengthType) Validates a length measure type against the allowed types.
static void	validateVerticalDatumType(String datumType) Validates a vertical datum type against the allowed types.

Methods inherited from class buri.ddmsence.AbstractBaseComponent

addDdms40Warning, addJson, addJson, addJson, addJson, addWarning, addWarnings, buildHTMLTextOutput, buildHTMLTextOutput, buildIndex, buildPrefix, getAttributeValue, getAttributeValue, getChild, getChildTextAsDouble, getDDMSVersion, getLocatorSuffix, getName, getNamespace, getNestedComponents, getPrefix, getQualifiedName, getSecurityAttributes, 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

VerticalExtent

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

VerticalExtent

public VerticalExtent(double minVerticalExtent,
                      double maxVerticalExtent,
                      String unitOfMeasure,
                      String datum)
               throws InvalidDDMSException

Constructor for creating a component from raw data

Parameters:

minVerticalExtent - the minimum

maxVerticalExtent - the maximum

unitOfMeasure - the unit of measure

datum - the datum

Throws:

InvalidDDMSException - if any required information is missing or malformed

Method Detail

validateVerticalDatumType

public static void validateVerticalDatumType(String datumType)
                                      throws InvalidDDMSException

Validates a vertical datum type against the allowed types.

Parameters:

datumType - the type to test

Throws:

InvalidDDMSException - if the value is null, empty or invalid.

validateLengthMeasureType

public static void validateLengthMeasureType(String lengthType)
                                      throws InvalidDDMSException

Validates a length measure type against the allowed types.

Parameters:

lengthType - the type to test

Throws:

InvalidDDMSException - if the value is null, empty or invalid.

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

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)

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

getUnitOfMeasure

public String getUnitOfMeasure()

Accessor for the unitOfMeasure attribute

getDatum

public String getDatum()

Accessor for the vertical datum attribute

getMinVerticalExtent

public Double getMinVerticalExtent()

Accessor for the minimum extent

getMaxVerticalExtent

public Double getMaxVerticalExtent()

Accessor for the maximum extent