org.xbib.standardnumber

Class ARK

java.lang.Object

org.xbib.standardnumber.StandardNumber

org.xbib.standardnumber.ARK

All Implemented Interfaces:

java.lang.Cloneable, java.lang.Comparable<ARK>

public class ARK
extends StandardNumber
implements java.lang.Cloneable, java.lang.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 ARK IETF RFC, 10 years ARK

Field Summary

Fields inherited from class org.xbib.standardnumber.StandardNumber

type, value

Constructor Summary

Constructors

Constructor and Description
ARK()

Method Summary

Modifier and Type	Method and Description
java.net.URI	asURI()
java.lang.Object	clone() Returns a clone if the implementation is cloneable.
int	compareTo(ARK ark)
ARK	createChecksum(boolean checksum) Indicate that a correct check sum should be computed.
boolean	equals(java.lang.Object object)
java.lang.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.
static StandardNumber	getInstance(java.lang.Package thePackage, java.lang.ClassLoader classLoader, java.lang.String type)
static StandardNumber	getInstance(java.lang.String type)
java.util.Collection<java.lang.String>	getTypedVariants()
int	hashCode()
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.
java.lang.String	normalizedValue() Return normalized value of this standard number.
ARK	reset()
ARK	set(java.lang.CharSequence value) Set the input value of this standard number.
ARK	verify() No verification.

Methods inherited from class org.xbib.standardnumber.StandardNumber

type

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ARK

public ARK()

Method Detail

set

public ARK set(java.lang.CharSequence value)

Description copied from class: StandardNumber

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

Overrides:

set in class StandardNumber

Parameters:

value - the raw input value

Returns:

this standard number

createChecksum

public ARK createChecksum(boolean checksum)

Description copied from class: StandardNumber

Indicate that a correct check sum should be computed.

Specified by:

createChecksum in class StandardNumber

Parameters:

checksum - if checksum is included

Returns:

this standard number

normalize

public ARK normalize()

Description copied from class: StandardNumber

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

Specified by:

normalize in class StandardNumber

Returns:

this standard number

isValid

public boolean isValid()

Description copied from class: StandardNumber

Check this number for validity.

Specified by:

isValid in class StandardNumber

Returns:

true if valid, false otherwise

verify

public ARK verify()

No verification.

Specified by:

verify in class StandardNumber

Returns:

this ARK

normalizedValue

public java.lang.String normalizedValue()

Description copied from class: 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 class StandardNumber

Returns:

the normalized value

format

public java.lang.String format()

Description copied from class: 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 class StandardNumber

Returns:

a formatted value

asURI

public java.net.URI asURI()

reset

public ARK reset()

Specified by:

reset in class StandardNumber

getTypedVariants

public java.util.Collection<java.lang.String> getTypedVariants()

Specified by:

getTypedVariants in class StandardNumber

compareTo

public int compareTo(ARK ark)

Specified by:

compareTo in interface java.lang.Comparable<ARK>

equals

public boolean equals(java.lang.Object object)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Returns a clone if the implementation is cloneable.

Returns:

a clone if the implementation is cloneable.

Throws:

java.lang.CloneNotSupportedException - if this is called on an implementation that does not support `Cloneable`

getInstance

public static StandardNumber getInstance(java.lang.String type)
                                  throws NoSuchStandardNumberException

Throws:

NoSuchStandardNumberException

getInstance

public static StandardNumber getInstance(java.lang.Package thePackage,
                                         java.lang.ClassLoader classLoader,
                                         java.lang.String type)
                                  throws NoSuchStandardNumberException

Throws:

NoSuchStandardNumberException