Package com.luciad.ogc.ows.model

Class TLcdOWSBoundingBox

java.lang.Object
com.luciad.datamodel.TLcdDataObject
com.luciad.ogc.ows.model.TLcdOWSBoundingBox
All Implemented Interfaces:
ILcdDataObject, ILcdBounded, ILcdCloneable, ILcdDeepCloneable, Cloneable
Direct Known Subclasses:
TLcdOWSWGS84BoundingBox
public class TLcdOWSBoundingBox extends TLcdDataObject implements ILcdBounded
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.

  • Field Details

    • CRS_PROPERTY

      public static final TLcdDataProperty CRS_PROPERTY
      Data property that maps to the crs attribute. The possible values for this property are instances of String.

    • DIMENSIONS_PROPERTY

      public static final TLcdDataProperty DIMENSIONS_PROPERTY
      Data property that maps to the dimensions attribute. The possible values for this property are instances of Integer.

    • LOWER_CORNER_PROPERTY

      public static final TLcdDataProperty LOWER_CORNER_PROPERTY
      Data property that maps to the LowerCorner element. The possible values for this property are instances of TLcdOWSPosition.

    • UPPER_CORNER_PROPERTY

      public static final TLcdDataProperty UPPER_CORNER_PROPERTY
      Data property that maps to the UpperCorner element. The possible values for this property are instances of TLcdOWSPosition.

  • Constructor Details

    • TLcdOWSBoundingBox

      public TLcdOWSBoundingBox()
      Constructs a new undefined TLcdOWSBoundingBox. To define these bounds, set the crs, lower corner and upper corner values

    • TLcdOWSBoundingBox

      public TLcdOWSBoundingBox(TLcdDataType aType)
      Constructs a new undefined TLcdOWSBoundingBox, with a custom data type To define these bounds, set the crs, lower corner and upper corner values
      Parameters:
      aType - The datatype to use

    • TLcdOWSBoundingBox

      public TLcdOWSBoundingBox(String aCrs, TLcdOWSPosition aLowerCorner, TLcdOWSPosition aUpperCorner)
      Convenience constructor that sets the crs, lower corner and upper corner when constructing a TLcdOWSBoundingBox.
      Parameters:
      aCrs - The crs to set
      aLowerCorner - The lower corner to set
      aUpperCorner - The upper corner to set

  • Method Details

    • setValue

      public void setValue(TLcdDataProperty aProperty, Object aValue)
      Description copied from interface: ILcdDataObject

      Sets the value of the given property for this data object. The implementation is allowed to throw an exception if the given value can't be set.

      The given property must be declared in the data object's type or in one of its super types. In other words, getDataType().getProperties().contains( aProperty ) should always be true. Otherwise, the implementation should throw an IllegalArgumentException.

      Specified by:
      setValue in interface ILcdDataObject
      Overrides:
      setValue in class TLcdDataObject
      Parameters:
      aProperty - the property for which the value is to be set
      aValue - the value to set
      See Also:

    • setCrs

      public void setCrs(String aValue)
      Sets the value of the property that maps to the crs attribute.

      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:
      aValue - the value to set for the CRS_PROPERTY property.

    • setDimensions

      public void setDimensions(Integer aValue)
      Sets the value of the property that maps to the dimensions attribute.

      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:
      aValue - the value to set for the DIMENSIONS_PROPERTY property.

    • setValue

      public void setValue(String aPropertyName, Object aValue)
      Description copied from interface: ILcdDataObject

      Convenience method that sets the value of the property with the given name.

      If more than one property exists with the given name, the most specific property should be used (this is the property defined by the most specialized type in this object's data type hierarchy).

      See ILcdDataObject.setValue(TLcdDataProperty, Object) for more information.

      Specified by:
      setValue in interface ILcdDataObject
      Overrides:
      setValue in class TLcdDataObject
      Parameters:
      aPropertyName - the name of the property of which the value is to be set
      aValue - the value to set

    • setLowerCorner

      public void setLowerCorner(TLcdOWSPosition aValue)
      Sets the value of the property that maps to the LowerCorner element.

      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:
      aValue - the value to set for the LOWER_CORNER_PROPERTY property.

    • setUpperCorner

      public void setUpperCorner(TLcdOWSPosition aValue)
      Sets the value of the property that maps to the UpperCorner element.

      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:
      aValue - the value to set for the UPPER_CORNER_PROPERTY property.

    • getBounds

      public ILcdBounds getBounds()
      Description copied from interface: ILcdBounded
      Returns the ILcdBounds by which the geometry of this ILcdBounded object is bounded.

      If the geometry does not allow retrieving valid bounds (for example a polyline with 0 points) the return value is unspecified. It is highly recommended to return an undefined bounds. You can create undefined bounds using the default constructors of TLcdLonLatBounds or TLcdXYBounds.

      Specified by:
      getBounds in interface ILcdBounded
      Returns:
      the ILcdBounds by which the geometry of this ILcdBounded object is bounded.

    • getCrs

      public String getCrs()
      Returns the value of the property that maps to the crs attribute.

      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:
      the value of the CRS_PROPERTY property.

    • getDimensions

      public Integer getDimensions()
      Returns the value of the property that maps to the dimensions attribute.

      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:
      the value of the DIMENSIONS_PROPERTY property.

    • getLowerCorner

      public TLcdOWSPosition getLowerCorner()
      Returns the value of the property that maps to the LowerCorner element.

      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:
      the value of the LOWER_CORNER_PROPERTY property.

    • getUpperCorner

      public TLcdOWSPosition getUpperCorner()
      Returns the value of the property that maps to the UpperCorner element.

      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:
      the value of the UPPER_CORNER_PROPERTY property.