Class DefaultGeographicDescription

Object

AbstractMetadata

ModifiableMetadata

ISOMetadata

AbstractGeographicExtent

DefaultGeographicDescription

All Implemented Interfaces:

Serializable, Emptiable, Lenient­Comparable, Identified­Object, Geographic­Description, Geographic­Extent

@TitleProperty(name="geographicIdentifier")
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:

EX_Geographic­Description └─geographic­Identifier…… The identifier used to represent a geographic area. └─code…………………………………… Alphanumeric value identifying an instance in the namespace.

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.

Examples

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

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class ModifiableMetadata

Modifiable­Metadata.State

Modifier and Type	Class	Description
static enum	Modifiable­Metadata.State	Whether the metadata is still editable or has been made final.

Field Summary

Fields inherited from class ISOMetadata

identifiers

Modifier and Type	Field	Description
protected Collection<Identifier>	identifiers	All identifiers associated with this metadata, or null if none.

Constructor Summary

Constructors

Constructor	Description
Default­Geographic­Description()	Constructs an initially empty geographic description.
Default­Geographic­Description(Citation authority, String code)	Creates an inclusive geographic description initialized to the given identifier.
Default­Geographic­Description(Geographic­Description object)	Constructs a new instance initialized with the values from the specified metadata object.
Default­Geographic­Description(Identifier value)	Constructs a geographic description initialized to the given identifier.

Method Summary

Modifier and Type	Method	Description
static Default­Geographic­Description	cast­Or­Copy(Geographic­Description object)	Returns a SIS metadata implementation with the values of the given arbitrary implementation.
Identifier	get­Geographic­Identifier()	Returns the identifier used to represent a geographic area.
void	set­Geographic­Identifier(Identifier new­Value)	Sets the identifier used to represent a geographic area.

Methods inherited from class AbstractGeographicExtent

cast­Or­Copy, get­Inclusion, set­Inclusion

Modifier and Type	Method	Description
static Abstract­Geographic­Extent	cast­Or­Copy(Geographic­Extent object)	Returns a SIS metadata implementation with the values of the given arbitrary implementation.
Boolean	get­Inclusion()	Indication of whether the bounding polygon encompasses an area covered by the data (inclusion) or an area where data is not present (exclusion).
void	set­Inclusion(Boolean new­Value)	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 ISOMetadata

get­Identifier, get­Identifier­Map, get­Identifiers, get­Standard, set­Identifier

Modifier and Type	Method	Description
protected Identifier	get­Identifier()	Returns the first identifier which is presumed to be defined by ISO 19115 conceptual model.
Identifier­Map	get­Identifier­Map()	A map view of the identifiers collection as (authority, code) entries.
Collection<Identifier>	get­Identifiers()	Returns all identifiers associated with this object (from conceptual model and from XML document).
Metadata­Standard	get­Standard()	Returns the metadata standard implemented by subclasses, which is ISO 19115.
protected void	set­Identifier(Identifier new­Value)	Sets the identifier for metadata objects that are expected to contain at most one ISO 19115 identifier.

Methods inherited from class ModifiableMetadata

check­Write­Permission, copy­Collection, copy­List, copy­Map, copy­Set, deep­Copy, merge, non­Null­Collection, non­Null­List, non­Null­Map, non­Null­Set, singleton, state, write­Collection, write­List, write­Map, write­Set

