BoundingGeometry (DDMSence 2.2.1 API)

Object
- buri.ddmsence.AbstractBaseComponent
- - buri.ddmsence.ddms.summary.BoundingGeometry

All Implemented Interfaces:: IDDMSComponent

public final class BoundingGeometry
extends AbstractBaseComponent

An immutable implementation of ddms:boundingGeometry.

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

History
The GML shapes were replaced by TSPI shapes in DDMS 5.0.

Nested Elements

Name

Cardinality

Availability

gml:Polygon

0..1

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

gml:Point

0..1

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

tspi:Polygon

0..1

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

tspi:Point

0..1

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

tspi:Envelope

0..1

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

tspi:Circle

0..1

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

tspi:Ellipse

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

At least 1 shape must exist.

Error

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

TSPI shapes must not be used before the DDMS version in which they were introduced.

Error

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

GML shapes are not used after the DDMS version in which they were removed.

Error

In DDMS

2.0

3.0

3.1

4.0.1/4.1

5.0

Since:: 0.9.b
Author:: Brian Uri!

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class BoundingGeometry.Builder
Builder for this DDMS component.

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

Constructor Summary

Constructors
Constructor and Description
`BoundingGeometry(nu.xom.Element element)` Constructor for creating a component from a XOM Element
`BoundingGeometry(List<ITspiShape> shapes)` Constructor for creating a component from raw data
`BoundingGeometry(List<Polygon> polygons, List<Point> points)` Constructor for creating a component from raw data, in earlier versions of DDMS.

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)` Test for logical equality.
`List<Point>`	`getGmlPoints()` Accessor for the GML points in this geometry.
`List<Polygon>`	`getGmlPolygons()` Accessor for the GML polygons in this geometry.
`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.
`List<ITspiShape>`	`getTspiShapes()` Accessor for the TSPI shapes in this geometry.
`protected void`	`validate()` Base case for validation.

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, getValidationWarnings, getXOMElement, getXOMElementCopy, hashCode, requireAtLeastVersion, requireAtMostVersion, setXOMElement, toHTML, toString, toText, toXML, validateWarnings

Methods inherited from class Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - BoundingGeometry
```
public BoundingGeometry(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
  - BoundingGeometry
```
public BoundingGeometry(List<Polygon> polygons,
                List<Point> points)
                 throws InvalidDDMSException
```
    Constructor for creating a component from raw data, in earlier versions of DDMS.
    
    Parameters:
    polygons - an ordered list of the GML polygons used in this geometry
    points - an ordered list of the GML points used in this geometry
    
    Throws:
    
    InvalidDDMSException - if any required information is missing or malformed
  - BoundingGeometry
```
public BoundingGeometry(List<ITspiShape> shapes)
                 throws InvalidDDMSException
```
    Constructor for creating a component from raw data
    
    Parameters:
    shapes - a list of TSPI shapes
    
    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()
  - 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)
  - 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
  - getGmlPolygons
```
public List<Polygon> getGmlPolygons()
```
    Accessor for the GML polygons in this geometry.
  - getGmlPoints
```
public List<Point> getGmlPoints()
```
    Accessor for the GML points in this geometry.
  - getTspiShapes
```
public List<ITspiShape> getTspiShapes()
```
    Accessor for the TSPI shapes in this geometry.

Class BoundingGeometry

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class buri.ddmsence.AbstractBaseComponent

Methods inherited from class Object

Constructor Detail

BoundingGeometry

BoundingGeometry

BoundingGeometry

Method Detail

validate

getOutput

getNestedComponents

equals

getName

getGmlPolygons

getGmlPoints

getTspiShapes