buri.ddmsence.ddms.summary

Class PostalAddress

Object

buri.ddmsence.AbstractBaseComponent

buri.ddmsence.ddms.summary.PostalAddress

All Implemented Interfaces:

IDDMSComponent

public final class PostalAddress
extends AbstractBaseComponent

An immutable implementation of ddms:postalAddress.

Strictness
DDMSence allows the following legal, but nonsensical constructs: A postalAddress element can be used with no child elements.

Nested Elements
ddms:street: the street address (0-6 optional) ddms:city: the city (0-1 optional) ddms:state: the state (0-1 optional) ddms:province: the province (0-1 optional) ddms:postalCode: the postal code (0-1 optional) ddms:countryCode: the country code (0-1 optional), implemented as a CountryCode

Since:

0.9.b

Author:

Brian Uri!

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
PostalAddress(nu.xom.Element element) Constructor for creating a component from a XOM Element
PostalAddress(List<String> streets, String city, String stateOrProvince, String postalCode, CountryCode countryCode, boolean hasState) 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.
String	getCity() Accessor for the city
CountryCode	getCountryCode() Accessor for the country code
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.
String	getOutput(boolean isHTML, String prefix, String suffix) Renders this component as HTML or Text, with an optional prefix to nest it.
String	getPostalCode() Accessor for the postalCode
String	getProvince() Accessor for the province
String	getState() Accessor for the state
List<String>	getStreets() Accessor for the street addresses (max 6)
int	hashCode() Returns a hashcode for the component.
protected void	validate() Validates the component.
protected void	validateWarnings() Validates any conditions that might result in a warning.

Methods inherited from class buri.ddmsence.AbstractBaseComponent

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

Methods inherited from class Object

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

Constructor Detail

PostalAddress

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

PostalAddress

public PostalAddress(List<String> streets,
             String city,
             String stateOrProvince,
             String postalCode,
             CountryCode countryCode,
             boolean hasState)
              throws InvalidDDMSException

Constructor for creating a component from raw data

Parameters:

streets - the street address lines (0-6)

city - the city (optional)

stateOrProvince - the state or province (optional)

postalCode - the postal code (optional)

countryCode - the country code (optional)

hasState - true if the stateOrProvince is a state, false if it is a province (only 1 of state or province can exist in a postalAddress)

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. Either a state or a province can exist, but not both. 0-6 streets, 0-1 cities, 0-1 states, 0-1 provinces, 0-1 postal codes, and 0-1 country codes exist.

Overrides:

validate in class AbstractBaseComponent

Throws:

InvalidDDMSException - if any required information is missing or malformed

See Also:

AbstractBaseComponent.validate()

validateWarnings

protected void validateWarnings()

Validates any conditions that might result in a warning.

Rules
A completely empty ddms:postalAddress element was found.

Overrides:

validateWarnings in class AbstractBaseComponent

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

getStreets

public List<String> getStreets()

Accessor for the street addresses (max 6)

getCity

public String getCity()

Accessor for the city

getState

public String getState()

Accessor for the state

getProvince

public String getProvince()

Accessor for the province

getPostalCode

public String getPostalCode()

Accessor for the postalCode

getCountryCode

public CountryCode getCountryCode()

Accessor for the country code