Module org.apache.sis.metadata
Package org.apache.sis.metadata.iso.extent

Class DefaultSpatialTemporalExtent

Object
AbstractMetadata
ModifiableMetadata
ISOMetadata
DefaultTemporalExtent
DefaultSpatialTemporalExtent
All Implemented Interfaces:
Serializable, Emptiable, Lenient­Comparable, Identified­Object, Spatial­Temporal­Extent, Temporal­Extent
public class DefaultSpatialTemporalExtent extends DefaultTemporalExtent implements SpatialTemporalExtent
Extent with respect to date/time and spatial boundaries. The following properties are mandatory in a well-formed metadata according ISO 19115:
EX_Spatial­Temporal­Extent   ├─extent…………………………………… The date and time for the content of the dataset.   └─spatial­Extent………………… The spatial extent component of composite spatial and temporal extent.

Limitations

  • Instances of this class are not synchronized for multi-threading. Synchronization, if needed, is caller's responsibility.
  • Serialized objects of this class are not guaranteed to be compatible with future Apache SIS releases. Serialization support is appropriate for short term storage or RMI between applications running the same version of Apache SIS. For long term storage, use XML instead.
Since:
0.3
See Also:

  • Constructor Details

    • DefaultSpatialTemporalExtent

      public DefaultSpatialTemporalExtent()
      Constructs an initially empty spatial-temporal extent.

    • DefaultSpatialTemporalExtent

      public DefaultSpatialTemporalExtent(GeographicExtent spatialExtent, VerticalExtent verticalExtent, TemporalExtent extent)
      Constructs a new spatial-temporal extent initialized to the specified values.
      Parameters:
      spatial­Extent - the spatial extent component of composite spatial and temporal extent.
      vertical­Extent - the vertical extent component, or null if none.
      extent - the date and time for the content of the dataset, or null if unspecified.
      Since:
      0.5

    • DefaultSpatialTemporalExtent

      public DefaultSpatialTemporalExtent(SpatialTemporalExtent object)
      Constructs a new instance initialized with the values from the specified metadata object. This is a shallow copy constructor, because the other metadata contained in the given object are not recursively copied.
      Parameters:
      object - the metadata to copy values from, or null if none.
      See Also:

  • Method Details

    • castOrCopy

      public static DefaultSpatialTemporalExtent castOrCopy(SpatialTemporalExtent object)
      Returns a SIS metadata implementation with the values of the given arbitrary implementation. This method performs the first applicable action in the following choices:
      • If the given object is null, then this method returns null.
      • Otherwise if the given object is already an instance of Default­Spatial­Temporal­Extent, then it is returned unchanged.
      • Otherwise a new Default­Spatial­Temporal­Extent instance is created using the copy constructor and returned. Note that this is a shallow copy operation, because the other metadata contained in the given object are not recursively copied.
      Parameters:
      object - the object to get as a SIS implementation, or null if none.
      Returns:
      a SIS implementation containing the values of the given object (may be the given object itself), or null if the argument was null.

    • getSpatialExtent

      public Collection<GeographicExtent> getSpatialExtent()
      Returns the spatial extent component of composite spatial and temporal extent.
      Specified by:
      get­Spatial­Extent in interface Spatial­Temporal­Extent
      Returns:
      the list of geographic extents (never null).

    • setSpatialExtent

      public void setSpatialExtent(Collection<? extends GeographicExtent> newValues)
      Sets the spatial extent component of composite spatial and temporal extent.
      Parameters:
      new­Values - the new spatial extent.

    • getVerticalExtent

      @UML(identifier="verticalExtent", obligation=OPTIONAL, specification=ISO_19115) public VerticalExtent getVerticalExtent()
      Returns the vertical extent component.
      Returns:
      vertical extent component, or null if none.
      Since:
      0.5

    • setVerticalExtent

      public void setVerticalExtent(VerticalExtent newValue)
      Sets the vertical extent component.
      Parameters:
      new­Value - the new vertical extent component.
      Since:
      0.5

    • setBounds

      public void setBounds(Envelope envelope) throws TransformException
      Sets this spatiotemporal extent to values inferred from the specified envelope. The given envelope shall have at least a spatial, vertical or temporal component.

      The spatial component is handled as below:

      • If the given envelope has an horizontal component, then:
      • All extraneous geographic extents are removed. Non-geographic extents (e.g. descriptions and polygons) are left unchanged.

      Other dimensions are handled in a more straightforward way:

      • The vertical extent is set to the vertical component of the given envelope, or null if none.
      • The temporal extent is set to the temporal component of the given envelope, or null if none.
      Note: This method is available only if the org​.apache​.sis​.referencing module is available on the module path.
      Overrides:
      set­Bounds in class Default­Temporal­Extent
      Parameters:
      envelope - the envelope to use for setting this spatiotemporal extent.
      Throws:
      Unsupported­Operation­Exception - if the referencing module is not on the module path.
      Transform­Exception - if the envelope cannot be transformed to a temporal extent.
      See Also: