Package org.apache.sis.metadata.iso.extent

Class 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:

    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), Abstract­Reference­System​.get­Domain­Of­Validity(), Abstract­Datum​.get­Domain­Of­Validity(), Serialized Form

    Defined in the sis-metadata module

    • Constructor Detail

      • 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, 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:
        cast­Or­Copy(Extent)

    • Method Detail

      • 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, 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.

      • 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.

      • 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.

      • 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.

      • 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.