SRSAttributes (DDMSence 2.6.0 API)

Object
- buri.ddmsence.AbstractAttributeGroup
- - buri.ddmsence.ddms.summary.gml.SRSAttributes

public final class SRSAttributes
extends AbstractAttributeGroup

Attribute group for the four SRS attributes used on GML and TSPI-based shapes.

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

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.

History
The GML profile was removed in favour of TSPI in DDMS 5.0. However, these SRS attributes continue to appear on TSPI shapes.

Nested Elements

Name

Cardinality

Availability

None.

Attributes

Name

Cardinality

Availability

srsName

0..1

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

srsDimension

0..1

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

axisLabels

0..*

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

uomLabels

0..*

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

Validation Rules

Rule

Type

Applicability

If set, srsName must be a valid URI.

Error

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

If set, srsDimension must be positive.

Error

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

If srsName is not set, axisLabels must not be set.

Error

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

If axisLabels is not set, uomLabels must not be set.

Error

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

If set, each axisLabels value must be a NCName.

Error

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

If set, each uomLabel value must be a NCName.

Error

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

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.

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.

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
- Fields inherited from class buri.ddmsence.AbstractAttributeGroup
  INCOMPATIBLE_VERSION_MESSAGE

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

All Methods Static Methods Instance Methods Concrete 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
`String`	`getHTMLTextOutput(OutputFormat format, String prefix)` Outputs to HTML or Text with a prefix at the beginning of each meta tag or line.
`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.
`String`	`getName()` Returns a name that describes this attribute group.
`static SRSAttributes`	`getNonNullInstance(SRSAttributes srsAttributes)` Returns a non-null instance of SRS attributes.
`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()`
`boolean`	`isEmpty()` Checks if any attributes have been set.
`protected void`	`validate(DDMSVersion version)` Base validation case for attribute groups.

Methods inherited from class buri.ddmsence.AbstractAttributeGroup
addJson, addJson, getNamespace, getValidationWarnings, getWarnings, setNamespace

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
    
    srsDimension - the srsDimension
    
    axisLabels - the axis labels
    
    uomLabels - the labels for UOM
    
    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(DDMSVersion version)
                 throws InvalidDDMSException
```
    Description copied from class: AbstractAttributeGroup
    
    Base validation case for attribute groups.
    
    Overrides:
    
    validate in class AbstractAttributeGroup
    
    Parameters:
    
    version - the DDMS version to validate against. This cannot be stored in the attribute group because some DDMSVersions have the same attribute XML namespace (e.g. XLink, ISM, NTK, GML after DDMS 2.0).
    
    Throws:
    
    InvalidDDMSException - if any required information is missing or malformed
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from class: AbstractAttributeGroup
    
    Checks if any attributes have been set.
    
    Specified by:
    
    isEmpty in class AbstractAttributeGroup
    
    Returns:
    
    true if no attributes have values, false otherwise
    
    See Also:
    
    AbstractAttributeGroup.isEmpty()
  - getJSONObject
```
public com.google.gson.JsonObject getJSONObject()
```
    Description copied from class: AbstractAttributeGroup
    
    Renders this component as a JSON object, which can either be converted to a JSON string or inserted into the parent JSON object.
    I consider this to be an internal method, that unfortunately must be marked as public to allow cross-package access when generating output. Use toJSON() as the formal, public method to generate output.
    
    Specified by:
    
    getJSONObject in class AbstractAttributeGroup
    
    See Also:
    
    AbstractAttributeGroup.getJSONObject()
  - getName
```
public String getName()
```
    Description copied from class: AbstractAttributeGroup
    
    Returns a name that describes this attribute group. The format of the name is the class name with a lower-case first letter. This method is used in JSON output.
    
    Specified by:
    
    getName in class AbstractAttributeGroup
    
    See Also:
    
    AbstractAttributeGroup.getName()
  - getHTMLTextOutput
```
public String getHTMLTextOutput(OutputFormat format,
                                String prefix)
```
    Description copied from class: AbstractAttributeGroup
    
    Outputs to HTML or Text with a prefix at the beginning of each meta tag or line.
    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 AbstractAttributeGroup
    
    Parameters:
    
    format - the desired format of this output
    
    prefix - the prefix to add
    
    Returns:
    
    the output
    
    See Also:
    
    AbstractAttributeGroup.getHTMLTextOutput(OutputFormat, 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

Class SRSAttributes

Nested Class Summary

Field Summary

Fields inherited from class buri.ddmsence.AbstractAttributeGroup

Constructor Summary

Method Summary

Methods inherited from class buri.ddmsence.AbstractAttributeGroup

Methods inherited from class Object

Field Detail

NO_PREFIX

NO_NAMESPACE

Constructor Detail

SRSAttributes

SRSAttributes

Method Detail

getNonNullInstance

addTo

validate

isEmpty

getJSONObject

getName

getHTMLTextOutput

equals

hashCode

getSrsName

getSrsDimension

getAxisLabels

getAxisLabelsAsXsList

getUomLabels

getUomLabelsAsXsList