Class DefaultTemporalExtent

Object
AbstractMetadata
ModifiableMetadata
ISOMetadata
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:

  • Constructor Details

    • DefaultTemporalExtent

      public DefaultTemporalExtent()
      Constructs an initially empty temporal extent.

    • DefaultTemporalExtent

      public DefaultTemporalExtent(Temporal beginning, Temporal ending)
      Constructs a new instance initialized with the specified values.
      Parameters:
      beginning - the start date and time for the content of the dataset, or null if none.
      ending - the end date and time for the content of the dataset, or null if none.
      Since:
      1.5
      See Also:

    • DefaultTemporalExtent

      public DefaultTemporalExtent(TemporalExtent 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 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, 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.

    • getExtent

      public TemporalPrimitive getExtent()
      Returns the date and time for the content of the dataset.
      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.

    • getBeginning

      public Optional<Temporal> getBeginning()
      Returns the start of the temporal range for the content of the dataset. This method tries to infer this value from the extent. The returned object is often an Instant, but not necessarily.
      Returns:
      the start of the temporal range.
      Since:
      1.5

    • getEnding

      public Optional<Temporal> getEnding()
      Returns the end of the temporal range for the content of the dataset. This method tries to infer this value from the extent. The returned object is often an Instant, but not necessarily.
      Returns:
      the end of the temporal range.
      Since:
      1.5

    • getStartTime

      @Deprecated(since="1.5", forRemoval=true) public Date getStartTime()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Replaced by get­Beginning() in order to transition to java​.time API.
      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

      @Deprecated(since="1.5", forRemoval=true) public Date getEndTime()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Replaced by get­Ending() in order to transition to java​.time API.
      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

      @Deprecated(since="1.5", forRemoval=true) public void setBounds(Date startTime, Date endTime)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Replaced by set­Bounds(Temporal, Temporal) in order to transition to java​.time API.
      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).
      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.

    • setBounds

      public void setBounds(Temporal beginning, Temporal ending)
      Sets the temporal extent to the specified values. This convenience method creates a temporal primitive for the given dates and/or times, then invokes set­Extent(Temporal­Primitive).
      Parameters:
      beginning - the start date and time for the content of the dataset, or null if none.
      ending - the end date and time for the content of the dataset, or null if none.
      Since:
      1.5

    • 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 org​.apache​.sis​.referencing module is available on the module path.

      Parameters:
      envelope - the envelope to use for setting this temporal 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:

    • 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.
      Since:
      0.8
      See Also: