org.geotoolkit.metadata.iso.extent
Class AbstractGeographicExtent

Object
  AbstractMetadata
      ModifiableMetadata
          MetadataEntity
              AbstractGeographicExtent

All Implemented Interfaces:

Serializable, Cloneable, LenientComparable, IdentifiedObject, GeographicExtent

Direct Known Subclasses:

DefaultBoundingPolygon, DefaultGeographicBoundingBox, DefaultGeographicDescription

@ThreadSafe
public class AbstractGeographicExtent
extends MetadataEntity
implements GeographicExtent

Base class for geographic area of the dataset.

Since:

2.1

Version:

3.19

Author:

Martin Desruisseaux (IRD, Geomatys), Touraïvane (IRD), Cédric Briançon (Geomatys)

See Also:

Serialized Form

Module:

metadata/geotk-metadata (download)

View source code for this class

Field Summary

Fields inherited from class MetadataEntity

identifiers

Fields inherited from class AbstractMetadata

LOGGER

Constructor Summary

AbstractGeographicExtent()
Constructs an initially empty geographic extent.

AbstractGeographicExtent(boolean inclusion)
Constructs a geographic extent initialized with the specified inclusion value.

AbstractGeographicExtent(GeographicExtent source)
Constructs a geographic extent initialized to the same values than the specified one.

Method Summary

static AbstractGeographicExtent	castOrCopy(GeographicExtent object) Returns a Geotk metadata implementation with the same values than the given arbitrary implementation.
Boolean	getInclusion() Indication of whether the bounding polygon encompasses an area covered by the data (inclusion) or an area where data is not present (exclusion).
void	setInclusion(Boolean newValue) Sets whether the bounding polygon encompasses an area covered by the data (inclusion) or an area where data is not present (exclusion).

Methods inherited from class MetadataEntity

getIdentifier, getIdentifierMap, getIdentifiers, getStandard

Methods inherited from class ModifiableMetadata

checkWritePermission, clone, collectionType, copyCollection, copyList, copySet, freeze, isModifiable, nonNullCollection, nonNullList, nonNullSet, prune, unmodifiable

Methods inherited from class AbstractMetadata

asMap, asTree, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, parse, toString

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AbstractGeographicExtent

public AbstractGeographicExtent()

Constructs an initially empty geographic extent.

AbstractGeographicExtent

public AbstractGeographicExtent(GeographicExtent source)

Constructs a geographic extent initialized to the same values than the specified one.

Parameters:

source - The metadata to copy, or null if none.

Since:

2.2

AbstractGeographicExtent

public AbstractGeographicExtent(boolean inclusion)

Constructs a geographic extent initialized with the specified inclusion value.

Parameters:

inclusion - Whether the bounding polygon encompasses an area covered by the data.

Method Detail

castOrCopy

public static AbstractGeographicExtent castOrCopy(GeographicExtent object)

Returns a Geotk metadata implementation with the same values than the given arbitrary implementation. If the given object is null, then this method returns null. Otherwise if the given object is already a Geotk implementation, then the given object is returned unchanged. Otherwise a new Geotk implementation is created and initialized to the attribute values of the given object, using a shallow copy operation (i.e. attributes are not cloned).

This method checks for the BoundingPolygon, GeographicBoundingBox and GeographicDescription sub-interfaces. If one of those interfaces is found, then this method delegates to the corresponding castOrCopy static method. If the given object implements more than one of the above-cited interfaces, then the castOrCopy method to be used is unspecified.

Parameters:

object - The object to get as a Geotk implementation, or null if none.

Returns:

A Geotk implementation containing the values of the given object (may be the given object itself), or null if the argument was null.

Since:

3.18

getInclusion

public Boolean getInclusion()

Indication of whether the bounding polygon encompasses an area covered by the data (inclusion) or an area where data is not present (exclusion).

Specified by:

getInclusion in interface GeographicExtent

Returns:

true for inclusion, or false for exclusion.

setInclusion

public void setInclusion(Boolean newValue)

Sets whether the bounding polygon encompasses an area covered by the data (inclusion) or an area where data is not present (exclusion).

Parameters:

newValue - true if the bounding polygon encompasses an area covered by the data.