Modifier and Type	Method	Description
protected void	check­Write­Permission(Object current)	Checks if changes in the metadata are allowed.
protected static <E> Collection<E>	copy­Collection(Collection<? extends E> source, Class<E> element­Type)	Creates a list or set with the content of the source collection, or returns null if the source is null or empty.
protected static <E> List<E>	copy­List(Collection<? extends E> source, Class<E> element­Type)	Creates a list with the content of the source collection, or returns null if the source is null or empty.
protected static <K,V> Map<K,V>	copy­Map(Map<? extends K, ? extends V> source, Class<K> key­Type)	Creates a map with the content of the source map, or returns null if the source is null or empty.
protected static <E> Set<E>	copy­Set(Collection<? extends E> source, Class<E> element­Type)	Creates a set with the content of the source collection, or returns null if the source is null or empty.
Modifiable­Metadata	deep­Copy(Modifiable­Metadata.State target)	Copies (if necessary) this metadata and all its children.
void	merge(Object source)	Merges the data from the given source into this metadata.
protected final <E> Collection<E>	non­Null­Collection(Collection<E> current, Class<E> element­Type)	Returns the specified collection, or a new one if current is null.
protected final <E> List<E>	non­Null­List(List<E> current, Class<E> element­Type)	Returns the specified list, or a new one if current is null.
protected final <K,V> Map<K,V>	non­Null­Map(Map<K,V> current, Class<K> key­Type)	Returns the specified map, or a new one if current is null.
protected final <E> Set<E>	non­Null­Set(Set<E> current, Class<E> element­Type)	Returns the specified set, or a new one if current is null.
protected static <E> Collection<E>	singleton(E value, Class<E> element­Type)	Creates a singleton list or set containing only the given value, if non-null.
Modifiable­Metadata.State	state()	Tells whether this instance of metadata is editable.
protected final <E> Collection<E>	write­Collection(Collection<? extends E> source, Collection<E> target, Class<E> element­Type)	Writes the content of the source collection into the target list or set, creating it if needed.
protected final <E> List<E>	write­List(Collection<? extends E> source, List<E> target, Class<E> element­Type)	Writes the content of the source collection into the target list, creating it if needed.
protected final <K,V> Map<K,V>	write­Map(Map<? extends K, ? extends V> source, Map<K,V> target, Class<K> key­Type)	Writes the content of the source map into the target map, creating it if needed.
protected final <E> Set<E>	write­Set(Collection<? extends E> source, Set<E> target, Class<E> element­Type)	Writes the content of the source collection into the target set, creating it if needed.

Methods inherited from class AbstractMetadata

as­Map, as­Tree­Table, clone, equals, equals, get­Interface, get­Standard­Type, hash­Code, is­Empty, nil­Reasons, prune, to­String

Modifier and Type	Method	Description
Map<String,Object>	as­Map()	Returns a view of the property values in a Map.
Tree­Table	as­Tree­Table()	Returns the property types and values as a tree table.
protected Abstract­Metadata	clone()	Returns a shallow clone of this metadata.
final boolean	equals(Object object)	Performs a strict comparison of this metadata with the given object.
boolean	equals(Object object, Comparison­Mode mode)	Compares this metadata with the specified object for equality.
final Class<?>	get­Interface()	Deprecated, for removal: This API element is subject to removal in a future version. Renamed Abstract­Metadata.get­Standard­Type() for integration with Lenient­Comparable.
Type	get­Standard­Type()	Returns the metadata interface implemented by this class.
int	hash­Code()	Computes a hash code value for this metadata using Java reflection.
boolean	is­Empty()	Returns true if this metadata contains only null, nil or empty properties.
Map<String, Nil­Reason>	nil­Reasons()	Returns a view of the reasons why some properties are missing.
void	prune()	Removes all references to empty properties.
String	to­String()	Returns a string representation of this metadata.

Methods inherited from class Object

finalize, get­Class, notify, notify­All, wait, wait, wait

Constructor Details

DefaultGeographicDescription

public DefaultGeographicDescription()

Constructs an initially empty geographic description.

DefaultGeographicDescription

public DefaultGeographicDescription(Identifier value)

Constructs a geographic description initialized to the given identifier.

Parameters:

value - the new geographic identifier, or null if none.

Since:

1.5

See Also:

• set­Geographic­Identifier(Identifier)

DefaultGeographicDescription

public DefaultGeographicDescription(Citation authority,
 String code)

Creates an inclusive geographic description initialized to the given identifier. This constructor sets the inclusion property to true.

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 Default­Geographic­Description(Citations.EPSG, "1731") can stand for France – mainland north of 48.15°N.

Parameters:

authority - the authority of the identifier code, or null if none.

code - the identifier code used to represent a geographic area, or null if none.

DefaultGeographicDescription

public DefaultGeographicDescription(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, or null if none.

See Also:

• cast­Or­Copy(Geographic­Description)

Method Details

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 returns null.
• Otherwise if the given object is already an instance of Default­Geographic­Description, then it is returned unchanged.
• Otherwise a new Default­Geographic­Description 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, 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.

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:

get­Geographic­Identifier in interface Geographic­Description

Returns:

the identifier used to represent a geographic area, or null.

setGeographicIdentifier

public void setGeographicIdentifier(Identifier newValue)

Sets the identifier used to represent a geographic area.

Parameters:

new­Value - the new geographic identifier.