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:

• get­Beginning() for fetching the start time from the temporal primitive.
• get­Ending() for fetching the end time from the temporal primitive.
• set­Bounds(Temporal, Temporal) for setting the extent from the given start and end time.
• set­Bounds(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

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class ModifiableMetadata

Modifiable­Metadata.State

Modifier and Type	Class	Description
static enum	Modifiable­Metadata.State	Whether the metadata is still editable or has been made final.

Field Summary

Fields inherited from class ISOMetadata

identifiers

Modifier and Type	Field	Description
protected Collection<Identifier>	identifiers	All identifiers associated with this metadata, or null if none.

Constructor Summary

Constructors

Constructor	Description
Default­Temporal­Extent()	Constructs an initially empty temporal extent.
Default­Temporal­Extent(Temporal beginning, Temporal ending)	Constructs a new instance initialized with the specified values.
Default­Temporal­Extent(Temporal­Extent object)	Constructs a new instance initialized with the values from the specified metadata object.

Method Summary

Modifier and Type	Method	Description
static Default­Temporal­Extent	cast­Or­Copy(Temporal­Extent object)	Returns a SIS metadata implementation with the values of the given arbitrary implementation.
Optional<Temporal>	get­Beginning()	Returns the start of the temporal range for the content of the dataset.
Optional<Temporal>	get­Ending()	Returns the end of the temporal range for the content of the dataset.
Temporal­Primitive	get­Extent()	Returns the date and time for the content of the dataset.
void	intersect(Temporal­Extent other)	Sets this temporal extent to the intersection of this extent with the specified one.
void	set­Bounds(Temporal beginning, Temporal ending)	Sets the temporal extent to the specified values.
void	set­Bounds(Envelope envelope)	Sets this temporal extent to values inferred from the specified envelope.
void	set­Extent(Temporal­Primitive new­Value)	Sets the date and time for the content of the dataset.

Methods inherited from class ISOMetadata

get­Identifier, get­Identifier­Map, get­Identifiers, get­Standard, set­Identifier

Modifier and Type	Method	Description
protected Identifier	get­Identifier()	Returns the first identifier which is presumed to be defined by ISO 19115 conceptual model.
Identifier­Map	get­Identifier­Map()	A map view of the identifiers collection as (authority, code) entries.
Collection<Identifier>	get­Identifiers()	Returns all identifiers associated with this object (from conceptual model and from XML document).
Metadata­Standard	get­Standard()	Returns the metadata standard implemented by subclasses, which is ISO 19115.
protected void	set­Identifier(Identifier new­Value)	Sets the identifier for metadata objects that are expected to contain at most one ISO 19115 identifier.

Methods inherited from class ModifiableMetadata

check­Write­Permission, copy­Collection, copy­List, copy­Map, copy­Set, deep­Copy, merge, non­Null­Collection, non­Null­List, non­Null­Map, non­Null­Set, singleton, state, write­Collection, write­List, write­Map, write­Set

Modifier and Type	Method	Description
protected void	check­Write­Permission(Object current)	Checks if changes in the metadata are allowed.
protected static <E> Collection<E>	copy­Collection(Collection<? extends E> source, Class<E> element­Type)	Creates a list or set with the content of the source collection, or returns null if the source is null or empty.
protected static <E> List<E>	copy­List(Collection<? extends E> source, Class<E> element­Type)	Creates a list with the content of the source collection, or returns null if the source is null or empty.
protected static <K,V> Map<K,V>	copy­Map(Map<? extends K, ? extends V> source, Class<K> key­Type)	Creates a map with the content of the source map, or returns null if the source is null or empty.
protected static <E> Set<E>	copy­Set(Collection<? extends E> source, Class<E> element­Type)	Creates a set with the content of the source collection, or returns null if the source is null or empty.
Modifiable­Metadata	deep­Copy(Modifiable­Metadata.State target)	Copies (if necessary) this metadata and all its children.
void	merge(Object source)	Merges the data from the given source into this metadata.
protected final <E> Collection<E>	non­Null­Collection(Collection<E> current, Class<E> element­Type)	Returns the specified collection, or a new one if current is null.
protected final <E> List<E>	non­Null­List(List<E> current, Class<E> element­Type)	Returns the specified list, or a new one if current is null.
protected final <K,V> Map<K,V>	non­Null­Map(Map<K,V> current, Class<K> key­Type)	Returns the specified map, or a new one if current is null.
protected final <E> Set<E>	non­Null­Set(Set<E> current, Class<E> element­Type)	Returns the specified set, or a new one if current is null.
protected static <E> Collection<E>	singleton(E value, Class<E> element­Type)	Creates a singleton list or set containing only the given value, if non-null.
Modifiable­Metadata.State	state()	Tells whether this instance of metadata is editable.
protected final <E> Collection<E>	write­Collection(Collection<? extends E> source, Collection<E> target, Class<E> element­Type)	Writes the content of the source collection into the target list or set, creating it if needed.
protected final <E> List<E>	write­List(Collection<? extends E> source, List<E> target, Class<E> element­Type)	Writes the content of the source collection into the target list, creating it if needed.
protected final <K,V> Map<K,V>	write­Map(Map<? extends K, ? extends V> source, Map<K,V> target, Class<K> key­Type)	Writes the content of the source map into the target map, creating it if needed.
protected final <E> Set<E>	write­Set(Collection<? extends E> source, Set<E> target, Class<E> element­Type)	Writes the content of the source collection into the target set, creating it if needed.

Methods inherited from class AbstractMetadata

as­Map, as­Tree­Table, clone, equals, equals, get­Interface, get­Standard­Type, hash­Code, is­Empty, nil­Reasons, prune, to­String

Modifier and Type	Method	Description
Map<String,Object>	as­Map()	Returns a view of the property values in a Map.
Tree­Table	as­Tree­Table()	Returns the property types and values as a tree table.
protected Abstract­Metadata	clone()	Returns a shallow clone of this metadata.
final boolean	equals(Object object)	Performs a strict comparison of this metadata with the given object.
boolean	equals(Object object, Comparison­Mode mode)	Compares this metadata with the specified object for equality.
final Class<?>	get­Interface()	Deprecated, for removal: This API element is subject to removal in a future version. Renamed Abstract­Metadata.get­Standard­Type() for integration with Lenient­Comparable.
Type	get­Standard­Type()	Returns the metadata interface implemented by this class.
int	hash­Code()	Computes a hash code value for this metadata using Java reflection.
boolean	is­Empty()	Returns true if this metadata contains only null, nil or empty properties.
Map<String, Nil­Reason>	nil­Reasons()	Returns a view of the reasons why some properties are missing.
void	prune()	Removes all references to empty properties.
String	to­String()	Returns a string representation of this metadata.

Methods inherited from class Object

finalize, get­Class, notify, notify­All, wait, wait, wait

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:

• set­Bounds(Temporal, Temporal)

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:

• cast­Or­Copy(Temporal­Extent)

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

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:

• Default­Extent.add­Elements(Envelope)
• Default­Geographic­Bounding­Box.set­Bounds(Envelope)
• Default­Vertical­Extent.set­Bounds(Envelope)

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:

• Extents.intersection(Temporal­Extent, Temporal­Extent)
• General­Envelope.intersect(Envelope)