buri.ddmsence

Class AbstractTspiAddress

Object

buri.ddmsence.AbstractBaseComponent

buri.ddmsence.AbstractTspiAddress

All Implemented Interfaces:

IDDMSComponent, ITspiAddress

Direct Known Subclasses:

GeneralAddressClass, IntersectionAddress, LandmarkAddress, NumberedThoroughfareAddress, TwoNumberAddressRange, UnnumberedThoroughfareAddress, USPSGeneralDeliveryOffice, USPSPostalDeliveryBox, USPSPostalDeliveryRoute

public abstract class AbstractTspiAddress
extends AbstractBaseComponent
implements ITspiAddress

Base class for TSPI addresses.

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 addresses, the DDMSence component will only return the raw XML of an address. The addressing 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 action 0..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 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, action attribute must be a valid token. Error In DDMS 2.0 3.0 3.1 4.0.1/4.1 5.0 No additional validation is done on the TSPI address at this time.

Since:

2.2.0

Author:

Brian Uri!

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field and Description
static String	ADD_ACTION The value for an add action.
static String	DELETE_ACTION The value for a delete action.
static String	NO_NAMESPACE The namespace of the action attribute
static String	NO_PREFIX The prefix of the action attribute

Fields inherited from class buri.ddmsence.AbstractBaseComponent

OUTPUT_TEMPLATES

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Test for logical equality.
String	getAction() Accessor for the action
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.
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, 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

Methods inherited from interface buri.ddmsence.ddms.IDDMSComponent

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

Field Detail

NO_PREFIX

public static final String NO_PREFIX

The prefix of the action attribute

See Also:

Constant Field Values

NO_NAMESPACE

public static final String NO_NAMESPACE

The namespace of the action attribute

See Also:

Constant Field Values

ADD_ACTION

public static final String ADD_ACTION

The value for an add action.

See Also:

Constant Field Values

DELETE_ACTION

public static final String DELETE_ACTION

The value for a delete action.

See Also:

Constant Field Values

Constructor Detail

AbstractTspiAddress

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

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 interface ITspiAddress

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

getAction

public String getAction()

Accessor for the action