buri.ddmsence.ddms.summary

Class GeographicIdentifier

Object

buri.ddmsence.AbstractBaseComponent

buri.ddmsence.ddms.summary.GeographicIdentifier

All Implemented Interfaces:

IDDMSComponent

public final class GeographicIdentifier
extends AbstractBaseComponent

An immutable implementation of ddms:geographicIdentifier.

Strictness

DDMSence is stricter than the specification in the following ways: No more than 1 countryCode, subDivisionCode, or facilityIdentifier can be used. The schema seems to support this assertion with explicit restrictions on those elements, but the enclosing xs:choice element allows multiples. At least 1 of name, region, countryCode, subDivisionCode, or facilityIdentifier must be present. Once again, the xs:choice restrictions create a loophole which could allow a completely empty geographicIdentifier to be valid.

Nested Elements
ddms:name: geographic name (0-many optional) ddms:region: geographic region (0-many optional) ddms:countryCode: the country code (0-1 optional), implemented as a CountryCode ddms:subDivisionCode: the subdivision code (0-1 optional, starting in DDMS 4.0.1), implemented as a SubDivisionCode ddms:facilityIdentifier: the facility identifier (0-1 optional), implemented as a FacilityIdentifier

Since:

0.9.b

Author:

Brian Uri!

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
GeographicIdentifier(nu.xom.Element element) Constructor for creating a component from a XOM Element
GeographicIdentifier(FacilityIdentifier facilityIdentifier) Constructor for creating a component from raw data
GeographicIdentifier(List<String> names, List<String> regions, CountryCode countryCode, SubDivisionCode subDivisionCode) 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.
CountryCode	getCountryCode() Accessor for the country code.
FacilityIdentifier	getFacilityIdentifier() Accessor for the facility identifier.
static String	getName(DDMSVersion version) Accessor for the element name of this component, based on the version of DDMS used
List<String>	getNames() Accessor for the names
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.
List<String>	getRegions() Accessor for the regions
SubDivisionCode	getSubDivisionCode() Accessor for the subdivision code.
boolean	hasFacilityIdentifier() Accessor for whether this geographic identifier is using a facility identifier.
int	hashCode() Returns a hashcode for the component.
protected void	validate() Validates the component.

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, validateWarnings

Methods inherited from class Object

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

Constructor Detail

GeographicIdentifier

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

GeographicIdentifier

public GeographicIdentifier(List<String> names,
                    List<String> regions,
                    CountryCode countryCode,
                    SubDivisionCode subDivisionCode)
                     throws InvalidDDMSException

Constructor for creating a component from raw data. Note that the facilityIdentifier component cannot be used with the components in this constructor.

Parameters:

names - the names (optional)

regions - the region names (optional)

countryCode - the country code (optional)

subDivisionCode - the subdivision code (optional, starting in DDMS 4.0.1)

Throws:

InvalidDDMSException - if any required information is missing or malformed

GeographicIdentifier

public GeographicIdentifier(FacilityIdentifier facilityIdentifier)
                     throws InvalidDDMSException

Constructor for creating a component from raw data

Parameters:

facilityIdentifier - the facility identifier (required in this constructor)

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. At least 1 of name, region, countryCode, subDivisionCode or facilityIdentifier must exist. No more than 1 countryCode, subDivisionCode or facilityIdentifier can exist. If facilityIdentifier is used, no other components can exist.

Overrides:

validate in class AbstractBaseComponent

Throws:

InvalidDDMSException - if any required information is missing or malformed

See Also:

AbstractBaseComponent.validate()

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

getNames

public List<String> getNames()

Accessor for the names

getRegions

public List<String> getRegions()

Accessor for the regions

getCountryCode

public CountryCode getCountryCode()

Accessor for the country code. May return null if no code was used.

getSubDivisionCode

public SubDivisionCode getSubDivisionCode()

Accessor for the subdivision code. May return null if no code was used.

getFacilityIdentifier

public FacilityIdentifier getFacilityIdentifier()

Accessor for the facility identifier. May return null if no identifier was used.

hasFacilityIdentifier

public boolean hasFacilityIdentifier()

Accessor for whether this geographic identifier is using a facility identifier.