Class DefaultExtent

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

DefaultExtent

All Implemented Interfaces:

Serializable, Emptiable, Lenient­Comparable, Identified­Object, Extent

@TitleProperty(name="description")
public class DefaultExtent
extends ISOMetadata
implements Extent

Information about spatial, vertical, and temporal extent. The following properties are mandatory or conditional (i.e. mandatory under some circumstances) in a well-formed metadata according ISO 19115:

EX_Extent ├─description…………………… The spatial and temporal extent for the referring object. ├─geographic­Element…… Geographic component of the extent of the referring object. ├─temporal­Element………… Temporal component of the extent of the referring object. │ └─extent……………………… The date and time for the content of the dataset. └─vertical­Element………… Vertical component of the extent of the referring object. ├─minimum­Value……… The lowest vertical extent contained in the dataset. ├─maximum­Value……… The highest vertical extent contained in the dataset. └─vertical­CRS………… Information about the vertical coordinate reference system.

This type has four conditional properties: geographic elements, temporal elements, vertical elements and description. At least one of the four shall be used.

In addition to the standard properties, SIS provides the following methods:

• add­Elements(Envelope) for adding extents inferred from the given envelope.
• Extents.get­Geographic­Bounding­Box(Extent) for extracting a global geographic bounding box.

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:

• Extents.get­Geographic­Bounding­Box(Extent)
• Default­Object­Domain.get­Domain­Of­Validity()
• 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­Extent()	Constructs an initially empty extent.
Default­Extent(Char­Sequence description, Geographic­Extent geographic­Elements, Vertical­Extent vertical­Elements, Temporal­Extent temporal­Elements)	Constructs an extent initialized to the given description or components.
Default­Extent(Extent object)	Constructs a new instance initialized with the values from the specified metadata object.

Method Summary

Modifier and Type	Method	Description
void	add­Elements(Envelope envelope)	Adds geographic, vertical or temporal extents inferred from the given envelope.
static Default­Extent	cast­Or­Copy(Extent object)	Returns a SIS metadata implementation with the values of the given arbitrary implementation.
International­String	get­Description()	Returns the spatial and temporal extent for the referring object.
Collection<Geographic­Extent>	get­Geographic­Elements()	Provides geographic component of the extent of the referring object
Collection<Temporal­Extent>	get­Temporal­Elements()	Provides temporal component of the extent of the referring object.
Collection<Vertical­Extent>	get­Vertical­Elements()	Provides vertical component of the extent of the referring object.
void	intersect(Extent other)	Sets this extent to the intersection of this extent with the specified one.
void	set­Description(International­String new­Value)	Sets the spatial and temporal extent for the referring object.
void	set­Geographic­Elements(Collection<? extends Geographic­Extent> new­Values)	Sets geographic component of the extent of the referring object.
void	set­Temporal­Elements(Collection<? extends Temporal­Extent> new­Values)	Sets temporal component of the extent of the referring object.
void	set­Vertical­Elements(Collection<? extends Vertical­Extent> new­Values)	Sets vertical component of the extent of the referring object.

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

DefaultExtent

public DefaultExtent()

Constructs an initially empty extent.

DefaultExtent

public DefaultExtent(CharSequence description,
 GeographicExtent geographicElements,
 VerticalExtent verticalElements,
 TemporalExtent temporalElements)

Constructs an extent initialized to the given description or components. Any argument given to this constructor can be null. While a valid Extent requires at least one component to be non-null, this constructor does not perform such verification.

Parameters:

description - a description, or null if none.

geographic­Elements - a geographic component, or null if none.

vertical­Elements - a vertical component, or null if none.

temporal­Elements - a temporal component, or null if none.

DefaultExtent

public DefaultExtent(Extent 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(Extent)

Method Details

castOrCopy

public static DefaultExtent castOrCopy(Extent 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­Extent, then it is returned unchanged.
• Otherwise a new Default­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.

getDescription

public InternationalString getDescription()

Returns the spatial and temporal extent for the referring object.

Specified by:

get­Description in interface Extent

Returns:

the spatial and temporal extent, or null in none.

setDescription

public void setDescription(InternationalString newValue)

Sets the spatial and temporal extent for the referring object.

Parameters:

new­Value - the new description.

getGeographicElements

public Collection<GeographicExtent> getGeographicElements()

Provides geographic component of the extent of the referring object

Specified by:

get­Geographic­Elements in interface Extent

Returns:

the geographic extent, or an empty set if none.

setGeographicElements

public void setGeographicElements(Collection<? extends GeographicExtent> newValues)

Sets geographic component of the extent of the referring object.

Parameters:

new­Values - the new geographic elements.

getVerticalElements

public Collection<VerticalExtent> getVerticalElements()

Provides vertical component of the extent of the referring object.

Specified by:

get­Vertical­Elements in interface Extent

Returns:

the vertical extent, or an empty set if none.

setVerticalElements

public void setVerticalElements(Collection<? extends VerticalExtent> newValues)

Sets vertical component of the extent of the referring object.

Parameters:

new­Values - the new vertical elements.

getTemporalElements

public Collection<TemporalExtent> getTemporalElements()

Provides temporal component of the extent of the referring object.

Specified by:

get­Temporal­Elements in interface Extent

Returns:

the temporal extent, or an empty set if none.

setTemporalElements

public void setTemporalElements(Collection<? extends TemporalExtent> newValues)

Sets temporal component of the extent of the referring object.

Parameters:

new­Values - the new temporal elements.

addElements

public void addElements(Envelope envelope)
                 throws TransformException

Adds geographic, vertical or temporal extents inferred from the given envelope. This method inspects the envelope CRS and creates a Geographic­Bounding­Box, Vertical­Extent or Temporal­Extent elements as needed.

Note: this method is available only if the referencing module is on the module path.

Parameters:

envelope - the envelope to use for inferring the additional extents.

Throws:

Unsupported­Operation­Exception - if the referencing module is not on the module path.

Transform­Exception - if a coordinate transformation was required and failed.

See Also:

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

intersect

public void intersect(Extent other)

Sets this extent to the intersection of this extent with the specified one. This method computes the intersections of all geographic, vertical and temporal elements in this extent with all geographic, vertical and temporal elements in the other extent, ignoring duplicated results.

Parameters:

other - the extent to intersect with this extent.

Throws:

Illegal­Argument­Exception - if two elements to intersect are not compatible (e.g. mismatched bounding box inclusion status or mismatched vertical datum).

Since:

0.8

See Also:

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