org.xbib.standardnumber

Class PPN

java.lang.Object

org.xbib.standardnumber.AbstractStandardNumber

org.xbib.standardnumber.PPN

All Implemented Interfaces:

Comparable<PPN>, StandardNumber

public class PPN
extends AbstractStandardNumber
implements Comparable<PPN>, StandardNumber

Pica Productie Nummer A catalog record numbering system, uniquely identifying records, used by PICA (Project voor geIntegreerde Catalogus Automatisering) integrated library systems.

Constructor Summary

Constructors

Constructor and Description
PPN()

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(PPN o)
PPN	createChecksum(boolean createWithChecksum) 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.
PPN	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.
PPN	reset()
PPN	set(CharSequence value) Set the input value of this standard number.
String	type() Return the type of this standard number
PPN	verify() Verify the number.

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

Methods inherited from interface org.xbib.standardnumber.StandardNumber

getTypedVariants

Constructor Detail

PPN

public PPN()

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

set

public PPN 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

compareTo

public int compareTo(PPN o)

Specified by:

compareTo in interface Comparable<PPN>

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

createChecksum

public PPN createChecksum(boolean createWithChecksum)

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 PPN 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 PPN verify()
           throws NumberFormatException

Description copied from interface: StandardNumber

Verify the number.

Specified by:

verify in interface StandardNumber

Returns:

this standard number if verification was successful

Throws:

NumberFormatException - if verification failed

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

reset

public PPN reset()

Specified by:

reset in interface StandardNumber