org.xbib.standardnumber

Class ARK

java.lang.Object

org.xbib.standardnumber.AbstractStandardNumber

org.xbib.standardnumber.ARK

All Implemented Interfaces:

Comparable<ARK>, StandardNumber

public class ARK
extends AbstractStandardNumber
implements Comparable<ARK>

ARK Archival Resource Key An ARK is a Uniform Resource Locator (URL) that is a multi-purpose identifier for information objects of any type. An ARK contains the label ark: after the hostname, an URL request terminated by '?' returns a brief metadata record, and an URL request terminated by '??' returns metadata that includes a commitment statement from the current service provider. The ARK and its inflections ('?' and '??') gain access to three facets of a provider's ability to provide persistence. Implicit in the design of the ARK scheme is that persistence is purely a matter of service and not a property of a naming syntax.

See Also:

ARK IETF RFC, 10 years ARK

Constructor Summary

Constructors

Constructor and Description
ARK()

Method Summary

Methods

Modifier and Type	Method and Description
URI	asURI()
int	compareTo(ARK ark)
ARK	createChecksum(boolean checksum) Indicate that a correct check sum should be computed.
String	format() Return a formatted value of this standard number This is best for human-readable representation, but is not necessarily a format for computation.
boolean	isValid() Check this number for validity.
ARK	normalize() Normalize the value by removing all unwanted characters or replacing characters with the ones required for verification.
String	normalizedValue() Return normalized value of this standard number.
ARK	reset()
ARK	set(CharSequence value) Set the input value of this standard number.
String	type() Return the type of this standard number
ARK	verify() No verification.

Methods inherited from class org.xbib.standardnumber.AbstractStandardNumber

getTypedVariants

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ARK

public ARK()

Method Detail

type

public String type()

Description copied from interface: StandardNumber

Return the type of this standard number

Specified by:

type in interface StandardNumber

Returns:

the type

compareTo

public int compareTo(ARK ark)

Specified by:

compareTo in interface Comparable<ARK>

set

public ARK set(CharSequence value)

Description copied from interface: StandardNumber

Set the input value of this standard number. The input must be normalized and verified before being accepted as valid.

Specified by:

set in interface StandardNumber

Parameters:

value - the raw input value

Returns:

this standard number

createChecksum

public ARK createChecksum(boolean checksum)

Description copied from interface: StandardNumber

Indicate that a correct check sum should be computed.

Specified by:

createChecksum in interface StandardNumber

Returns:

this standard number

normalize

public ARK normalize()

Description copied from interface: StandardNumber

Normalize the value by removing all unwanted characters or replacing characters with the ones required for verification.

Specified by:

normalize in interface StandardNumber

Returns:

this standard number

isValid

public boolean isValid()

Description copied from interface: StandardNumber

Check this number for validity.

Specified by:

isValid in interface StandardNumber

Returns:

true if valid, false otherwise

verify

public ARK verify()
           throws NumberFormatException

No verification.

Specified by:

verify in interface StandardNumber

Returns:

this ARK

Throws:

NumberFormatException

normalizedValue

public String normalizedValue()

Description copied from interface: StandardNumber

Return normalized value of this standard number. In most cases, this is also the canonical form of the standard number. This is a representation without unneccessary characters, useful for computation purposes, like comparing for equivalence.

Specified by:

normalizedValue in interface StandardNumber

Returns:

the normalized value

format

public String format()

Description copied from interface: StandardNumber

Return a formatted value of this standard number This is best for human-readable representation, but is not necessarily a format for computation.

Specified by:

format in interface StandardNumber

Returns:

a formatted value

asURI

public URI asURI()

reset

public ARK reset()

Specified by:

reset in interface StandardNumber