buri.ddmsence.ddms.summary.tspi

Class USPSPostalDeliveryRoute

Object

buri.ddmsence.AbstractBaseComponent

buri.ddmsence.AbstractTspiAddress

buri.ddmsence.ddms.summary.tspi.USPSPostalDeliveryRoute

All Implemented Interfaces:

IDDMSComponent, ITspiAddress

public final class USPSPostalDeliveryRoute
extends AbstractTspiAddress

An immutable implementation of tspi:USPSPostalDeliveryRoute.

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

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 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 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	USPSPostalDeliveryRoute.Builder Builder for this DDMS component.

Field Summary

Fields inherited from class buri.ddmsence.AbstractTspiAddress

ADD_ACTION, DELETE_ACTION, NO_NAMESPACE, NO_PREFIX

Fields inherited from class buri.ddmsence.AbstractBaseComponent

OUTPUT_TEMPLATES

Constructor Summary

Constructors

Constructor and Description
USPSPostalDeliveryRoute(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.
static String	getName(DDMSVersion version) Builder for the element name of this component, based on the version of DDMS used
protected void	validate() Base case for validation.

Methods inherited from class buri.ddmsence.AbstractTspiAddress

getAction, getHTMLTextOutput, getJSONObject, hashCode

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

Constructor Detail

USPSPostalDeliveryRoute

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

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 AbstractTspiAddress

Throws:

InvalidDDMSException

See Also:

AbstractBaseComponent.validate()

getName

public static String getName(DDMSVersion version)

Builder for the element name of this component, based on the version of DDMS used

Parameters:

version - the DDMSVersion

Returns:

an element name

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 AbstractTspiAddress

See Also:

Object.equals(Object)