buri.ddmsence.ddms.summary.gml

Class SRSAttributes

Object

buri.ddmsence.AbstractAttributeGroup

buri.ddmsence.ddms.summary.gml.SRSAttributes

public final class SRSAttributes
extends AbstractAttributeGroup

Attribute group for the four SRS attributes used in the GML profile.

Because the GML-Profile defines these attributes locally inside of attribute groups, they are not in any namespace. Some older examples on the DDMS website inaccurately display the attributes with the gml: prefix.

When validating this attribute group, the required/optional nature of the srsName attribute is not checked. Because that limitation depends on the parent element (for example, gml:Point and gml:Polygon require an srsName, but gml:pos does not), the parent element should be responsible for checking.

Attributes

srsName: A URI-based name (optional on gml:pos, required everywhere else) srsDimension: A positive integer dimension (optional) axisLabels: Ordered list of labels for the axes, as a space-delimited list of NCNames (valid XML names without colons) (optional, but if no srsName is set, this should be omitted too) uomLabels: Ordered list of unit of measure (uom) labels for all the axes, as a space-delimited list of NCNames (valid XML names without colons) (required when axisLabels is set)

Since:

0.9.b

Author:

Brian Uri!

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SRSAttributes.Builder Builder for these attributes.

Field Summary

Fields

Modifier and Type	Field and Description
static String	NO_NAMESPACE The namespace of the shared attributes
static String	NO_PREFIX The prefix of the shared attributes

Constructor Summary

Constructors

Constructor and Description
SRSAttributes(nu.xom.Element element) Base constructor
SRSAttributes(String srsName, Integer srsDimension, List<String> axisLabels, List<String> uomLabels) Constructor which builds from raw data.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addTo(nu.xom.Element element) Convenience method to add these attributes onto an existing XOM Element
boolean	equals(Object obj)
List<String>	getAxisLabels() Accessor for the axisLabels.
String	getAxisLabelsAsXsList() Accessor for the String representation of the axisLabels
static SRSAttributes	getNonNullInstance(SRSAttributes srsAttributes) Returns a non-null instance of SRS attributes.
String	getOutput(boolean isHTML, String prefix) Outputs to HTML or Text with a prefix at the beginning of each meta tag or line.
Integer	getSrsDimension() Accessor for the srsDimension.
String	getSrsName() Accessor for the srsName.
List<String>	getUomLabels() Accessor for the uomLabels.
String	getUomLabelsAsXsList() Accessor for the String representation of the uomLabels
int	hashCode()
protected void	validate() Validates the attribute group.

Methods inherited from class buri.ddmsence.AbstractAttributeGroup

getDDMSVersion, getValidationWarnings, getWarnings, validateSameVersion

Methods inherited from class Object

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

Field Detail

NO_PREFIX

public static final String NO_PREFIX

The prefix of the shared attributes

See Also:

Constant Field Values

NO_NAMESPACE

public static final String NO_NAMESPACE

The namespace of the shared attributes

See Also:

Constant Field Values

Constructor Detail

SRSAttributes

public SRSAttributes(nu.xom.Element element)
              throws InvalidDDMSException

Base constructor

Parameters:

element - the XOM element which is decorated with these attributes.

Throws:

InvalidDDMSException

SRSAttributes

public SRSAttributes(String srsName,
             Integer srsDimension,
             List<String> axisLabels,
             List<String> uomLabels)
              throws InvalidDDMSException

Constructor which builds from raw data.

Parameters:

srsName - the srsName (required if the name is not "pos")

srsDimension - the srsDimension (optional)

axisLabels - the axis labels (optional, but should be omitted if no srsName is set)

uomLabels - the labels for UOM (required when axisLabels is set)

Throws:

InvalidDDMSException - if any required information is missing or malformed

Method Detail

getNonNullInstance

public static SRSAttributes getNonNullInstance(SRSAttributes srsAttributes)
                                        throws InvalidDDMSException

Returns a non-null instance of SRS attributes. If the instance passed in is not null, it will be returned.

Parameters:

srsAttributes - the attributes to return by default

Returns:

a non-null attributes instance

Throws:

InvalidDDMSException - if there are problems creating the empty attributes instance

addTo

protected void addTo(nu.xom.Element element)
              throws InvalidDDMSException

Convenience method to add these attributes onto an existing XOM Element

Parameters:

element - the element to decorate

Throws:

InvalidDDMSException - if the DDMS version of the element is different

validate

protected void validate()
                 throws InvalidDDMSException

Validates the attribute group.

Rules
If the srsName is set, it must be a valid URI. If the srsDimension is set, it must be positive. If the srsName is not set, the axisLabels must be not set or empty. If the axisLabels are not set or empty, the uomLabels must be not set or empty. Each axisLabel must be a NCName. Each uomLabel must be a NCName.

Overrides:

validate in class AbstractAttributeGroup

Throws:

InvalidDDMSException - if any required information is missing or malformed

getOutput

public String getOutput(boolean isHTML,
               String prefix)

Description copied from class: AbstractAttributeGroup

Outputs to HTML or Text with a prefix at the beginning of each meta tag or line.

Specified by:

getOutput in class AbstractAttributeGroup

Parameters:

isHTML - true for HTML, false for Text

prefix - the prefix to add

Returns:

the HTML or Text output

See Also:

AbstractAttributeGroup.getOutput(boolean, String)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

See Also:

Object.equals(Object)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

See Also:

Object.hashCode()

getSrsName

public String getSrsName()

Accessor for the srsName.

getSrsDimension

public Integer getSrsDimension()

Accessor for the srsDimension. May return null if not set.

getAxisLabels

public List<String> getAxisLabels()

Accessor for the axisLabels. Will return an empty list if not set.

getAxisLabelsAsXsList

public String getAxisLabelsAsXsList()

Accessor for the String representation of the axisLabels

getUomLabels

public List<String> getUomLabels()

Accessor for the uomLabels. Will return an empty list if not set.

getUomLabelsAsXsList

public String getUomLabelsAsXsList()

Accessor for the String representation of the uomLabels