Class DefaultTemporalExtent

All Implemented Interfaces:
Serializable, Emptiable, Lenient­Comparable, Identified­Object, Temporal­Extent
Direct Known Subclasses:
Default­Spatial­Temporal­Extent

public class DefaultTemporalExtent extends ISOMetadata implements TemporalExtent
Time period covered by the content of the dataset. The following property is mandatory in a well-formed metadata according ISO 19115:
EX_Temporal­Extent   └─extent………………… The date and time for the content of the dataset.
In addition to the standard properties, SIS provides the following methods:

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:

Defined in the sis-metadata module

  • Constructor Details

    • DefaultTemporalExtent

      public DefaultTemporalExtent()
      Constructs an initially empty temporal extent.
    • DefaultTemporalExtent

      public DefaultTemporalExtent(TemporalExtent object)
      Constructs a new instance initialized with the values from the specified metadata object. This is a shallow copy constructor, since 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 DefaultTemporalExtent castOrCopy(TemporalExtent 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 an instance of Spatial­Temporal­Extent, then this method delegates to the cast­Or­Copy(…) method of the corresponding SIS subclass.
      • Otherwise if the given object is already an instance of Default­Temporal­Extent, then it is returned unchanged.
      • Otherwise a new Default­Temporal­Extent instance is created using the copy constructor and returned. Note that this is a shallow copy operation, since 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.
    • getExtent

      public TemporalPrimitive getExtent()
      Returns the date and time for the content of the dataset. If no extent has been explicitly set, then this method will build an extent from the start time and end time if any.
      Specified by:
      get­Extent in interface Temporal­Extent
      Returns:
      the date and time for the content, or null.
    • setExtent

      public void setExtent(TemporalPrimitive newValue)
      Sets the date and time for the content of the dataset.
      Parameters:
      new­Value - the new content date.
    • getStartTime

      public Date getStartTime()
      The start date and time for the content of the dataset. This method tries to infer it from the extent.
      Returns:
      the start time, or null if none.
    • getEndTime

      public Date getEndTime()
      Returns the end date and time for the content of the dataset. This method tries to infer it from the extent.
      Returns:
      the end time, or null if none.
    • setBounds

      public void setBounds(Date startTime, Date endTime) throws UnsupportedOperationException
      Sets the temporal extent to the specified values. This convenience method creates a temporal primitive for the given dates, then invokes set­Extent(Temporal­Primitive).

      Note: this method is available only if the sis-temporal module is available on the classpath, or any other module providing an implementation of the Temporal­Factory interface.

      Parameters:
      start­Time - the start date and time for the content of the dataset, or null if none.
      end­Time - the end date and time for the content of the dataset, or null if none.
      Throws:
      Unsupported­Operation­Exception - if no implementation of Temporal­Factory has been found on the classpath.
    • setBounds

      public void setBounds(Envelope envelope) throws TransformException
      Sets this temporal extent to values inferred from the specified envelope. The given envelope must have a CRS, and at least one dimension of that CRS shall be assignable to a property of this extent.

      Note: this method is available only if the sis-referencing module is available on the classpath.

      Parameters:
      envelope - the envelope to use for setting this temporal extent.
      Throws:
      Unsupported­Operation­Exception - if the referencing module or the temporal module is not on the classpath.
      Transform­Exception - if the envelope can not be transformed to a temporal extent.
      See Also:
    • intersect

      public void intersect(TemporalExtent other)
      Sets this temporal extent to the intersection of this extent with the specified one. If there is no intersection between the two extents, then this method sets the temporal primitive to nil. If either this extent or the specified extent has nil primitive, then the intersection result will also be nil.
      Parameters:
      other - the temporal extent to intersect with this extent.
      Throws:
      Unsupported­Operation­Exception - if no implementation of Temporal­Factory has been found on the classpath.
      Since:
      0.8
      See Also: