Interface IdentifierSpace<T>

Type Parameters:

T - the type of object used as identifier values.

All Superinterfaces:

Citation

public interface IdentifierSpace<T>
extends Citation

Some identifier namespaces that are handled in a special way. The identifier namespaces are usually defined as authorities in the Citations class. However, a few identifiers defined in the gco:Object­Identification XML attribute group are handled in a special way. For example, identifiers associated with the HREF space are marshalled in the outer property element, as in the example below:

<cit:CI_Citation>
  <cit:series xlink:href="http://myReference">
    <cit:CI_Series>
      <cit:name>...</cit:name>
    </cit:CI_Series>
  </cit:series>
</cit:CI_Citation>

The values defined in this interface can be used as keys in the map returned by Identified­Object.get­Identifier­Map().

Since:

0.3

See Also:

• Citations
• Identified­Object
• Identifier­Map

Field Summary

Fields

Modifier and Type	Field	Description
static final Identifier­Space<URI>	HREF	An optional attribute for URN to an external resources, or to another part of a XML document, or an identifier.
static final Identifier­Space<String>	ID	A standard GML attribute available on every object-with-identity.
static final Identifier­Space<UUID>	UUID	An optional attribute available on every object-with-identity provided in the GMD schemas that implement ISO 19115 in XML.
static final Identifier­Space<XLink>	XLINK	Any XML attributes defined by OGC in the xlink schema.

Method Summary

Modifier and Type	Method	Description
String	get­Name()	Returns the name of this identifier space.

Methods inherited from interface Citation

get­Alternate­Titles, get­Cited­Responsible­Parties, get­Collective­Title, get­Dates, get­Edition, get­Edition­Date, get­Identifiers, get­ISBN, get­ISSN, get­Other­Citation­Details, get­Presentation­Forms, get­Series, get­Title

Modifier and Type	Method	Description
Collection<? extends International­String>	get­Alternate­Titles()	Short name or other language name by which the cited information is known.
Collection<? extends Responsible­Party>	get­Cited­Responsible­Parties()	Name and position information for an individual or organization that is responsible for the resource.
International­String	get­Collective­Title()	Common title with holdings note.
Collection<? extends Citation­Date>	get­Dates()	Reference date for the cited resource.
International­String	get­Edition()	Version of the cited resource.
Date	get­Edition­Date()	Date of the edition, or null if none.
Collection<? extends Identifier>	get­Identifiers()	Unique identifier for the resource.
String	get­ISBN()	International Standard Book Number, or null if none.
String	get­ISSN()	International Standard Serial Number, or null if none.
International­String	get­Other­Citation­Details()	Other information required to complete the citation that is not recorded elsewhere.
Collection<Presentation­Form>	get­Presentation­Forms()	Mode in which the resource is represented, or an empty string if none.
Series	get­Series()	Information about the series, or aggregate dataset, of which the dataset is a part.
International­String	get­Title()	Name by which the cited resource is known.

Field Details

ID

static final IdentifierSpace<String> ID

A standard GML attribute available on every object-with-identity. Its type is "xs:ID" - i.e. it is a fragment identifier, unique within document scope only, for internal cross-references. It is not useful by itself as a persistent unique identifier.

The XML attribute name is "gml:id", but is also used for "gco:id" in metadata documents. However, the "gco:" prefix is omitted in XML documents (i.e. the gco:id attribute is unqualified).

Elements with gml:id or gco:id attribute can be referenced from other XML elements using the xlink:href attribute. This is done automatically by Apache SIS implementations at marshalling and unmarshalling time. If many of gml:id, gco:uuid and xlink:href attributes are used, then gml:id has precedence.

See Also:

• Xml­ID

UUID

static final IdentifierSpace<UUID> UUID

An optional attribute available on every object-with-identity provided in the GMD schemas that implement ISO 19115 in XML. May be used as a persistent unique identifier, but only available within GMD context.

The XML attribute name is "gco:uuid". However, the "gco:" prefix is omitted in XML documents (i.e. the gco:uuid attribute is unqualified).

Elements with gco:uuid attribute can be referenced from other XML elements using the gco:uuidref attribute. However, this is not done automatically by Apache SIS. Users need to manage their set of UUIDs in their own Reference­Resolver subclass.

See Also:

• UUID

HREF

static final IdentifierSpace<URI> HREF

An optional attribute for URN to an external resources, or to another part of a XML document, or an identifier. This is one of the many attributes available in the XLINK identifier space, but is provided as a special constant because href is the most frequently used xlink attribute.

The XML attribute name is "xlink:href".

See Also:

• XLink.get­HRef()

XLINK

static final IdentifierSpace<XLink> XLINK

Any XML attributes defined by OGC in the xlink schema. Note that the above HREF identifier space is a special case of this xlink identifier space.

See Also:

• XLink

Method Details

getName

String getName()

Returns the name of this identifier space.

• For the constants defined in this Identifier­Space interface, this is the XML attribute name with its prefix. Attribute names can be "gml:id", "gco:uuid" or "xlink:href".
• For the constants defined in the Citations class, this is the identifier namespace. They are usually not XML attribute name because those identifiers are marshalled as <MD_Identifier> XML elements rather than attributes.

Returns:

the name of this identifier space (may be XML attribute name).