GeographicIdentifier (DDMSence 2.6.0 API)

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.

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

History
Additional content rules apply to country codes starting in DDMS 5.0.

Nested Elements

Name

Cardinality

Availability

ddms:name

0..*

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

ddms:region

0..*

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

ddms:countryCode

0..1

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

ddms:subDivisionCode

0..1

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

ddms:facilityIdentifier

0..1

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

Attributes

Name

Cardinality

Availability

None.

Validation Rules

Rule

Type

Applicability

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

This component must contain at least 1 child element.

Error

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

If ddms:facilityIdentifier is used, no other child elements must be used.

Error

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

The codespace of ddms:countryCode must have the correct GENC format.

Error

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

The code of ddms:countryCode must be 3 uppercase alpha characters when the codespace requires a trigraph.

Error

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

The code of ddms:countryCode must be 2 uppercase alpha characters when the codespace requires a digraph.

Error

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

The code of ddms:countryCode must be 3 numerals when the codespace requires numbers.

Error

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

No lookup of GENC country codes is performed against the NGA registry.

Warning

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

See validateGencCountryCode(CountryCode) for additional information about country code validation.

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.

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

Field Summary
- Fields inherited from class buri.ddmsence.AbstractBaseComponent
  OUTPUT_TEMPLATES

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

All Methods Static Methods Instance Methods Concrete 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.
`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.
`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.
`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()` Base case for validation.
`protected static void`	`validateGencCountryCode(CountryCode countryCode)` Validates the syntax of the codespace/code value in a DDMS 5.0 (or later) country code.
`protected void`	`validateWarnings()` Base case for warnings.

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, getPrefix, getQualifiedName, getSecurityAttributes, getValidationWarnings, getXOMElement, getXOMElementCopy, requireAtLeastVersion, requireAtMostVersion, setXOMElement, toHTML, toJSON, toString, toText, toXML

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
    
    regions - the region names
    
    countryCode - the country code
    
    subDivisionCode - the subdivision code
    
    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
```
    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()
  - validateGencCountryCode
```
protected static void validateGencCountryCode(CountryCode countryCode)
                                       throws InvalidDDMSException
```
    Validates the syntax of the codespace/code value in a DDMS 5.0 (or later) country code.
    The codespace will fall into one of 4 flavours:
    - URL: http://api.nsgreg.nga.mil/geo-political/GENC/2/ed1
    - URN: urn:us:gov:dod:nga:def:geo-political:GENC:3:ed1
    - URNBased: geo-political:GENC:3:ed1
    - URNBasedShort: ge:GENC:3:ed1
    This method converts all codespaces into a URNBased version for comparison and then confirms that the code value is correct for the provided codespace.
    Parameters:
    
    countryCode - the country code to validate
    
    Throws:
    
    InvalidDDMSException - if any required information is missing or malformed
  - validateWarnings
```
protected void validateWarnings()
```
    Description copied from class: AbstractBaseComponent
    
    Base case for warnings. This method can be overridden for more in-depth validation. It is always assumed that the subcomponents of a component are already valid.
    
    Overrides:
    
    validateWarnings in class AbstractBaseComponent
    
    See Also:
    
    AbstractBaseComponent.validateWarnings()
  - 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)
  - 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.

Class GeographicIdentifier

Nested Class Summary

Field Summary

Fields inherited from class buri.ddmsence.AbstractBaseComponent

Constructor Summary

Method Summary

Methods inherited from class buri.ddmsence.AbstractBaseComponent

Methods inherited from class Object

Constructor Detail

GeographicIdentifier

GeographicIdentifier

GeographicIdentifier

Method Detail

validate

validateGencCountryCode

validateWarnings

getJSONObject

getHTMLTextOutput

getNestedComponents

equals

hashCode

getName

getNames

getRegions

getCountryCode

getSubDivisionCode

getFacilityIdentifier

hasFacilityIdentifier