Class DefaultGeographicDescription
java.lang.Object
org.apache.sis.metadata.AbstractMetadata
org.apache.sis.metadata.ModifiableMetadata
org.apache.sis.metadata.iso.ISOMetadata
org.apache.sis.metadata.iso.extent.AbstractGeographicExtent
org.apache.sis.metadata.iso.extent.DefaultGeographicDescription
- All Implemented Interfaces:
Serializable
,Emptiable
,LenientComparable
,IdentifiedObject
,org.opengis.metadata.extent.GeographicDescription
,org.opengis.metadata.extent.GeographicExtent
public class DefaultGeographicDescription
extends AbstractGeographicExtent
implements org.opengis.metadata.extent.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 the
1731
code in the EPSG
codespace.
The natural language description for EPSG: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
- Version:
- 1.0
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.apache.sis.metadata.ModifiableMetadata
ModifiableMetadata.State
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate org.opengis.metadata.Identifier
The identifier used to represent a geographic area.private static final long
Serial number for inter-operability with different versions.Fields inherited from class org.apache.sis.metadata.iso.ISOMetadata
identifiers
-
Constructor Summary
ConstructorsConstructorDescriptionConstructs an initially empty geographic description.DefaultGeographicDescription
(CharSequence description) Creates an inclusive geographic description initialized to the given natural language description.DefaultGeographicDescription
(org.opengis.metadata.citation.Citation authority, String code) Creates an inclusive geographic description initialized to the given identifier.DefaultGeographicDescription
(org.opengis.metadata.extent.GeographicDescription object) Constructs a new instance initialized with the values from the specified metadata object. -
Method Summary
Modifier and TypeMethodDescriptionstatic DefaultGeographicDescription
castOrCopy
(org.opengis.metadata.extent.GeographicDescription object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.org.opengis.metadata.Identifier
Returns the identifier used to represent a geographic area.void
setGeographicIdentifier
(org.opengis.metadata.Identifier newValue) Sets the identifier used to represent a geographic area.Methods inherited from class org.apache.sis.metadata.iso.extent.AbstractGeographicExtent
castOrCopy, getInclusion, setInclusion
Methods inherited from class org.apache.sis.metadata.iso.ISOMetadata
getIdentifier, getIdentifierMap, getIdentifiers, getStandard, setIdentifier, transitionTo
Methods inherited from class org.apache.sis.metadata.ModifiableMetadata
checkWritePermission, collectionType, copyCollection, copyList, copyMap, copySet, deepCopy, nonNullCollection, nonNullList, nonNullMap, nonNullSet, singleton, state, writeCollection, writeList, writeMap, writeSet
Methods inherited from class org.apache.sis.metadata.AbstractMetadata
asMap, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, prune, toString
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.opengis.metadata.extent.GeographicExtent
getInclusion
-
Field Details
-
serialVersionUID
private static final long serialVersionUIDSerial number for inter-operability with different versions.- See Also:
-
geographicIdentifier
private org.opengis.metadata.Identifier geographicIdentifierThe identifier used to represent a geographic area.
-
-
Constructor Details
-
DefaultGeographicDescription
public DefaultGeographicDescription()Constructs an initially empty geographic description. -
DefaultGeographicDescription
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 thecode
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
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(org.opengis.metadata.extent.GeographicDescription 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, ornull
if none.- See Also:
-
-
Method Details
-
castOrCopy
public static DefaultGeographicDescription castOrCopy(org.opengis.metadata.extent.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, because 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 org.opengis.metadata.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 interfaceorg.opengis.metadata.extent.GeographicDescription
- Returns:
- the identifier used to represent a geographic area, or
null
.
- the
-
setGeographicIdentifier
public void setGeographicIdentifier(org.opengis.metadata.Identifier newValue) Sets the identifier used to represent a geographic area.- Parameters:
newValue
- the new geographic identifier.
-