Class DefaultGeographicDescription
- Object
-
- AbstractMetadata
-
- ModifiableMetadata
-
- ISOMetadata
-
- AbstractGeographicExtent
-
- DefaultGeographicDescription
-
- All Implemented Interfaces:
Serializable
,Emptiable
,LenientComparable
,IdentifiedObject
,GeographicDescription
,GeographicExtent
public class DefaultGeographicDescription extends AbstractGeographicExtent implements GeographicDescription
Description of the geographic area using identifiers. The following properties are mandatory in a well-formed metadata according ISO 19115:The area is given by a geographic identifier, which may be a code in the codespace of some authority (for example an EPSG code). In addition, the geographic identifier can optionally have a natural language description.EX_GeographicDescription
└─geographicIdentifier……
The identifier used to represent a geographic area.└─code……………………………………
Alphanumeric value identifying an instance in the namespace.Example: a geographic area may be identified by the1731
code in theEPSG
codespace. The natural language description forEPSG:1731
can be “France – mainland north of 48.15°N”.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
Defined in the
sis-metadata
module
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class ModifiableMetadata
ModifiableMetadata.State
-
-
Field Summary
-
Fields inherited from class ISOMetadata
identifiers
-
-
Constructor Summary
Constructors Constructor Description DefaultGeographicDescription()
Constructs an initially empty geographic description.DefaultGeographicDescription(CharSequence description)
Creates an inclusive geographic description initialized to the given natural language description.DefaultGeographicDescription(Citation authority, String code)
Creates an inclusive geographic description initialized to the given identifier.DefaultGeographicDescription(GeographicDescription object)
Constructs a new instance initialized with the values from the specified metadata object.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DefaultGeographicDescription
castOrCopy(GeographicDescription object)
Returns a SIS metadata implementation with the values of the given arbitrary implementation.Identifier
getGeographicIdentifier()
Returns the identifier used to represent a geographic area.void
setGeographicIdentifier(Identifier newValue)
Sets the identifier used to represent a geographic area.-
Methods inherited from class AbstractGeographicExtent
castOrCopy, getInclusion, setInclusion
-
Methods inherited from class ISOMetadata
getIdentifier, getIdentifierMap, getIdentifiers, getStandard, setIdentifier, transitionTo
-
Methods inherited from class ModifiableMetadata
checkWritePermission, checkWritePermission, collectionType, copyCollection, copyList, copyMap, copySet, freeze, isModifiable, nonNullCollection, nonNullList, nonNullMap, nonNullSet, singleton, state, unmodifiable, writeCollection, writeList, writeMap, writeSet
-
Methods inherited from class AbstractMetadata
asMap, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, prune, toString
-
Methods inherited from class Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface GeographicExtent
getInclusion
-
-
-
-
Constructor Detail
-
DefaultGeographicDescription
public DefaultGeographicDescription()
Constructs an initially empty geographic description.
-
DefaultGeographicDescription
public DefaultGeographicDescription(Citation authority, String code)
Creates an inclusive geographic description initialized to the given identifier. This constructor sets the inclusion property totrue
.Usage note: if the description is a sentence like “Netherlands offshore”, it may not be suitable for the
code
argument. Callers may consider using the identifier description as an alternative and keep the code for a more compact string (often a primary key).Example:new DefaultGeographicDescription(
can stand for “France – mainland north of 48.15°N”.Citations.EPSG
, "1731")- Parameters:
authority
- the authority of the identifier code, ornull
if none.code
- the identifier code used to represent a geographic area, ornull
if none.
-
DefaultGeographicDescription
public DefaultGeographicDescription(CharSequence description)
Creates an inclusive geographic description initialized to the given natural language description. This constructor sets the inclusion property totrue
and the identifier code to one of the following choices:- the given
description
string if it is a valid Unicode identifier, - otherwise an acronym
of the given
description
.
- Parameters:
description
- the natural language description of the meaning of the code value, ornull
if none.- Since:
- 0.6
- the given
-
DefaultGeographicDescription
public DefaultGeographicDescription(GeographicDescription 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, ornull
if none.- See Also:
castOrCopy(GeographicDescription)
-
-
Method Detail
-
castOrCopy
public static DefaultGeographicDescription castOrCopy(GeographicDescription 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 returnsnull
. - Otherwise if the given object is already an instance of
DefaultGeographicDescription
, then it is returned unchanged. - Otherwise a new
DefaultGeographicDescription
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, 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
-
getGeographicIdentifier
public Identifier getGeographicIdentifier()
Returns the identifier used to represent a geographic area.Example: an identifier with the following properties:- the
"EPSG"
code space, - the
"1731"
code, and - the “France – mainland north of 48.15°N” description.
- Specified by:
getGeographicIdentifier
in interfaceGeographicDescription
- Returns:
- the identifier used to represent a geographic area, or
null
.
- the
-
setGeographicIdentifier
public void setGeographicIdentifier(Identifier newValue)
Sets the identifier used to represent a geographic area.- Parameters:
newValue
- the new geographic identifier.
-
-