Class DefaultTemporalExtent
java.lang.Object
org.apache.sis.metadata.AbstractMetadata
org.apache.sis.metadata.ModifiableMetadata
org.apache.sis.metadata.iso.ISOMetadata
org.apache.sis.metadata.iso.extent.DefaultTemporalExtent
- All Implemented Interfaces:
Serializable
,Emptiable
,LenientComparable
,IdentifiedObject
,org.opengis.metadata.extent.TemporalExtent
- Direct Known Subclasses:
DefaultSpatialTemporalExtent
public class DefaultTemporalExtent
extends ISOMetadata
implements org.opengis.metadata.extent.TemporalExtent
Time period covered by the content of the dataset.
The following property is mandatory in a well-formed metadata according ISO 19115:
In addition to the standard properties, SIS provides the following methods:
EX_TemporalExtent
└─extent…………………
The date and time for the content of the dataset.getStartTime()
for fetching the start time from the temporal primitive.getEndTime()
for fetching the end time from the temporal primitive.setBounds(Date, Date)
for setting the extent from the given start and end time.setBounds(Envelope)
for setting the extent from the given envelope.
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
- Version:
- 1.0
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.sis.metadata.ModifiableMetadata
ModifiableMetadata.State
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate org.opengis.temporal.TemporalPrimitive
The date and time for the content of the dataset.private static final long
Serial number for inter-operability with different versions.Fields inherited from class org.apache.sis.metadata.iso.ISOMetadata
identifiers
-
Constructor Summary
ConstructorsConstructorDescriptionConstructs an initially empty temporal extent.DefaultTemporalExtent
(org.opengis.metadata.extent.TemporalExtent object) Constructs a new instance initialized with the values from the specified metadata object. -
Method Summary
Modifier and TypeMethodDescriptionstatic DefaultTemporalExtent
castOrCopy
(org.opengis.metadata.extent.TemporalExtent object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.Returns the end date and time for the content of the dataset.org.opengis.temporal.TemporalPrimitive
Returns the date and time for the content of the dataset.The start date and time for the content of the dataset.(package private) static Date
getTime
(org.opengis.temporal.TemporalPrimitive extent, boolean begin) Infers a value from the extent as aDate
object.void
intersect
(org.opengis.metadata.extent.TemporalExtent other) Sets this temporal extent to the intersection of this extent with the specified one.void
Sets the temporal extent to the specified values.void
setBounds
(org.opengis.geometry.Envelope envelope) Sets this temporal extent to values inferred from the specified envelope.void
setExtent
(org.opengis.temporal.TemporalPrimitive newValue) Sets the date and time for the content of the dataset.Methods inherited from class org.apache.sis.metadata.iso.ISOMetadata
getIdentifier, getIdentifierMap, getIdentifiers, getStandard, setIdentifier, transitionTo
Methods inherited from class org.apache.sis.metadata.ModifiableMetadata
checkWritePermission, collectionType, copyCollection, copyList, copyMap, copySet, deepCopy, nonNullCollection, nonNullList, nonNullMap, nonNullSet, singleton, state, writeCollection, writeList, writeMap, writeSet
Methods inherited from class org.apache.sis.metadata.AbstractMetadata
asMap, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, prune, toString
-
Field Details
-
serialVersionUID
private static final long serialVersionUIDSerial number for inter-operability with different versions.- See Also:
-
extent
private org.opengis.temporal.TemporalPrimitive extentThe date and time for the content of the dataset.
-
-
Constructor Details
-
DefaultTemporalExtent
public DefaultTemporalExtent()Constructs an initially empty temporal extent. -
DefaultTemporalExtent
public DefaultTemporalExtent(org.opengis.metadata.extent.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, ornull
if none.- See Also:
-
-
Method Details
-
castOrCopy
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 returnsnull
. - Otherwise if the given object is an instance of
SpatialTemporalExtent
, then this method delegates to thecastOrCopy(…)
method of the corresponding SIS subclass. - Otherwise if the given object is already an instance of
DefaultTemporalExtent
, then it is returned unchanged. - Otherwise a new
DefaultTemporalExtent
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, ornull
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.
- If the given object is
-
getExtent
public org.opengis.temporal.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:
getExtent
in interfaceorg.opengis.metadata.extent.TemporalExtent
- Returns:
- the date and time for the content, or
null
.
-
setExtent
public void setExtent(org.opengis.temporal.TemporalPrimitive newValue) Sets the date and time for the content of the dataset.- Parameters:
newValue
- the new content date.
-
getTime
Infers a value from the extent as aDate
object.- Parameters:
begin
-true
if we are asking for the start time, orfalse
for the end time.- Returns:
- the requested time as a Java date, or
null
if none.
-
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
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
Sets the temporal extent to the specified values. This convenience method creates a temporal primitive for the given dates, then invokessetExtent(TemporalPrimitive)
.- Parameters:
startTime
- the start date and time for the content of the dataset, ornull
if none.endTime
- the end date and time for the content of the dataset, ornull
if none.- Throws:
UnsupportedOperationException
-
setBounds
public void setBounds(org.opengis.geometry.Envelope envelope) throws org.opengis.referencing.operation.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:
UnsupportedOperationException
- if the referencing module or the temporal module is not on the classpath.org.opengis.referencing.operation.TransformException
- if the envelope cannot be transformed to a temporal extent.- See Also:
-
intersect
public void intersect(org.opengis.metadata.extent.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:
UnsupportedOperationException
- if no implementation ofTemporalFactory
has been found on the classpath.- Since:
- 0.8
- See Also:
-