org.gedcomx.types
Enum IdentifierType

java.lang.Object
  java.lang.Enum<IdentifierType>
      org.gedcomx.types.IdentifierType

All Implemented Interfaces:

Serializable, Comparable<IdentifierType>

public enum IdentifierType
extends Enum<IdentifierType>

Enumeration of standard identifier types.

Author:

Ryan Heaton

Enum Constant Summary

Deprecated
An identifier that has been relegated, deprecated, or otherwise downgraded.

Evidence
An identifier for the evidence that supports the resource.

OTHER

Persistent
An identifier that is considered to be a long-term persistent identifier.

Primary
The primary identifier for the resource.

Method Summary

static IdentifierType	fromQNameURI(URI qname) Get the enumeration from the QName.
URI	toQNameURI() Return the QName value for this enum.
static IdentifierType	valueOf(String name) Returns the enum constant of this type with the specified name.
static IdentifierType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Primary

public static final IdentifierType Primary

The primary identifier for the resource.

Evidence

public static final IdentifierType Evidence

An identifier for the evidence that supports the resource. For example, when a conclusion about a person is extracted, analyzed and evaluated atomically within the context of a single source, it takes the form of a (extracted) person conclusion, and the extracted conclusion may supply an identifier for the person. As all evidence for the person is gathered, the (working) person conclusion identifies the evidence used to support the conclusion by including each evidence identifier in the list of identifiers for the person.

Deprecated

public static final IdentifierType Deprecated

An identifier that has been relegated, deprecated, or otherwise downgraded. This identifier is commonly used as the result of a merge when what was once a primary identifier for a person is no longer primary.

Persistent

public static final IdentifierType Persistent

An identifier that is considered to be a long-term persistent identifier. Applications that provide persistent identifiers are claiming that links to the resource using the identifier won't break.

OTHER

public static final IdentifierType OTHER

Method Detail

values

public static IdentifierType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (IdentifierType c : IdentifierType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static IdentifierType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

toQNameURI

public URI toQNameURI()

Return the QName value for this enum.

Returns:

The QName value for this enum.

fromQNameURI

public static IdentifierType fromQNameURI(URI qname)

Get the enumeration from the QName.

Parameters:

qname - The qname.

Returns:

The enumeration.