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 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 XMLinstead.
- Since:
- 0.3
- See Also:
Defined in the sis-metadata module
- 
Nested Class SummaryNested classes/interfaces inherited from class ModifiableMetadataModifiableMetadata.State
- 
Field SummaryFields inherited from class ISOMetadataidentifiers
- 
Constructor SummaryConstructorsConstructorDescriptionConstructs 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.Constructs a new instance initialized with the values from the specified metadata object.
- 
Method SummaryModifier and TypeMethodDescriptioncastOrCopy(GeographicDescription object) Returns a SIS metadata implementation with the values of the given arbitrary implementation.Returns the identifier used to represent a geographic area.voidsetGeographicIdentifier(Identifier newValue) Sets the identifier used to represent a geographic area.Methods inherited from class AbstractGeographicExtentcastOrCopy, getInclusion, setInclusionMethods inherited from class ISOMetadatagetIdentifier, getIdentifierMap, getIdentifiers, getStandard, setIdentifier, transitionToMethods inherited from class ModifiableMetadatacheckWritePermission, collectionType, copyCollection, copyList, copyMap, copySet, deepCopy, nonNullCollection, nonNullList, nonNullMap, nonNullSet, singleton, state, writeCollection, writeList, writeMap, writeSetMethods inherited from class AbstractMetadataasMap, asTreeTable, equals, equals, getInterface, hashCode, isEmpty, prune, toStringMethods inherited from class Objectclone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface GeographicExtentgetInclusion
- 
Constructor Details- 
DefaultGeographicDescriptionpublic DefaultGeographicDescription()Constructs an initially empty geographic description.
- 
DefaultGeographicDescriptionCreates an inclusive geographic description initialized to the given identifier. This constructor sets the inclusion property totrue.Usage noteIf the description is a sentence like “Netherlands offshore”, it may not be suitable for thecodeargument. 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, or- nullif none.
- code- the identifier code used to represent a geographic area, or- nullif none.
 
- 
DefaultGeographicDescriptionCreates an inclusive geographic description initialized to the given natural language description. This constructor sets the inclusion property totrueand the identifier code to one of the following choices:- the given descriptionstring 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, or- nullif none.
- Since:
- 0.6
 
- the given 
- 
DefaultGeographicDescriptionConstructs 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- nullif none.
- See Also:
 
 
- 
- 
Method Details- 
castOrCopyReturns 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 DefaultGeographicDescriptioninstance 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- nullif none.
- Returns:
- a SIS implementation containing the values of the given object (may be the
         given object itself), or nullif the argument was null.
 
- If the given object is 
- 
getGeographicIdentifierReturns 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:
- getGeographicIdentifierin interface- GeographicDescription
- Returns:
- the identifier used to represent a geographic area, or null.
 
- the 
- 
setGeographicIdentifierSets the identifier used to represent a geographic area.- Parameters:
- newValue- the new geographic identifier.
 
 
-