org.xbib.standardnumber

Class StandardNumber

java.lang.Object

org.xbib.standardnumber.StandardNumberSpi

org.xbib.standardnumber.StandardNumber

Direct Known Subclasses:

ARK, DOI, EAN, GTIN, IBAN, ISAN, ISBN, ISMN, ISNI, ISSN, ISTC, ISWC, PPN, SICI, UPC, ZDB

public abstract class StandardNumber
extends StandardNumberSpi

Standard number implementation. A standard number is a number that

• is backed by an international standard or a de-facto community use

• can accept alphanumeric values (digits and letters and separator characters)

• can be normalizedValue

• can be verified and raise en error is verification fails

• must have a createChecksum

• can be formatted to a printable representation

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	type
protected java.lang.String	value

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StandardNumber(java.lang.String type)

Method Summary

Modifier and Type	Method and Description
abstract StandardNumber	createChecksum(boolean withChecksum) Indicate that a correct check sum should be computed.
abstract 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.
abstract java.util.Collection<java.lang.String>	getTypedVariants()
abstract boolean	isValid() Check this number for validity.
abstract StandardNumber	normalize() Normalize the value by removing all unwanted characters or replacing characters with the ones required for verification.
abstract java.lang.String	normalizedValue() Return normalized value of this standard number.
abstract StandardNumber	reset()
StandardNumber	set(java.lang.CharSequence value) Set the input value of this standard number.
java.lang.String	type() Return the type of this standard number.
abstract StandardNumber	verify() Verify the number.

Methods inherited from class org.xbib.standardnumber.StandardNumberSpi

clone, getInstance, getInstance

Methods inherited from class java.lang.Object

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

Field Detail

type

protected final java.lang.String type

value

protected java.lang.String value

Constructor Detail

StandardNumber

protected StandardNumber(java.lang.String type)

Method Detail

type

public java.lang.String type()

Return the type of this standard number.

Returns:

the type

set

public StandardNumber set(java.lang.CharSequence value)

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

Parameters:

value - the raw input value

Returns:

this standard number

normalize

public abstract StandardNumber normalize()

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

Returns:

this standard number

isValid

public abstract boolean isValid()

Check this number for validity.

Returns:

true if valid, false otherwise

verify

public abstract StandardNumber verify()

Verify the number.

Returns:

this standard number if verification was successful

Throws:

java.lang.NumberFormatException - if verification failed

createChecksum

public abstract StandardNumber createChecksum(boolean withChecksum)

Indicate that a correct check sum should be computed.

Parameters:

withChecksum - if checksum is included

Returns:

this standard number

normalizedValue

public abstract java.lang.String normalizedValue()

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.

Returns:

the normalized value

format

public abstract 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.

Returns:

a formatted value

reset

public abstract StandardNumber reset()

getTypedVariants

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