Module org.opengis.geoapi

Package org.opengis.metadata

Interface Identifier

All Known Subinterfaces:

ReferenceIdentifier

@Classifier(DATATYPE)
@UML(identifier="MD_Identifier",
     specification=ISO_19115)
public interface Identifier

Value uniquely identifying an object within a namespace.

Example: for the WGS 84 geographic coordinate reference system, code = "4326", codeSpace = "EPSG", description = "WGS 84" and authority = OGP geodetic committee.

Since:

2.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AUTHORITY_KEY	Key for the "authority" property to be given to the CRS factory createFoo(Map, ...) methods.
static final String	CODE_KEY	Key for the "code" property to be given to the CRS factory createFoo(Map, ...) methods.
static final String	CODESPACE_KEY	Key for the "codespace" property to be given to the CRS factory createFoo(Map, ...) methods.
static final String	DESCRIPTION_KEY	Key for the "description" property to be given to the CRS factory createFoo(Map, ...) methods.
static final String	VERSION_KEY	Key for the "version" property to be given to the CRS factory createFoo(Map, ...) methods.

Method Summary

Modifier and Type	Method	Description
default Citation	getAuthority()	Person or party responsible for maintenance of the namespace.
String	getCode()	Alphanumeric value identifying an instance in the namespace.
default String	getCodeSpace()	Identifier or namespace in which the code is valid.
default InternationalString	getDescription()	Natural language description of the meaning of the code value.
default String	getVersion()	Version identifier for the namespace, as specified by the code authority.

Field Details

AUTHORITY_KEY

static final String AUTHORITY_KEY

Key for the "authority" property to be given to the CRS factory createFoo(Map, ...) methods. It can be used as an alternative to IdentifiedObject.NAME_KEY for setting the value to be returned by getAuthority().

See Also:

• ObjectFactory
• getAuthority()
• Constant Field Values

CODE_KEY

static final String CODE_KEY

Key for the "code" property to be given to the CRS factory createFoo(Map, ...) methods. It can be used as an alternative to IdentifiedObject.NAME_KEY for setting the value to be returned by getCode().

See Also:

• ObjectFactory
• getCode()
• Constant Field Values

CODESPACE_KEY

static final String CODESPACE_KEY

Key for the "codespace" property to be given to the CRS factory createFoo(Map, ...) methods. It can be used as an alternative to IdentifiedObject.NAME_KEY for setting the value to be returned by getCodeSpace().

See Also:

• ObjectFactory
• getCodeSpace()
• Constant Field Values

VERSION_KEY

static final String VERSION_KEY

Key for the "version" property to be given to the CRS factory createFoo(Map, ...) methods. It can be used as an alternative to IdentifiedObject.NAME_KEY for setting the value to be returned by getVersion().

See Also:

• ObjectFactory
• getVersion()
• Constant Field Values

DESCRIPTION_KEY

static final String DESCRIPTION_KEY

Key for the "description" property to be given to the CRS factory createFoo(Map, ...) methods. It can be used as an alternative to IdentifiedObject.NAME_KEY for setting the value to be returned by getDescription().

Since:

3.1

See Also:

• ObjectFactory
• getDescription()
• Constant Field Values

Method Details

getAuthority

@UML(identifier="authority",
     obligation=OPTIONAL,
     specification=ISO_19115)
default Citation getAuthority()

Person or party responsible for maintenance of the namespace.

Returns:

the person or party responsible for maintenance of the namespace, or null if none.

getCode

@UML(identifier="code",
     obligation=MANDATORY,
     specification=ISO_19115)
String getCode()

Alphanumeric value identifying an instance in the namespace. Should avoid characters that are not legal in URLs.

Example: "4326".

Returns:

value identifying an instance in the namespace.

getCodeSpace

@UML(identifier="codeSpace",
     obligation=OPTIONAL,
     specification=ISO_19115)
default String getCodeSpace()

Identifier or namespace in which the code is valid.

Example: "EPSG".

Returns:

the identifier or namespace in which the code is valid, or null if none.

Since:

3.1

getVersion

@UML(identifier="version",
     obligation=OPTIONAL,
     specification=ISO_19115)
default String getVersion()

Version identifier for the namespace, as specified by the code authority. When appropriate, the edition is identified by the effective date, coded using ISO 8601 date format.

Example: the version of the underlying EPSG database.

Returns:

the version identifier for the namespace, or null if none.

Since:

3.1

getDescription

@UML(identifier="description",
     obligation=OPTIONAL,
     specification=ISO_19115)
default InternationalString getDescription()

Natural language description of the meaning of the code value.

Example: for codeSpace = "EPSG" and code = "4326", the description can be "WGS 84".

Returns:

the natural language description, or null if none.

Since:

3.1