BoundingBoxType (b3p-commons-gis 9.3 API)

java.lang.Object
- nl.b3p.xml.ows.v100.BoundingBoxType

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

BoundingBox, WGS84BoundingBoxType
```
public class BoundingBoxType
extends Object
implements Serializable
```
XML encoded minimum rectangular bounding box (or region) parameter, surrounding all the associated data. This type is adapted from the EnvelopeType of GML 3.1, with modified contents and documentation for encoding a MINIMUM size box SURROUNDING all associated data.

Version:

$Revision$ $Date$

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

BoundingBoxType()

Constructors
Constructor and Description
`BoundingBoxType()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`deleteDimensions()` Method deleteDimensions
`String`	`getCrs()` Returns the value of field 'crs'.
`int`	`getDimensions()` Returns the value of field 'dimensions'.
`String`	`getLowerCorner()` Returns the value of field 'lowerCorner'.
`String`	`getUpperCorner()` Returns the value of field 'upperCorner'.
`boolean`	`hasDimensions()` Method hasDimensions
`boolean`	`isValid()` Method isValid
`void`	`marshal(ContentHandler handler)` Method marshal
`void`	`marshal(Writer out)` Method marshal
`void`	`setCrs(String crs)` Sets the value of field 'crs'.
`void`	`setDimensions(int dimensions)` Sets the value of field 'dimensions'.
`void`	`setLowerCorner(String lowerCorner)` Sets the value of field 'lowerCorner'.
`void`	`setUpperCorner(String upperCorner)` Sets the value of field 'upperCorner'.
`static BoundingBoxType`	`unmarshal(Reader reader)` Method unmarshal
`void`	`validate()` Method validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - BoundingBoxType
```
public BoundingBoxType()
```
- Method Detail
  - deleteDimensions
```
public void deleteDimensions()
```
    Method deleteDimensions
  - getCrs
```
public String getCrs()
```
    Returns the value of field 'crs'. The field 'crs' has the following description: Usually references the definition of a CRS, as specified in [OGC Topic 2]. Such a CRS definition can be XML encoded using the gml:CoordinateReferenceSystemType in [GML 3.1]. For well known references, it is not required that a CRS definition exist at the location the URI points to. If no anyURI value is included, the applicable CRS must be either: a) Specified outside the bounding box, but inside a data structure that includes this bounding box, as specified for a specific OWS use of this bounding box type. b) Fixed and specified in the Implementation Specification for a specific OWS use of the bounding box type.
    
    Returns:
    
    String
  - getDimensions
```
public int getDimensions()
```
    Returns the value of field 'dimensions'. The field 'dimensions' has the following description: The number of dimensions in this CRS (the length of a coordinate sequence in this use of the PositionType). This number is specified by the CRS definition, but can also be specified here.
    
    Returns:
    
    int
  - getLowerCorner
```
public String getLowerCorner()
```
    Returns the value of field 'lowerCorner'. The field 'lowerCorner' has the following description: Position of the bounding box corner at which the value of each coordinate normally is the algebraic minimum within this bounding box. In some cases, this position is normally displayed at the top, such as the top left for some image coordinates. For more information, see Subclauses 10.2.5 and C.13.
    
    Returns:
    
    String
  - getUpperCorner
```
public String getUpperCorner()
```
    Returns the value of field 'upperCorner'. The field 'upperCorner' has the following description: Position of the bounding box corner at which the value of each coordinate normally is the algebraic maximum within this bounding box. In some cases, this position is normally displayed at the bottom, such as the bottom right for some image coordinates. For more information, see Subclauses 10.2.5 and C.13.
    
    Returns:
    
    String
  - hasDimensions
```
public boolean hasDimensions()
```
    Method hasDimensions
    
    Returns:
    
    boolean
  - isValid
```
public boolean isValid()
```
    Method isValid
    
    Returns:
    
    boolean
  - marshal
```
public void marshal(Writer out)
             throws org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException
```
    Method marshal
    
    Parameters:
    
    out -
    
    Throws:
    
    org.exolab.castor.xml.MarshalException
    
    org.exolab.castor.xml.ValidationException
  - marshal
```
public void marshal(ContentHandler handler)
             throws IOException,
                    org.exolab.castor.xml.MarshalException,
                    org.exolab.castor.xml.ValidationException
```
    Method marshal
    
    Parameters:
    
    handler -
    
    Throws:
    
    IOException
    
    org.exolab.castor.xml.MarshalException
    
    org.exolab.castor.xml.ValidationException
  - setCrs
```
public void setCrs(String crs)
```
    Sets the value of field 'crs'. The field 'crs' has the following description: Usually references the definition of a CRS, as specified in [OGC Topic 2]. Such a CRS definition can be XML encoded using the gml:CoordinateReferenceSystemType in [GML 3.1]. For well known references, it is not required that a CRS definition exist at the location the URI points to. If no anyURI value is included, the applicable CRS must be either: a) Specified outside the bounding box, but inside a data structure that includes this bounding box, as specified for a specific OWS use of this bounding box type. b) Fixed and specified in the Implementation Specification for a specific OWS use of the bounding box type.
    
    Parameters:
    
    crs - the value of field 'crs'.
  - setDimensions
```
public void setDimensions(int dimensions)
```
    Sets the value of field 'dimensions'. The field 'dimensions' has the following description: The number of dimensions in this CRS (the length of a coordinate sequence in this use of the PositionType). This number is specified by the CRS definition, but can also be specified here.
    
    Parameters:
    
    dimensions - the value of field 'dimensions'.
  - setLowerCorner
```
public void setLowerCorner(String lowerCorner)
```
    Sets the value of field 'lowerCorner'. The field 'lowerCorner' has the following description: Position of the bounding box corner at which the value of each coordinate normally is the algebraic minimum within this bounding box. In some cases, this position is normally displayed at the top, such as the top left for some image coordinates. For more information, see Subclauses 10.2.5 and C.13.
    
    Parameters:
    
    lowerCorner - the value of field 'lowerCorner'.
  - setUpperCorner
```
public void setUpperCorner(String upperCorner)
```
    Sets the value of field 'upperCorner'. The field 'upperCorner' has the following description: Position of the bounding box corner at which the value of each coordinate normally is the algebraic maximum within this bounding box. In some cases, this position is normally displayed at the bottom, such as the bottom right for some image coordinates. For more information, see Subclauses 10.2.5 and C.13.
    
    Parameters:
    
    upperCorner - the value of field 'upperCorner'.
  - unmarshal
```
public static BoundingBoxType unmarshal(Reader reader)
                                 throws org.exolab.castor.xml.MarshalException,
                                        org.exolab.castor.xml.ValidationException
```
    Method unmarshal
    
    Parameters:
    
    reader -
    
    Returns:
    
    BoundingBoxType
    
    Throws:
    
    org.exolab.castor.xml.MarshalException
    
    org.exolab.castor.xml.ValidationException
  - validate
```
public void validate()
              throws org.exolab.castor.xml.ValidationException
```
    Method validate
    
    Throws:
    
    org.exolab.castor.xml.ValidationException

Class BoundingBoxType

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

BoundingBoxType

Method Detail

deleteDimensions

getCrs

getDimensions

getLowerCorner

getUpperCorner

hasDimensions

isValid

marshal

marshal

setCrs

setDimensions

setLowerCorner

setUpperCorner

unmarshal

validate