org.xbib.standardnumber

Interface StandardNumber

All Known Implementing Classes:

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

public interface StandardNumber

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

Method Summary

Methods

Modifier and Type	Method and Description
StandardNumber	createChecksum(boolean withChecksum) 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.
Collection<String>	getTypedVariants()
boolean	isValid() Check this number for validity.
StandardNumber	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.
StandardNumber	reset()
StandardNumber	set(CharSequence value) Set the input value of this standard number.
String	type() Return the type of this standard number
StandardNumber	verify() Verify the number.

Method Detail

type

String type()

Return the type of this standard number

Returns:

the type

set

StandardNumber set(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

StandardNumber normalize()

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

Returns:

this standard number

isValid

boolean isValid()

Check this number for validity.

Returns:

true if valid, false otherwise

verify

StandardNumber verify()
                      throws NumberFormatException

Verify the number.

Returns:

this standard number if verification was successful

Throws:

NumberFormatException - if verification failed

createChecksum

StandardNumber createChecksum(boolean withChecksum)

Indicate that a correct check sum should be computed.

Returns:

this standard number

normalizedValue

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

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

StandardNumber reset()

getTypedVariants

Collection<String> getTypedVariants()