commit f5df4e9881cd2959d1768dccd7769a1cba8deffe Author: Jörg Prante Date: Mon Jan 30 23:57:40 2017 +0100 initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..3e42bcc --- /dev/null +++ b/.gitignore @@ -0,0 +1,12 @@ +/data +/work +/logs +/.idea +/target +.DS_Store +*.iml +/.settings +/.classpath +/.project +/.gradle +/build \ No newline at end of file diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000..77abba5 --- /dev/null +++ b/build.gradle @@ -0,0 +1,103 @@ +plugins { + id "org.sonarqube" version '2.2' + id "org.xbib.gradle.plugin.asciidoctor" version "1.5.4.1.0" +} + +printf "Host: %s\nOS: %s %s %s\nJVM: %s %s %s %s\nGroovy: %s\nGradle: %s\n" + + "Build: group: ${project.group} name: ${project.name} version: ${project.version}\n", + InetAddress.getLocalHost(), + System.getProperty("os.name"), + System.getProperty("os.arch"), + System.getProperty("os.version"), + System.getProperty("java.version"), + System.getProperty("java.vm.version"), + System.getProperty("java.vm.vendor"), + System.getProperty("java.vm.name"), + GroovySystem.getVersion(), + gradle.gradleVersion + + +apply plugin: 'java' +apply plugin: 'maven' +apply plugin: 'signing' +apply plugin: 'findbugs' +apply plugin: 'pmd' +apply plugin: 'checkstyle' +apply plugin: 'jacoco' +apply plugin: 'org.xbib.gradle.plugin.asciidoctor' + +repositories { + mavenCentral() +} + +configurations { + asciidoclet + wagon +} + +dependencies { + testCompile 'junit:junit:4.12' + asciidoclet 'org.asciidoctor:asciidoclet:1.5.4' + wagon 'org.apache.maven.wagon:wagon-ssh-external:2.10' +} + +sourceCompatibility = JavaVersion.VERSION_1_8 +targetCompatibility = JavaVersion.VERSION_1_8 + +[compileJava, compileTestJava]*.options*.encoding = 'UTF-8' +tasks.withType(JavaCompile) { + options.compilerArgs << "-Xlint:all" << "-profile" << "compact2" +} + +test { + testLogging { + showStandardStreams = false + exceptionFormat = 'full' + } + reports.html.destination = file("${projectDir}/docs/test") +} + +asciidoctor { + backends 'html5' + outputDir = file("${projectDir}/docs") + separateOutputDirs = false + attributes 'source-highlighter': 'coderay', + toc : '', + idprefix : '', + idseparator : '-', + stylesheet: "${projectDir}/src/docs/asciidoc/css/foundation.css" +} + +javadoc { + options.docletpath = configurations.asciidoclet.files.asType(List) + options.doclet = 'org.asciidoctor.Asciidoclet' + options.overview = "src/docs/asciidoclet/overview.adoc" + options.showFromPrivate() + options.addStringOption "-base-dir", "${projectDir}" + options.addStringOption "-attribute", + "name=${project.name},version=${project.version},title-link=https://github.com/xbib/${project.name}" + options.destinationDirectory(file("${projectDir}/docs/javadoc")) + configure(options) { + noTimestamp = true + } +} + +task sourcesJar(type: Jar, dependsOn: classes) { + classifier 'sources' + from sourceSets.main.allSource +} +task javadocJar(type: Jar, dependsOn: javadoc) { + classifier 'javadoc' +} +artifacts { + archives sourcesJar, javadocJar +} +if (project.hasProperty('signing.keyId')) { + signing { + sign configurations.archives + } +} + +apply from: 'gradle/ext.gradle' +apply from: 'gradle/publish.gradle' +apply from: 'gradle/sonarqube.gradle' diff --git a/config/checkstyle/checkstyle.xml b/config/checkstyle/checkstyle.xml new file mode 100644 index 0000000..44ad118 --- /dev/null +++ b/config/checkstyle/checkstyle.xml @@ -0,0 +1,322 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/javadoc/allclasses-frame.html b/docs/javadoc/allclasses-frame.html new file mode 100644 index 0000000..a351125 --- /dev/null +++ b/docs/javadoc/allclasses-frame.html @@ -0,0 +1,45 @@ + + + + + +All Classes (standardnumber 1.0.0 API) + + + + +

All Classes

+
+ +
+ + diff --git a/docs/javadoc/allclasses-noframe.html b/docs/javadoc/allclasses-noframe.html new file mode 100644 index 0000000..ab04db9 --- /dev/null +++ b/docs/javadoc/allclasses-noframe.html @@ -0,0 +1,45 @@ + + + + + +All Classes (standardnumber 1.0.0 API) + + + + +

All Classes

+
+ +
+ + diff --git a/docs/javadoc/coderay-asciidoctor.css b/docs/javadoc/coderay-asciidoctor.css new file mode 100644 index 0000000..ce7c72e --- /dev/null +++ b/docs/javadoc/coderay-asciidoctor.css @@ -0,0 +1,89 @@ +/* Stylesheet for CodeRay to match GitHub theme | MIT License | http://foundation.zurb.com */ +/*pre.CodeRay {background-color:#f7f7f8;}*/ +.CodeRay .line-numbers{border-right:1px solid #d8d8d8;padding:0 0.5em 0 .25em} +.CodeRay span.line-numbers{display:inline-block;margin-right:.5em;color:rgba(0,0,0,.3)} +.CodeRay .line-numbers strong{font-weight: normal} +table.CodeRay{border-collapse:separate;border-spacing:0;margin-bottom:0;border:0;background:none} +table.CodeRay td{vertical-align: top} +table.CodeRay td.line-numbers{text-align:right} +table.CodeRay td.line-numbers>pre{padding:0;color:rgba(0,0,0,.3)} +table.CodeRay td.code{padding:0 0 0 .5em} +table.CodeRay td.code>pre{padding:0} +.CodeRay .debug{color:#fff !important;background:#000080 !important} +.CodeRay .annotation{color:#007} +.CodeRay .attribute-name{color:#000080} +.CodeRay .attribute-value{color:#700} +.CodeRay .binary{color:#509} +.CodeRay .comment{color:#998;font-style:italic} +.CodeRay .char{color:#04d} +.CodeRay .char .content{color:#04d} +.CodeRay .char .delimiter{color:#039} +.CodeRay .class{color:#458;font-weight:bold} +.CodeRay .complex{color:#a08} +.CodeRay .constant,.CodeRay .predefined-constant{color:#008080} +.CodeRay .color{color:#099} +.CodeRay .class-variable{color:#369} +.CodeRay .decorator{color:#b0b} +.CodeRay .definition{color:#099} +.CodeRay .delimiter{color:#000} +.CodeRay .doc{color:#970} +.CodeRay .doctype{color:#34b} +.CodeRay .doc-string{color:#d42} +.CodeRay .escape{color:#666} +.CodeRay .entity{color:#800} +.CodeRay .error{color:#808} +.CodeRay .exception{color:inherit} +.CodeRay .filename{color:#099} +.CodeRay .function{color:#900;font-weight:bold} +.CodeRay .global-variable{color:#008080} +.CodeRay .hex{color:#058} +.CodeRay .integer,.CodeRay .float{color:#099} +.CodeRay .include{color:#555} +.CodeRay .inline{color:#00} +.CodeRay .inline .inline{background:#ccc} +.CodeRay .inline .inline .inline{background:#bbb} +.CodeRay .inline .inline-delimiter{color:#d14} +.CodeRay .inline-delimiter{color:#d14} +.CodeRay .important{color:#555;font-weight:bold} +.CodeRay .interpreted{color:#b2b} +.CodeRay .instance-variable{color:#008080} +.CodeRay .label{color:#970} +.CodeRay .local-variable{color:#963} +.CodeRay .octal{color:#40e} +.CodeRay .predefined{color:#369} +.CodeRay .preprocessor{color:#579} +.CodeRay .pseudo-class{color:#555} +.CodeRay .directive{font-weight:bold} +.CodeRay .type{font-weight:bold} +.CodeRay .predefined-type{color:inherit} +.CodeRay .reserved,.CodeRay .keyword {color:#000;font-weight:bold} +.CodeRay .key{color:#808} +.CodeRay .key .delimiter{color:#606} +.CodeRay .key .char{color:#80f} +.CodeRay .value{color:#088} +.CodeRay .regexp .delimiter{color:#808} +.CodeRay .regexp .content{color:#808} +.CodeRay .regexp .modifier{color:#808} +.CodeRay .regexp .char{color:#d14} +.CodeRay .regexp .function{color:#404;font-weight:bold} +.CodeRay .string{color:#d20} +.CodeRay .string .string .string{background:#ffd0d0} +.CodeRay .string .content{color:#d14} +.CodeRay .string .char{color:#d14} +.CodeRay .string .delimiter{color:#d14} +.CodeRay .shell{color:#d14} +.CodeRay .shell .delimiter{color:#d14} +.CodeRay .symbol{color:#990073} +.CodeRay .symbol .content{color:#a60} +.CodeRay .symbol .delimiter{color:#630} +.CodeRay .tag{color:#008080} +.CodeRay .tag-special{color:#d70} +.CodeRay .variable{color:#036} +.CodeRay .insert{background:#afa} +.CodeRay .delete{background:#faa} +.CodeRay .change{color:#aaf;background:#007} +.CodeRay .head{color:#f8f;background:#505} +.CodeRay .insert .insert{color:#080} +.CodeRay .delete .delete{color:#800} +.CodeRay .change .change{color:#66f} +.CodeRay .head .head{color:#f4f} diff --git a/docs/javadoc/constant-values.html b/docs/javadoc/constant-values.html new file mode 100644 index 0000000..e7e04f9 --- /dev/null +++ b/docs/javadoc/constant-values.html @@ -0,0 +1,209 @@ + + + + + +Constant Field Values (standardnumber 1.0.0 API) + + + + + + + +
+ + + + + + + +
+ + +
+

Constant Field Values

+

Contents

+ +
+
+ + +

org.xbib.*

+ + +
+ +
+ + + + + + + +
+ + + + diff --git a/docs/javadoc/deprecated-list.html b/docs/javadoc/deprecated-list.html new file mode 100644 index 0000000..e342077 --- /dev/null +++ b/docs/javadoc/deprecated-list.html @@ -0,0 +1,121 @@ + + + + + +Deprecated List (standardnumber 1.0.0 API) + + + + + + + +
+ + + + + + + +
+ + +
+

Deprecated API

+

Contents

+
+ +
+ + + + + + + +
+ + + + diff --git a/docs/javadoc/help-doc.html b/docs/javadoc/help-doc.html new file mode 100644 index 0000000..4e7662b --- /dev/null +++ b/docs/javadoc/help-doc.html @@ -0,0 +1,222 @@ + + + + + +API Help (standardnumber 1.0.0 API) + + + + + + + +
+ + + + + + + +
+ + +
+

How This API Document Is Organized

+
This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.
+
+
+ +This help file applies to API documentation generated using the standard doclet.
+ +
+ + + + + + + +
+ + + + diff --git a/docs/javadoc/index-all.html b/docs/javadoc/index-all.html new file mode 100644 index 0000000..533df93 --- /dev/null +++ b/docs/javadoc/index-all.html @@ -0,0 +1,1206 @@ + + + + + +Index (standardnumber 1.0.0 API) + + + + + + + +
+ + + + + + + +
+ + +
A C D E F G H I L M N O P R S T U V Z  + + +

A

+
+
a - Static variable in class org.xbib.standardnumber.checksum.DihedralGroup
+
+
The dihedral addition matrix A + B = a[A][B].
+
+
ALPHABET - Static variable in class org.xbib.standardnumber.checksum.iso7064.MOD1110
+
 
+
ALPHABET - Static variable in class org.xbib.standardnumber.checksum.iso7064.MOD3736
+
 
+
ALPHABET - Static variable in class org.xbib.standardnumber.SICI
+
 
+
ARK - Class in org.xbib.standardnumber
+
+
ARK Archival Resource Key.
+
+
ARK() - Constructor for class org.xbib.standardnumber.ARK
+
 
+
asURI() - Method in class org.xbib.standardnumber.ARK
+
 
+
+ + + +

C

+
+
check() - Method in class org.xbib.standardnumber.EAN
+
 
+
check() - Method in class org.xbib.standardnumber.GTIN
+
 
+
check - Static variable in class org.xbib.standardnumber.IBAN
+
 
+
check() - Method in class org.xbib.standardnumber.IBAN
+
 
+
check - Static variable in class org.xbib.standardnumber.ISAN
+
 
+
check() - Method in class org.xbib.standardnumber.ISAN
+
 
+
check() - Method in class org.xbib.standardnumber.ISBN
+
 
+
check() - Method in class org.xbib.standardnumber.ISMN
+
 
+
check - Static variable in class org.xbib.standardnumber.ISNI
+
 
+
check() - Method in class org.xbib.standardnumber.ISNI
+
 
+
check() - Method in class org.xbib.standardnumber.ISSN
+
 
+
check() - Method in class org.xbib.standardnumber.ISTC
+
 
+
check() - Method in class org.xbib.standardnumber.ISWC
+
 
+
check() - Method in class org.xbib.standardnumber.PPN
+
 
+
check() - Method in class org.xbib.standardnumber.SICI
+
 
+
check() - Method in class org.xbib.standardnumber.UPC
+
 
+
check() - Method in class org.xbib.standardnumber.ZDB
+
 
+
clean(String) - Method in class org.xbib.standardnumber.ISAN
+
 
+
clean(String) - Method in class org.xbib.standardnumber.ISNI
+
 
+
clean(String) - Method in class org.xbib.standardnumber.ISTC
+
 
+
clean(String) - Method in class org.xbib.standardnumber.ISWC
+
 
+
clean(String) - Method in class org.xbib.standardnumber.SICI
+
 
+
clone() - Method in class org.xbib.standardnumber.ARK
+
 
+
clone() - Method in class org.xbib.standardnumber.DOI
+
 
+
clone() - Method in class org.xbib.standardnumber.EAN
+
 
+
clone() - Method in class org.xbib.standardnumber.GTIN
+
 
+
clone() - Method in class org.xbib.standardnumber.IBAN
+
 
+
clone() - Method in class org.xbib.standardnumber.ISAN
+
 
+
clone() - Method in class org.xbib.standardnumber.ISBN
+
 
+
clone() - Method in class org.xbib.standardnumber.ISMN
+
 
+
clone() - Method in class org.xbib.standardnumber.ISNI
+
 
+
clone() - Method in class org.xbib.standardnumber.ISSN
+
 
+
clone() - Method in class org.xbib.standardnumber.ISTC
+
 
+
clone() - Method in class org.xbib.standardnumber.ISWC
+
 
+
clone() - Method in class org.xbib.standardnumber.ORCID
+
 
+
clone() - Method in class org.xbib.standardnumber.PPN
+
 
+
clone() - Method in class org.xbib.standardnumber.SICI
+
 
+
clone() - Method in class org.xbib.standardnumber.StandardNumberSpi
+
+
Returns a clone if the implementation is cloneable.
+
+
clone() - Method in class org.xbib.standardnumber.UPC
+
 
+
clone() - Method in class org.xbib.standardnumber.ZDB
+
 
+
compareTo(ARK) - Method in class org.xbib.standardnumber.ARK
+
 
+
compareTo(DOI) - Method in class org.xbib.standardnumber.DOI
+
 
+
compareTo(EAN) - Method in class org.xbib.standardnumber.EAN
+
 
+
compareTo(GTIN) - Method in class org.xbib.standardnumber.GTIN
+
 
+
compareTo(IBAN) - Method in class org.xbib.standardnumber.IBAN
+
 
+
compareTo(ISAN) - Method in class org.xbib.standardnumber.ISAN
+
 
+
compareTo(ISBN) - Method in class org.xbib.standardnumber.ISBN
+
 
+
compareTo(ISMN) - Method in class org.xbib.standardnumber.ISMN
+
 
+
compareTo(ISNI) - Method in class org.xbib.standardnumber.ISNI
+
 
+
compareTo(ISSN) - Method in class org.xbib.standardnumber.ISSN
+
 
+
compareTo(ISTC) - Method in class org.xbib.standardnumber.ISTC
+
 
+
compareTo(ISWC) - Method in class org.xbib.standardnumber.ISWC
+
 
+
compareTo(ISNI) - Method in class org.xbib.standardnumber.ORCID
+
 
+
compareTo(PPN) - Method in class org.xbib.standardnumber.PPN
+
 
+
compareTo(SICI) - Method in class org.xbib.standardnumber.SICI
+
 
+
compareTo(UPC) - Method in class org.xbib.standardnumber.UPC
+
 
+
compareTo(ZDB) - Method in class org.xbib.standardnumber.ZDB
+
 
+
compute(String) - Method in interface org.xbib.standardnumber.checksum.Digit
+
+
Computes the check digit value.
+
+
compute(String) - Method in class org.xbib.standardnumber.checksum.DihedralGroup
+
 
+
compute(String) - Method in class org.xbib.standardnumber.checksum.iso7064.MOD1110
+
 
+
compute(String) - Method in class org.xbib.standardnumber.checksum.iso7064.MOD112
+
 
+
compute(String) - Method in class org.xbib.standardnumber.checksum.iso7064.MOD3736
+
 
+
compute(String) - Method in class org.xbib.standardnumber.checksum.iso7064.MOD9710
+
 
+
compute(String) - Method in class org.xbib.standardnumber.checksum.LuhnMOD10
+
 
+
computeSum(String) - Method in class org.xbib.standardnumber.checksum.LuhnMOD10
+
 
+
CONSTANT_97 - Static variable in class org.xbib.standardnumber.checksum.iso7064.MOD9710
+
 
+
content - Variable in class org.xbib.standardnumber.ISBN.ISBNRangeMessageConfigurator
+
 
+
country - Variable in class org.xbib.standardnumber.IBAN
+
 
+
COUNTRY_CODES - Static variable in class org.xbib.standardnumber.IBAN
+
+
Known country codes, this list must be sorted to allow binary search.
+
+
COUNTRY_IBAN_LENGTHS - Static variable in class org.xbib.standardnumber.IBAN
+
+
Lengths for each country’s IBAN.
+
+
createCheckDigit10(String) - Method in class org.xbib.standardnumber.ISBN
+
+
Returns a ISBN check digit for the first 9 digits in a string.
+
+
createCheckDigit13(String) - Method in class org.xbib.standardnumber.ISBN
+
+
Returns an ISBN check digit for the first 12 digits in a string.
+
+
createChecksum(boolean) - Method in class org.xbib.standardnumber.ARK
+
 
+
createChecksum(boolean) - Method in class org.xbib.standardnumber.DOI
+
 
+
createChecksum(boolean) - Method in class org.xbib.standardnumber.EAN
+
 
+
createChecksum(boolean) - Method in class org.xbib.standardnumber.GTIN
+
 
+
createChecksum(boolean) - Method in class org.xbib.standardnumber.IBAN
+
 
+
createChecksum(boolean) - Method in class org.xbib.standardnumber.ISAN
+
 
+
createChecksum(boolean) - Method in class org.xbib.standardnumber.ISBN
+
 
+
createChecksum(boolean) - Method in class org.xbib.standardnumber.ISMN
+
 
+
createChecksum(boolean) - Method in class org.xbib.standardnumber.ISNI
+
 
+
createChecksum(boolean) - Method in class org.xbib.standardnumber.ISSN
+
 
+
createChecksum(boolean) - Method in class org.xbib.standardnumber.ISTC
+
 
+
createChecksum(boolean) - Method in class org.xbib.standardnumber.ISWC
+
 
+
createChecksum(boolean) - Method in class org.xbib.standardnumber.ORCID
+
 
+
createChecksum(boolean) - Method in class org.xbib.standardnumber.PPN
+
 
+
createChecksum(boolean) - Method in class org.xbib.standardnumber.SICI
+
 
+
createChecksum(boolean) - Method in class org.xbib.standardnumber.StandardNumber
+
+
Indicate that a correct check sum should be computed.
+
+
createChecksum(boolean) - Method in class org.xbib.standardnumber.UPC
+
 
+
createChecksum(boolean) - Method in class org.xbib.standardnumber.ZDB
+
 
+
createWithChecksum - Variable in class org.xbib.standardnumber.EAN
+
 
+
createWithChecksum - Variable in class org.xbib.standardnumber.GTIN
+
 
+
createWithChecksum - Variable in class org.xbib.standardnumber.IBAN
+
 
+
createWithChecksum - Variable in class org.xbib.standardnumber.ISBN
+
 
+
createWithChecksum - Variable in class org.xbib.standardnumber.ISMN
+
 
+
createWithChecksum - Variable in class org.xbib.standardnumber.ISNI
+
 
+
createWithChecksum - Variable in class org.xbib.standardnumber.ISSN
+
 
+
createWithChecksum - Variable in class org.xbib.standardnumber.ISTC
+
 
+
createWithChecksum - Variable in class org.xbib.standardnumber.PPN
+
 
+
createWithChecksum - Variable in class org.xbib.standardnumber.SICI
+
 
+
createWithChecksum - Variable in class org.xbib.standardnumber.UPC
+
 
+
createWithChecksum - Variable in class org.xbib.standardnumber.ZDB
+
 
+
+ + + +

D

+
+
dehyphenate(String) - Method in class org.xbib.standardnumber.GTIN
+
 
+
dehyphenate(String) - Method in class org.xbib.standardnumber.ISBN
+
 
+
dehyphenate(String) - Method in class org.xbib.standardnumber.ISMN
+
 
+
dehyphenate(String) - Method in class org.xbib.standardnumber.ISSN
+
 
+
dehyphenate(String) - Method in class org.xbib.standardnumber.PPN
+
 
+
dehyphenate(String) - Method in class org.xbib.standardnumber.ZDB
+
 
+
despace(String) - Method in class org.xbib.standardnumber.EAN
+
 
+
Digit - Interface in org.xbib.standardnumber.checksum
+
 
+
DihedralGroup - Class in org.xbib.standardnumber.checksum
+
+
Verhoeff’s algorithm for checksum computation.
+
+
DihedralGroup() - Constructor for class org.xbib.standardnumber.checksum.DihedralGroup
+
 
+
DOI - Class in org.xbib.standardnumber
+
+
ISO 26324: Digital Object Identifier System (DOI), Z39.50 BIB-1 Use Attribute 1094.
+
+
DOI() - Constructor for class org.xbib.standardnumber.DOI
+
 
+
DOI_PATTERN - Static variable in class org.xbib.standardnumber.DOI
+
 
+
DOI_URI_PATTERN - Static variable in class org.xbib.standardnumber.DOI
+
 
+
+ + + +

E

+
+
EAN - Class in org.xbib.standardnumber
+
+
European Article Number is a 13-digit barcoding standard for marking products +sold at retail point of sale.
+
+
EAN() - Constructor for class org.xbib.standardnumber.EAN
+
 
+
ean(boolean) - Method in class org.xbib.standardnumber.ISBN
+
+
Prefer European Article Number (EAN, ISBN-13).
+
+
eanPreferred - Variable in class org.xbib.standardnumber.ISBN
+
 
+
eanvalue - Variable in class org.xbib.standardnumber.ISBN
+
 
+
encode(String) - Method in interface org.xbib.standardnumber.checksum.Digit
+
+
Add check digits to a string containing digits.
+
+
encode(String) - Method in class org.xbib.standardnumber.checksum.DihedralGroup
+
 
+
encode(String) - Method in class org.xbib.standardnumber.checksum.iso7064.MOD1110
+
 
+
encode(String) - Method in class org.xbib.standardnumber.checksum.iso7064.MOD112
+
 
+
encode(String) - Method in class org.xbib.standardnumber.checksum.iso7064.MOD3736
+
 
+
encode(String) - Method in class org.xbib.standardnumber.checksum.iso7064.MOD9710
+
 
+
encode(String) - Method in class org.xbib.standardnumber.checksum.LuhnMOD10
+
 
+
equals(Object) - Method in class org.xbib.standardnumber.ARK
+
 
+
equals(Object) - Method in class org.xbib.standardnumber.DOI
+
 
+
equals(Object) - Method in class org.xbib.standardnumber.EAN
+
 
+
equals(Object) - Method in class org.xbib.standardnumber.GTIN
+
 
+
equals(Object) - Method in class org.xbib.standardnumber.IBAN
+
 
+
equals(Object) - Method in class org.xbib.standardnumber.ISAN
+
 
+
equals(Object) - Method in class org.xbib.standardnumber.ISBN
+
 
+
equals(Object) - Method in class org.xbib.standardnumber.ISMN
+
 
+
equals(Object) - Method in class org.xbib.standardnumber.ISNI
+
 
+
equals(Object) - Method in class org.xbib.standardnumber.ISSN
+
 
+
equals(Object) - Method in class org.xbib.standardnumber.ISTC
+
 
+
equals(Object) - Method in class org.xbib.standardnumber.ISWC
+
 
+
equals(Object) - Method in class org.xbib.standardnumber.ORCID
+
 
+
equals(Object) - Method in class org.xbib.standardnumber.PPN
+
 
+
equals(Object) - Method in class org.xbib.standardnumber.SICI
+
 
+
equals(Object) - Method in class org.xbib.standardnumber.UPC
+
 
+
equals(Object) - Method in class org.xbib.standardnumber.ZDB
+
 
+
+ + + +

F

+
+
fix(String) - Method in class org.xbib.standardnumber.ISBN
+
 
+
format() - Method in class org.xbib.standardnumber.ARK
+
 
+
format() - Method in class org.xbib.standardnumber.DOI
+
 
+
format() - Method in class org.xbib.standardnumber.EAN
+
 
+
format() - Method in class org.xbib.standardnumber.GTIN
+
 
+
format() - Method in class org.xbib.standardnumber.IBAN
+
 
+
format() - Method in class org.xbib.standardnumber.ISAN
+
 
+
format() - Method in class org.xbib.standardnumber.ISBN
+
+
Get printable representation of this standard book number.
+
+
format() - Method in class org.xbib.standardnumber.ISMN
+
 
+
format() - Method in class org.xbib.standardnumber.ISNI
+
+
Format this number.
+
+
format() - Method in class org.xbib.standardnumber.ISSN
+
+
Format this number.
+
+
format() - Method in class org.xbib.standardnumber.ISTC
+
 
+
format() - Method in class org.xbib.standardnumber.ISWC
+
 
+
format() - Method in class org.xbib.standardnumber.PPN
+
 
+
format() - Method in class org.xbib.standardnumber.SICI
+
 
+
format() - Method in class org.xbib.standardnumber.StandardNumber
+
+
Return a formatted value of this standard number +This is best for human-readable representation, but is +not necessarily a format for computation.
+
+
format() - Method in class org.xbib.standardnumber.UPC
+
 
+
format() - Method in class org.xbib.standardnumber.ZDB
+
 
+
formatted - Variable in class org.xbib.standardnumber.IBAN
+
 
+
formatted - Variable in class org.xbib.standardnumber.ISAN
+
 
+
formatted - Variable in class org.xbib.standardnumber.ISNI
+
 
+
formatted - Variable in class org.xbib.standardnumber.ISSN
+
 
+
formatted - Variable in class org.xbib.standardnumber.ISTC
+
 
+
formatted - Variable in class org.xbib.standardnumber.ISWC
+
 
+
formatted - Variable in class org.xbib.standardnumber.PPN
+
 
+
formatted - Variable in class org.xbib.standardnumber.SICI
+
 
+
formatted - Variable in class org.xbib.standardnumber.ZDB
+
 
+
+ + + +

G

+
+
getCountryAndPublisherCode() - Method in class org.xbib.standardnumber.ISBN
+
+
Get country and publisher code.
+
+
getDigit(String) - Method in interface org.xbib.standardnumber.checksum.Digit
+
+
Extract just the check digit from an encoded string.
+
+
getDigit(String) - Method in class org.xbib.standardnumber.checksum.DihedralGroup
+
 
+
getDigit(String) - Method in class org.xbib.standardnumber.checksum.iso7064.MOD1110
+
 
+
getDigit(String) - Method in class org.xbib.standardnumber.checksum.iso7064.MOD112
+
 
+
getDigit(String) - Method in class org.xbib.standardnumber.checksum.iso7064.MOD3736
+
 
+
getDigit(String) - Method in class org.xbib.standardnumber.checksum.iso7064.MOD9710
+
 
+
getDigit(String) - Method in class org.xbib.standardnumber.checksum.LuhnMOD10
+
 
+
getInstance(String) - Static method in class org.xbib.standardnumber.StandardNumberSpi
+
 
+
getInstance(Package, ClassLoader, String) - Static method in class org.xbib.standardnumber.StandardNumberSpi
+
 
+
getLengthForCountryCode(String) - Method in class org.xbib.standardnumber.IBAN
+
+
Returns the IBAN length for a given country code.
+
+
getNumber(String) - Method in interface org.xbib.standardnumber.checksum.Digit
+
+
Extracts the raw data without the check digits.
+
+
getNumber(String) - Method in class org.xbib.standardnumber.checksum.DihedralGroup
+
 
+
getNumber(String) - Method in class org.xbib.standardnumber.checksum.iso7064.MOD1110
+
 
+
getNumber(String) - Method in class org.xbib.standardnumber.checksum.iso7064.MOD112
+
 
+
getNumber(String) - Method in class org.xbib.standardnumber.checksum.iso7064.MOD3736
+
 
+
getNumber(String) - Method in class org.xbib.standardnumber.checksum.iso7064.MOD9710
+
 
+
getNumber(String) - Method in class org.xbib.standardnumber.checksum.LuhnMOD10
+
 
+
getRanges() - Method in class org.xbib.standardnumber.ISBN.ISBNRangeMessageConfigurator
+
 
+
getTypedVariants() - Method in class org.xbib.standardnumber.ARK
+
 
+
getTypedVariants() - Method in class org.xbib.standardnumber.DOI
+
 
+
getTypedVariants() - Method in class org.xbib.standardnumber.EAN
+
 
+
getTypedVariants() - Method in class org.xbib.standardnumber.GTIN
+
 
+
getTypedVariants() - Method in class org.xbib.standardnumber.IBAN
+
 
+
getTypedVariants() - Method in class org.xbib.standardnumber.ISAN
+
 
+
getTypedVariants() - Method in class org.xbib.standardnumber.ISBN
+
 
+
getTypedVariants() - Method in class org.xbib.standardnumber.ISMN
+
 
+
getTypedVariants() - Method in class org.xbib.standardnumber.ISNI
+
 
+
getTypedVariants() - Method in class org.xbib.standardnumber.ISSN
+
 
+
getTypedVariants() - Method in class org.xbib.standardnumber.ISTC
+
 
+
getTypedVariants() - Method in class org.xbib.standardnumber.ISWC
+
 
+
getTypedVariants() - Method in class org.xbib.standardnumber.PPN
+
 
+
getTypedVariants() - Method in class org.xbib.standardnumber.SICI
+
 
+
getTypedVariants() - Method in class org.xbib.standardnumber.StandardNumber
+
 
+
getTypedVariants() - Method in class org.xbib.standardnumber.UPC
+
 
+
getTypedVariants() - Method in class org.xbib.standardnumber.ZDB
+
 
+
GTIN - Class in org.xbib.standardnumber
+
+
Global Trade Item Number (GTIN).
+
+
GTIN() - Constructor for class org.xbib.standardnumber.GTIN
+
 
+
+ + + +

H

+
+
hashCode() - Method in class org.xbib.standardnumber.ARK
+
 
+
hashCode() - Method in class org.xbib.standardnumber.DOI
+
 
+
hashCode() - Method in class org.xbib.standardnumber.EAN
+
 
+
hashCode() - Method in class org.xbib.standardnumber.GTIN
+
 
+
hashCode() - Method in class org.xbib.standardnumber.IBAN
+
 
+
hashCode() - Method in class org.xbib.standardnumber.ISAN
+
 
+
hashCode() - Method in class org.xbib.standardnumber.ISBN
+
 
+
hashCode() - Method in class org.xbib.standardnumber.ISMN
+
 
+
hashCode() - Method in class org.xbib.standardnumber.ISNI
+
 
+
hashCode() - Method in class org.xbib.standardnumber.ISSN
+
 
+
hashCode() - Method in class org.xbib.standardnumber.ISTC
+
 
+
hashCode() - Method in class org.xbib.standardnumber.ISWC
+
 
+
hashCode() - Method in class org.xbib.standardnumber.ORCID
+
 
+
hashCode() - Method in class org.xbib.standardnumber.PPN
+
 
+
hashCode() - Method in class org.xbib.standardnumber.SICI
+
 
+
hashCode() - Method in class org.xbib.standardnumber.UPC
+
 
+
hashCode() - Method in class org.xbib.standardnumber.ZDB
+
 
+
httpDoi - Variable in class org.xbib.standardnumber.DOI
+
 
+
httpDxDoi - Variable in class org.xbib.standardnumber.DOI
+
 
+
hyphenate(String, String) - Method in class org.xbib.standardnumber.ISBN
+
 
+
+ + + +

I

+
+
IBAN - Class in org.xbib.standardnumber
+
+
ISO 13616 International Bank Account Number (IBAN).
+
+
IBAN() - Constructor for class org.xbib.standardnumber.IBAN
+
 
+
infoURI - Variable in class org.xbib.standardnumber.DOI
+
 
+
inverse - Static variable in class org.xbib.standardnumber.checksum.DihedralGroup
+
+
The dihedral inverse map, A + inverse[A] = 0.
+
+
ISAN - Class in org.xbib.standardnumber
+
+
ISO 15706 International Standard Audiovisual Number (ISAN).
+
+
ISAN() - Constructor for class org.xbib.standardnumber.ISAN
+
 
+
ISBN - Class in org.xbib.standardnumber
+
+
ISO 2108 International Standard Book Number (ISBN), Z39.50 BIB-1 Use Attribute 7.
+
+
ISBN() - Constructor for class org.xbib.standardnumber.ISBN
+
 
+
ISBN.ISBNRangeMessageConfigurator - Class in org.xbib.standardnumber
+
 
+
ISBNRangeMessageConfigurator() - Constructor for class org.xbib.standardnumber.ISBN.ISBNRangeMessageConfigurator
+
 
+
isEAN - Variable in class org.xbib.standardnumber.ISBN
+
 
+
isEAN() - Method in class org.xbib.standardnumber.ISBN
+
 
+
isInRange(String, String, String) - Method in class org.xbib.standardnumber.ISBN
+
+
Check if ISBN is within a given value range.
+
+
ISMN - Class in org.xbib.standardnumber
+
+
ISO 10957 International Standard Music Number (ISMN), Z39.50 BIB-1 Use Attribute 1092.
+
+
ISMN() - Constructor for class org.xbib.standardnumber.ISMN
+
 
+
ISNI - Class in org.xbib.standardnumber
+
+
ISO 27729 International Standard Name Identifier (ISNI).
+
+
ISNI() - Constructor for class org.xbib.standardnumber.ISNI
+
 
+
ISNI(String) - Constructor for class org.xbib.standardnumber.ISNI
+
 
+
ISSN - Class in org.xbib.standardnumber
+
+
ISO 3297 International Standard Serial Number (ISSN), Z39.50 BIB-1 Use Attribute 8.
+
+
ISSN() - Constructor for class org.xbib.standardnumber.ISSN
+
 
+
ISTC - Class in org.xbib.standardnumber
+
+
ISO 21047 International Standard Text Code (ISTC).
+
+
ISTC() - Constructor for class org.xbib.standardnumber.ISTC
+
 
+
isValid() - Method in class org.xbib.standardnumber.ARK
+
 
+
isValid() - Method in class org.xbib.standardnumber.DOI
+
 
+
isValid() - Method in class org.xbib.standardnumber.EAN
+
 
+
isValid() - Method in class org.xbib.standardnumber.GTIN
+
 
+
isValid() - Method in class org.xbib.standardnumber.IBAN
+
 
+
isValid() - Method in class org.xbib.standardnumber.ISAN
+
 
+
isValid() - Method in class org.xbib.standardnumber.ISBN
+
+
Check for this ISBN number validity.
+
+
isValid() - Method in class org.xbib.standardnumber.ISMN
+
 
+
isValid() - Method in class org.xbib.standardnumber.ISNI
+
 
+
isValid() - Method in class org.xbib.standardnumber.ISSN
+
 
+
isValid() - Method in class org.xbib.standardnumber.ISTC
+
 
+
isValid() - Method in class org.xbib.standardnumber.ISWC
+
 
+
isValid() - Method in class org.xbib.standardnumber.PPN
+
 
+
isValid() - Method in class org.xbib.standardnumber.SICI
+
 
+
isValid() - Method in class org.xbib.standardnumber.StandardNumber
+
+
Check this number for validity.
+
+
isValid() - Method in class org.xbib.standardnumber.UPC
+
 
+
isValid() - Method in class org.xbib.standardnumber.ZDB
+
 
+
ISWC - Class in org.xbib.standardnumber
+
+
ISO 15707 International Standard Musical Work Code (ISWC).
+
+
ISWC() - Constructor for class org.xbib.standardnumber.ISWC
+
 
+
+ + + +

L

+
+
length - Variable in class org.xbib.standardnumber.ISBN.ISBNRangeMessageConfigurator
+
 
+
LuhnMOD10 - Class in org.xbib.standardnumber.checksum
+
 
+
LuhnMOD10() - Constructor for class org.xbib.standardnumber.checksum.LuhnMOD10
+
 
+
+ + + +

M

+
+
make(Object) - Method in class org.xbib.standardnumber.DOI
+
 
+
MOD1110 - Class in org.xbib.standardnumber.checksum.iso7064
+
 
+
MOD1110() - Constructor for class org.xbib.standardnumber.checksum.iso7064.MOD1110
+
 
+
MOD112 - Class in org.xbib.standardnumber.checksum.iso7064
+
 
+
MOD112() - Constructor for class org.xbib.standardnumber.checksum.iso7064.MOD112
+
 
+
MOD3736 - Class in org.xbib.standardnumber.checksum.iso7064
+
 
+
MOD3736() - Constructor for class org.xbib.standardnumber.checksum.iso7064.MOD3736
+
 
+
MOD9710 - Class in org.xbib.standardnumber.checksum.iso7064
+
 
+
MOD9710() - Constructor for class org.xbib.standardnumber.checksum.iso7064.MOD9710
+
 
+
modulus - Static variable in class org.xbib.standardnumber.SICI
+
 
+
+ + + +

N

+
+
normalize() - Method in class org.xbib.standardnumber.ARK
+
 
+
normalize() - Method in class org.xbib.standardnumber.DOI
+
 
+
normalize() - Method in class org.xbib.standardnumber.EAN
+
 
+
normalize() - Method in class org.xbib.standardnumber.GTIN
+
 
+
normalize() - Method in class org.xbib.standardnumber.IBAN
+
 
+
normalize() - Method in class org.xbib.standardnumber.ISAN
+
 
+
normalize() - Method in class org.xbib.standardnumber.ISBN
+
 
+
normalize() - Method in class org.xbib.standardnumber.ISMN
+
 
+
normalize() - Method in class org.xbib.standardnumber.ISNI
+
 
+
normalize() - Method in class org.xbib.standardnumber.ISSN
+
 
+
normalize() - Method in class org.xbib.standardnumber.ISTC
+
 
+
normalize() - Method in class org.xbib.standardnumber.ISWC
+
 
+
normalize() - Method in class org.xbib.standardnumber.ORCID
+
 
+
normalize() - Method in class org.xbib.standardnumber.PPN
+
 
+
normalize() - Method in class org.xbib.standardnumber.SICI
+
 
+
normalize() - Method in class org.xbib.standardnumber.StandardNumber
+
+
Normalize the value by removing all unwanted characters or +replacing characters with the ones required for verification.
+
+
normalize() - Method in class org.xbib.standardnumber.UPC
+
 
+
normalize() - Method in class org.xbib.standardnumber.ZDB
+
 
+
normalizedValue() - Method in class org.xbib.standardnumber.ARK
+
 
+
normalizedValue() - Method in class org.xbib.standardnumber.DOI
+
 
+
normalizedValue() - Method in class org.xbib.standardnumber.EAN
+
 
+
normalizedValue() - Method in class org.xbib.standardnumber.GTIN
+
 
+
normalizedValue() - Method in class org.xbib.standardnumber.IBAN
+
 
+
normalizedValue() - Method in class org.xbib.standardnumber.ISAN
+
 
+
normalizedValue() - Method in class org.xbib.standardnumber.ISBN
+
+
Get the normalized value of this standard book number.
+
+
normalizedValue() - Method in class org.xbib.standardnumber.ISMN
+
 
+
normalizedValue() - Method in class org.xbib.standardnumber.ISNI
+
+
Returns the value representation of the standard number.
+
+
normalizedValue() - Method in class org.xbib.standardnumber.ISSN
+
+
Returns the value representation of the standard number.
+
+
normalizedValue() - Method in class org.xbib.standardnumber.ISTC
+
 
+
normalizedValue() - Method in class org.xbib.standardnumber.ISWC
+
 
+
normalizedValue() - Method in class org.xbib.standardnumber.PPN
+
 
+
normalizedValue() - Method in class org.xbib.standardnumber.SICI
+
 
+
normalizedValue() - Method in class org.xbib.standardnumber.StandardNumber
+
+
Return normalized value of this standard number.
+
+
normalizedValue() - Method in class org.xbib.standardnumber.UPC
+
 
+
normalizedValue() - Method in class org.xbib.standardnumber.ZDB
+
 
+
NoSuchStandardNumberException - Exception in org.xbib.standardnumber
+
+
An exception that is thrown if a standard number implementation is not available.
+
+
NoSuchStandardNumberException(String) - Constructor for exception org.xbib.standardnumber.NoSuchStandardNumberException
+
 
+
+ + + +

O

+
+
ORCID - Class in org.xbib.standardnumber
+
+
Open Researcher and Contributor ID - ORCID.
+
+
ORCID() - Constructor for class org.xbib.standardnumber.ORCID
+
 
+
org.xbib.standardnumber - package org.xbib.standardnumber
+
+
Classes for standard numbers.
+
+
org.xbib.standardnumber.checksum - package org.xbib.standardnumber.checksum
+
+
Classes for computing checksums.
+
+
org.xbib.standardnumber.checksum.iso7064 - package org.xbib.standardnumber.checksum.iso7064
+
+
Classes for checksum computations according to ISO 7064.
+
+
+ + + +

P

+
+
p - Static variable in class org.xbib.standardnumber.checksum.DihedralGroup
+
+
pThe ermutation weighting matrix P[position][value].
+
+
parse(String) - Method in class org.xbib.standardnumber.IBAN
+
 
+
PATTERN - Static variable in class org.xbib.standardnumber.ARK
+
 
+
PATTERN - Static variable in class org.xbib.standardnumber.EAN
+
 
+
PATTERN - Static variable in class org.xbib.standardnumber.GTIN
+
 
+
PATTERN - Static variable in class org.xbib.standardnumber.IBAN
+
+
Norway = 15, Malta = 31 + "IBAN ".
+
+
PATTERN - Static variable in class org.xbib.standardnumber.ISAN
+
 
+
PATTERN - Static variable in class org.xbib.standardnumber.ISBN
+
 
+
PATTERN - Static variable in class org.xbib.standardnumber.ISMN
+
 
+
PATTERN - Static variable in class org.xbib.standardnumber.ISNI
+
 
+
PATTERN - Static variable in class org.xbib.standardnumber.ISSN
+
 
+
PATTERN - Static variable in class org.xbib.standardnumber.ISTC
+
 
+
PATTERN - Static variable in class org.xbib.standardnumber.ISWC
+
 
+
PATTERN - Static variable in class org.xbib.standardnumber.PPN
+
 
+
PATTERN - Static variable in class org.xbib.standardnumber.SICI
+
 
+
PATTERN - Static variable in class org.xbib.standardnumber.UPC
+
 
+
PATTERN - Static variable in class org.xbib.standardnumber.ZDB
+
 
+
PPN - Class in org.xbib.standardnumber
+
+
Pica Productie Nummer (PPN).
+
+
PPN() - Constructor for class org.xbib.standardnumber.PPN
+
 
+
prefix - Variable in class org.xbib.standardnumber.ISBN.ISBNRangeMessageConfigurator
+
 
+
processEvent(XMLEvent) - Method in class org.xbib.standardnumber.ISBN.ISBNRangeMessageConfigurator
+
 
+
+ + + +

R

+
+
rangeBegin - Variable in class org.xbib.standardnumber.ISBN.ISBNRangeMessageConfigurator
+
 
+
rangeEnd - Variable in class org.xbib.standardnumber.ISBN.ISBNRangeMessageConfigurator
+
 
+
ranges - Variable in class org.xbib.standardnumber.ISBN.ISBNRangeMessageConfigurator
+
 
+
ranges - Static variable in class org.xbib.standardnumber.ISBN
+
 
+
reset() - Method in class org.xbib.standardnumber.ARK
+
 
+
reset() - Method in class org.xbib.standardnumber.DOI
+
 
+
reset() - Method in class org.xbib.standardnumber.EAN
+
 
+
reset() - Method in class org.xbib.standardnumber.GTIN
+
 
+
reset() - Method in class org.xbib.standardnumber.IBAN
+
 
+
reset() - Method in class org.xbib.standardnumber.ISAN
+
 
+
reset() - Method in class org.xbib.standardnumber.ISBN
+
 
+
reset() - Method in class org.xbib.standardnumber.ISMN
+
 
+
reset() - Method in class org.xbib.standardnumber.ISNI
+
 
+
reset() - Method in class org.xbib.standardnumber.ISSN
+
 
+
reset() - Method in class org.xbib.standardnumber.ISTC
+
 
+
reset() - Method in class org.xbib.standardnumber.ISWC
+
 
+
reset() - Method in class org.xbib.standardnumber.PPN
+
 
+
reset() - Method in class org.xbib.standardnumber.SICI
+
 
+
reset() - Method in class org.xbib.standardnumber.StandardNumber
+
 
+
reset() - Method in class org.xbib.standardnumber.UPC
+
 
+
reset() - Method in class org.xbib.standardnumber.ZDB
+
 
+
+ + + +

S

+
+
serialVersionUID - Static variable in exception org.xbib.standardnumber.NoSuchStandardNumberException
+
 
+
set(CharSequence) - Method in class org.xbib.standardnumber.ARK
+
 
+
set(CharSequence) - Method in class org.xbib.standardnumber.ORCID
+
 
+
set(CharSequence) - Method in class org.xbib.standardnumber.StandardNumber
+
+
Set the input value of this standard number.
+
+
SICI - Class in org.xbib.standardnumber
+
+
Z39.56 Serial Item and Contribution Identifier.
+
+
SICI() - Constructor for class org.xbib.standardnumber.SICI
+
 
+
StandardNumber - Class in org.xbib.standardnumber
+
+
Standard number implementation.
+
+
StandardNumber(String) - Constructor for class org.xbib.standardnumber.StandardNumber
+
 
+
StandardNumberSpi - Class in org.xbib.standardnumber
+
 
+
StandardNumberSpi() - Constructor for class org.xbib.standardnumber.StandardNumberSpi
+
 
+
+ + + +

T

+
+
toGTIN() - Method in class org.xbib.standardnumber.ISMN
+
 
+
toGTIN() - Method in class org.xbib.standardnumber.ISSN
+
 
+
toGTIN(String) - Method in class org.xbib.standardnumber.ISSN
+
 
+
toURI() - Method in class org.xbib.standardnumber.ORCID
+
 
+
type - Variable in class org.xbib.standardnumber.StandardNumber
+
 
+
type() - Method in class org.xbib.standardnumber.StandardNumber
+
+
Return the type of this standard number.
+
+
type() - Method in class org.xbib.standardnumber.ZDB
+
 
+
+ + + +

U

+
+
UPC - Class in org.xbib.standardnumber
+
+
ISO 15420 Universal Product Code (UPC).
+
+
UPC() - Constructor for class org.xbib.standardnumber.UPC
+
 
+
uri - Variable in class org.xbib.standardnumber.ARK
+
 
+
URI_PATTERN - Static variable in class org.xbib.standardnumber.ARK
+
 
+
+ + + +

V

+
+
valid - Variable in class org.xbib.standardnumber.ISBN.ISBNRangeMessageConfigurator
+
 
+
valid - Variable in class org.xbib.standardnumber.ISBN
+
 
+
value - Variable in class org.xbib.standardnumber.StandardNumber
+
 
+
verify() - Method in class org.xbib.standardnumber.ARK
+
+
No verification.
+
+
verify(String) - Method in interface org.xbib.standardnumber.checksum.Digit
+
+
Verify a string that has been encoded with a check digit.
+
+
verify(String) - Method in class org.xbib.standardnumber.checksum.DihedralGroup
+
 
+
verify(String) - Method in class org.xbib.standardnumber.checksum.iso7064.MOD1110
+
 
+
verify(String) - Method in class org.xbib.standardnumber.checksum.iso7064.MOD112
+
 
+
verify(String) - Method in class org.xbib.standardnumber.checksum.iso7064.MOD3736
+
 
+
verify(String) - Method in class org.xbib.standardnumber.checksum.iso7064.MOD9710
+
 
+
verify(String) - Method in class org.xbib.standardnumber.checksum.LuhnMOD10
+
 
+
verify() - Method in class org.xbib.standardnumber.DOI
+
 
+
verify() - Method in class org.xbib.standardnumber.EAN
+
 
+
verify() - Method in class org.xbib.standardnumber.GTIN
+
 
+
verify() - Method in class org.xbib.standardnumber.IBAN
+
 
+
verify() - Method in class org.xbib.standardnumber.ISAN
+
 
+
verify() - Method in class org.xbib.standardnumber.ISBN
+
 
+
verify() - Method in class org.xbib.standardnumber.ISMN
+
 
+
verify() - Method in class org.xbib.standardnumber.ISNI
+
 
+
verify() - Method in class org.xbib.standardnumber.ISSN
+
 
+
verify() - Method in class org.xbib.standardnumber.ISTC
+
 
+
verify() - Method in class org.xbib.standardnumber.ISWC
+
 
+
verify() - Method in class org.xbib.standardnumber.ORCID
+
 
+
verify() - Method in class org.xbib.standardnumber.PPN
+
 
+
verify() - Method in class org.xbib.standardnumber.SICI
+
 
+
verify() - Method in class org.xbib.standardnumber.StandardNumber
+
+
Verify the number.
+
+
verify() - Method in class org.xbib.standardnumber.UPC
+
 
+
verify() - Method in class org.xbib.standardnumber.ZDB
+
 
+
versioned - Variable in class org.xbib.standardnumber.ISAN
+
 
+
versioned() - Method in class org.xbib.standardnumber.ISAN
+
 
+
+ + + +

Z

+
+
ZDB - Class in org.xbib.standardnumber
+
+
Zeitschriftendatenbank ID.
+
+
ZDB() - Constructor for class org.xbib.standardnumber.ZDB
+
 
+
+A C D E F G H I L M N O P R S T U V Z 
+ +
+ + + + + + + +
+ + + + diff --git a/docs/javadoc/index.html b/docs/javadoc/index.html new file mode 100644 index 0000000..669f591 --- /dev/null +++ b/docs/javadoc/index.html @@ -0,0 +1,75 @@ + + + + + +standardnumber 1.0.0 API + + + + + + + + + +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<h2>Frame Alert</h2> +<p>This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. Link to <a href="overview-summary.html">Non-frame version</a>.</p> + + + diff --git a/docs/javadoc/org/xbib/standardnumber/ARK.html b/docs/javadoc/org/xbib/standardnumber/ARK.html new file mode 100644 index 0000000..0a1700e --- /dev/null +++ b/docs/javadoc/org/xbib/standardnumber/ARK.html @@ -0,0 +1,666 @@ + + + + + +ARK (standardnumber 1.0.0 API) + + + + + + + +
+ + + + + + + +
+ + + +
+
org.xbib.standardnumber
+

Class ARK

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable, java.lang.Comparable<ARK>
    +
    +
    +
    +
    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 
      Modifier and TypeField and Description
      private static java.util.regex.PatternPATTERN 
      private java.net.URIuri 
      private static java.util.regex.PatternURI_PATTERN 
      + +
    • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
      protected ARK() 
      +
    • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.net.URIasURI() 
      java.lang.Objectclone() +
      Returns a clone if the implementation is cloneable.
      +
      intcompareTo(ARK ark) 
      ARKcreateChecksum(boolean checksum) +
      Indicate that a correct check sum should be computed.
      +
      booleanequals(java.lang.Object object) 
      java.lang.Stringformat() +
      Return a formatted value of this standard number +This is best for human-readable representation, but is +not necessarily a format for computation.
      +
      java.util.Collection<java.lang.String>getTypedVariants() 
      inthashCode() 
      booleanisValid() +
      Check this number for validity.
      +
      ARKnormalize() +
      Normalize the value by removing all unwanted characters or +replacing characters with the ones required for verification.
      +
      java.lang.StringnormalizedValue() +
      Return normalized value of this standard number.
      +
      ARKreset() 
      ARKset(java.lang.CharSequence value) +
      Set the input value of this standard number.
      +
      ARKverify() +
      No verification.
      +
      + + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, toString, wait, wait, wait
      • +
      +
    • +
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        PATTERN

        +
        private static final java.util.regex.Pattern PATTERN
        +
      • +
      + + + +
        +
      • +

        URI_PATTERN

        +
        private static final java.util.regex.Pattern URI_PATTERN
        +
      • +
      + + + +
        +
      • +

        uri

        +
        private java.net.URI uri
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ARK

        +
        protected ARK()
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        compareTo

        +
        public int compareTo(ARK ark)
        +
        +
        Specified by:
        +
        compareTo in interface java.lang.Comparable<ARK>
        +
        +
      • +
      + + + +
        +
      • +

        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()
        +
      • +
      + + + + + + + +
        +
      • +

        getTypedVariants

        +
        public java.util.Collection<java.lang.String> getTypedVariants()
        +
        +
        Specified by:
        +
        getTypedVariants in class StandardNumber
        +
        +
      • +
      + + + +
        +
      • +

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

        Returns a clone if the implementation is cloneable.

        +
        +
        Overrides:
        +
        clone in class StandardNumberSpi
        +
        Returns:
        +
        a clone if the implementation is cloneable.
        +
        Throws:
        +
        java.lang.CloneNotSupportedException - if this is called on an + implementation that does not support Cloneable
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + + + +
+ + + + diff --git a/docs/javadoc/org/xbib/standardnumber/DOI.html b/docs/javadoc/org/xbib/standardnumber/DOI.html new file mode 100644 index 0000000..7fe52fe --- /dev/null +++ b/docs/javadoc/org/xbib/standardnumber/DOI.html @@ -0,0 +1,683 @@ + + + + + +DOI (standardnumber 1.0.0 API) + + + + + + + +
+ + + + + + + +
+ + + +
+
org.xbib.standardnumber
+

Class DOI

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable, java.lang.Comparable<DOI>
    +
    +
    +
    +
    class DOI
    +extends StandardNumber
    +implements java.lang.Cloneable, java.lang.Comparable<DOI>
    +

    ISO 26324: Digital Object Identifier System (DOI), Z39.50 BIB-1 Use Attribute 1094.

    +

    DOI is an acronym for "digital object identifier", meaning a "digital identifier of an object" +rather than an "identifier of a digital object". The DOI system was initiated by the +International DOI Foundation in 1998, and initially developed with the collaboration +of some participants in ISO/TC46/SC9. Due to its application in the fields of +information and documentation and previous collaboration with some ISO/TC46/SC9 participants, +it was introduced as a possible work item in 2004 and further developed from 2006 to 2010.

    +

    The DOI system is designed to work over the Internet. A DOI name is permanently assigned +to an object to provide a resolvable persistent network link to current information about +that object, including where the object, or information about it, can be found on the +Internet. While information about an object can change over time, its DOI name will not +change. A DOI name can be resolved within the DOI system to values of one or more types +of data relating to the object identified by that DOI name, such as a URL, an e-mail address, +other identifiers and descriptive metadata.

    +

    The DOI system enables the construction of automated services and transactions. +Applications of the DOI system include but are not limited to managing information +and documentation location and access; managing metadata; facilitating electronic +transactions; persistent unique identification of any form of any data; and commercial +and non-commercial transactions.

    +

    The content of an object associated with a DOI name is described unambiguously +by DOI metadata, based on a structured extensible data model that enables the object +to be associated with metadata of any desired degree of precision and granularity +to support description and services. The data model supports interoperability +between DOI applications.

    +

    The scope of the DOI system is not defined by reference to the type of content +(format, etc.) of the referent, but by reference to the functionalities it provides +and the context of use. The DOI system provides, within networks of DOI applications, +for unique identification, persistence, resolution, metadata and semantic interoperability.

    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private static java.util.regex.PatternDOI_PATTERN 
      private static java.util.regex.PatternDOI_URI_PATTERN 
      private java.net.URIhttpDoi 
      private java.net.URIhttpDxDoi 
      private java.net.URIinfoURI 
      + +
    • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
      protected DOI() 
      +
    • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.lang.Objectclone() +
      Returns a clone if the implementation is cloneable.
      +
      intcompareTo(DOI doi) 
      DOIcreateChecksum(boolean checksum) +
      Indicate that a correct check sum should be computed.
      +
      booleanequals(java.lang.Object object) 
      java.lang.Stringformat() +
      Return a formatted value of this standard number +This is best for human-readable representation, but is +not necessarily a format for computation.
      +
      java.util.Collection<java.lang.String>getTypedVariants() 
      inthashCode() 
      booleanisValid() +
      Check this number for validity.
      +
      private voidmake(java.lang.Object o) 
      DOInormalize() +
      Normalize the value by removing all unwanted characters or +replacing characters with the ones required for verification.
      +
      java.lang.StringnormalizedValue() +
      Return normalized value of this standard number.
      +
      DOIreset() 
      DOIverify() +
      Verify the number.
      +
      + + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, toString, wait, wait, wait
      • +
      +
    • +
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        DOI_PATTERN

        +
        private static final java.util.regex.Pattern DOI_PATTERN
        +
      • +
      + + + +
        +
      • +

        DOI_URI_PATTERN

        +
        private static final java.util.regex.Pattern DOI_URI_PATTERN
        +
      • +
      + + + +
        +
      • +

        infoURI

        +
        private java.net.URI infoURI
        +
      • +
      + + + +
        +
      • +

        httpDoi

        +
        private java.net.URI httpDoi
        +
      • +
      + + + +
        +
      • +

        httpDxDoi

        +
        private java.net.URI httpDxDoi
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        DOI

        +
        protected DOI()
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        compareTo

        +
        public int compareTo(DOI doi)
        +
        +
        Specified by:
        +
        compareTo in interface java.lang.Comparable<DOI>
        +
        +
      • +
      + + + +
        +
      • +

        createChecksum

        +
        public DOI 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 DOI 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 DOI verify()
        +
        Description copied from class: StandardNumber
        +

        Verify the number.

        +
        +
        Specified by:
        +
        verify in class StandardNumber
        +
        Returns:
        +
        this standard number if verification was successful
        +
        +
      • +
      + + + +
        +
      • +

        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
        +
        +
      • +
      + + + +
        +
      • +

        getTypedVariants

        +
        public java.util.Collection<java.lang.String> getTypedVariants()
        +
        +
        Specified by:
        +
        getTypedVariants in class StandardNumber
        +
        +
      • +
      + + + + + + + +
        +
      • +

        make

        +
        private void make(java.lang.Object o)
        +
      • +
      + + + +
        +
      • +

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

        Returns a clone if the implementation is cloneable.

        +
        +
        Overrides:
        +
        clone in class StandardNumberSpi
        +
        Returns:
        +
        a clone if the implementation is cloneable.
        +
        Throws:
        +
        java.lang.CloneNotSupportedException - if this is called on an + implementation that does not support Cloneable
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + + + +
+ + + + diff --git a/docs/javadoc/org/xbib/standardnumber/EAN.html b/docs/javadoc/org/xbib/standardnumber/EAN.html new file mode 100644 index 0000000..91dc2c2 --- /dev/null +++ b/docs/javadoc/org/xbib/standardnumber/EAN.html @@ -0,0 +1,633 @@ + + + + + +EAN (standardnumber 1.0.0 API) + + + + + + + +
+ + + + + + + +
+ + + +
+
org.xbib.standardnumber
+

Class EAN

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable, java.lang.Comparable<EAN>
    +
    +
    +
    +
    class EAN
    +extends StandardNumber
    +implements java.lang.Cloneable, java.lang.Comparable<EAN>
    +

    European Article Number is a 13-digit barcoding standard for marking products +sold at retail point of sale.

    +

    Numbers encoded in UPC and EAN barcodes are known as +Global Trade Item Numbers (GTIN).

    +
  • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
      protected EAN() 
      +
    • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      private booleancheck() 
      java.lang.Objectclone() +
      Returns a clone if the implementation is cloneable.
      +
      intcompareTo(EAN ean) 
      EANcreateChecksum(boolean createWithChecksum) +
      Indicate that a correct check sum should be computed.
      +
      private java.lang.Stringdespace(java.lang.String s) 
      booleanequals(java.lang.Object object) 
      java.lang.Stringformat() +
      Return a formatted value of this standard number +This is best for human-readable representation, but is +not necessarily a format for computation.
      +
      java.util.Collection<java.lang.String>getTypedVariants() 
      inthashCode() 
      booleanisValid() +
      Check this number for validity.
      +
      EANnormalize() +
      Normalize the value by removing all unwanted characters or +replacing characters with the ones required for verification.
      +
      java.lang.StringnormalizedValue() +
      Return normalized value of this standard number.
      +
      EANreset() 
      EANverify() +
      Verify the number.
      +
      + + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, toString, wait, wait, wait
      • +
      +
    • +
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        PATTERN

        +
        private static final java.util.regex.Pattern PATTERN
        +
      • +
      + + + +
        +
      • +

        createWithChecksum

        +
        private boolean createWithChecksum
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        EAN

        +
        protected EAN()
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        compareTo

        +
        public int compareTo(EAN ean)
        +
        +
        Specified by:
        +
        compareTo in interface java.lang.Comparable<EAN>
        +
        +
      • +
      + + + +
        +
      • +

        createChecksum

        +
        public EAN createChecksum(boolean createWithChecksum)
        +
        Description copied from class: StandardNumber
        +

        Indicate that a correct check sum should be computed.

        +
        +
        Specified by:
        +
        createChecksum in class StandardNumber
        +
        Parameters:
        +
        createWithChecksum - if checksum is included
        +
        Returns:
        +
        this standard number
        +
        +
      • +
      + + + +
        +
      • +

        normalize

        +
        public EAN 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 EAN verify()
        +
        Description copied from class: StandardNumber
        +

        Verify the number.

        +
        +
        Specified by:
        +
        verify in class StandardNumber
        +
        Returns:
        +
        this standard number if verification was successful
        +
        +
      • +
      + + + +
        +
      • +

        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
        +
        +
      • +
      + + + + + + + +
        +
      • +

        getTypedVariants

        +
        public java.util.Collection<java.lang.String> getTypedVariants()
        +
        +
        Specified by:
        +
        getTypedVariants in class StandardNumber
        +
        +
      • +
      + + + +
        +
      • +

        check

        +
        private boolean check()
        +
      • +
      + + + +
        +
      • +

        despace

        +
        private java.lang.String despace(java.lang.String s)
        +
      • +
      + + + +
        +
      • +

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

        Returns a clone if the implementation is cloneable.

        +
        +
        Overrides:
        +
        clone in class StandardNumberSpi
        +
        Returns:
        +
        a clone if the implementation is cloneable.
        +
        Throws:
        +
        java.lang.CloneNotSupportedException - if this is called on an + implementation that does not support Cloneable
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + + + +
+ + + + diff --git a/docs/javadoc/org/xbib/standardnumber/GTIN.html b/docs/javadoc/org/xbib/standardnumber/GTIN.html new file mode 100644 index 0000000..a9a3e67 --- /dev/null +++ b/docs/javadoc/org/xbib/standardnumber/GTIN.html @@ -0,0 +1,663 @@ + + + + + +GTIN (standardnumber 1.0.0 API) + + + + + + + +
+ + + + + + + +
+ + + +
+
org.xbib.standardnumber
+

Class GTIN

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable, java.lang.Comparable<GTIN>
    +
    +
    +
    +
    class GTIN
    +extends StandardNumber
    +implements java.lang.Cloneable, java.lang.Comparable<GTIN>
    +

    Global Trade Item Number (GTIN).

    +

    GTIN describes a family of GS1 (EAN.UCC) global data structures that employ +14 digits and can be encoded into various types of data carriers.

    +

    Currently, GTIN is used exclusively within bar codes, but it could also be used +in other data carriers such as radio frequency identification (RFID). +The GTIN is only a term and does not impact any existing standards, nor does +it place any additional requirements on scanning hardware.

    +

    For North American companies, the UPC is an existing form of the GTIN.

    +

    Since 2005, EAN International and American UCC merged to GS1 and also +EAN and UPC is now named GTIN.

    +

    The EAN/UCC-13 code is now officially called GTIN-13 (Global Trade Identifier Number). +Former 12-digit UPC codes can be converted into EAN/UCC-13 code by simply +adding a preceeding zero.

    +

    As of January 1, 2007, the former ISBN numbers have been integrated into +the EAN/UCC-13 code. For each old ISBN-10 code, there exists a proper translation +into EAN/UCC-13 by adding "978" as prefix.

    +

    The family of data structures comprising GTIN include

    +
    +
      +
    • +

      GTIN-8 (EAN/UCC-8): this is an 8-digit number

      +
    • +
    • +

      GTIN-12 (UPC-A): this is a 12-digit number

      +
    • +
    • +

      GTIN-13 (EAN/UCC-13): this is a 13-digit number

      +
    • +
    • +

      GTIN-14 (EAN/UCC-14 or ITF-14): this is a 14-digit number

      +
    • +
    +
    +

    See GTIN info

    +
  • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
      protected GTIN() 
      +
    • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      private booleancheck() 
      java.lang.Objectclone() +
      Returns a clone if the implementation is cloneable.
      +
      intcompareTo(GTIN gtin) 
      GTINcreateChecksum(boolean createWithChecksum) +
      Indicate that a correct check sum should be computed.
      +
      private java.lang.Stringdehyphenate(java.lang.String isbn) 
      booleanequals(java.lang.Object object) 
      java.lang.Stringformat() +
      Return a formatted value of this standard number +This is best for human-readable representation, but is +not necessarily a format for computation.
      +
      java.util.Collection<java.lang.String>getTypedVariants() 
      inthashCode() 
      booleanisValid() +
      Check this number for validity.
      +
      GTINnormalize() +
      Normalize the value by removing all unwanted characters or +replacing characters with the ones required for verification.
      +
      java.lang.StringnormalizedValue() +
      Return normalized value of this standard number.
      +
      GTINreset() 
      GTINverify() +
      Verify the number.
      +
      + + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, toString, wait, wait, wait
      • +
      +
    • +
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        PATTERN

        +
        private static final java.util.regex.Pattern PATTERN
        +
      • +
      + + + +
        +
      • +

        createWithChecksum

        +
        private boolean createWithChecksum
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        GTIN

        +
        protected GTIN()
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        compareTo

        +
        public int compareTo(GTIN gtin)
        +
        +
        Specified by:
        +
        compareTo in interface java.lang.Comparable<GTIN>
        +
        +
      • +
      + + + +
        +
      • +

        createChecksum

        +
        public GTIN createChecksum(boolean createWithChecksum)
        +
        Description copied from class: StandardNumber
        +

        Indicate that a correct check sum should be computed.

        +
        +
        Specified by:
        +
        createChecksum in class StandardNumber
        +
        Parameters:
        +
        createWithChecksum - if checksum is included
        +
        Returns:
        +
        this standard number
        +
        +
      • +
      + + + +
        +
      • +

        normalize

        +
        public GTIN 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 GTIN verify()
        +
        Description copied from class: StandardNumber
        +

        Verify the number.

        +
        +
        Specified by:
        +
        verify in class StandardNumber
        +
        Returns:
        +
        this standard number if verification was successful
        +
        +
      • +
      + + + +
        +
      • +

        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
        +
        +
      • +
      + + + + + + + +
        +
      • +

        getTypedVariants

        +
        public java.util.Collection<java.lang.String> getTypedVariants()
        +
        +
        Specified by:
        +
        getTypedVariants in class StandardNumber
        +
        +
      • +
      + + + +
        +
      • +

        check

        +
        private boolean check()
        +
      • +
      + + + +
        +
      • +

        dehyphenate

        +
        private java.lang.String dehyphenate(java.lang.String isbn)
        +
      • +
      + + + +
        +
      • +

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

        Returns a clone if the implementation is cloneable.

        +
        +
        Overrides:
        +
        clone in class StandardNumberSpi
        +
        Returns:
        +
        a clone if the implementation is cloneable.
        +
        Throws:
        +
        java.lang.CloneNotSupportedException - if this is called on an + implementation that does not support Cloneable
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + + + +
+ + + + diff --git a/docs/javadoc/org/xbib/standardnumber/IBAN.html b/docs/javadoc/org/xbib/standardnumber/IBAN.html new file mode 100644 index 0000000..b0a755e --- /dev/null +++ b/docs/javadoc/org/xbib/standardnumber/IBAN.html @@ -0,0 +1,735 @@ + + + + + +IBAN (standardnumber 1.0.0 API) + + + + + + + +
+ + + + + + + +
+ + + +
+
org.xbib.standardnumber
+

Class IBAN

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable, java.lang.Comparable<IBAN>
    +
    +
    +
    +
    class IBAN
    +extends StandardNumber
    +implements java.lang.Cloneable, java.lang.Comparable<IBAN>
    +

    ISO 13616 International Bank Account Number (IBAN).

    +

    The International Bank Account Number (IBAN) is an internationally agreed means of +identifying bank accounts across national borders with a reduced risk of transcription +errors. It was originally adopted by the European Committee for Banking Standards (ECBS) +and later as an international standard under ISO 13616:1997. The current standard +is ISO 13616:2007, which indicates SWIFT as the formal registrar.

    +

    Checksum calculation is in accordance to ISO 7064 MOD-97.

    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private static MOD9710check 
      private java.lang.Stringcountry 
      private static java.lang.String[]COUNTRY_CODES +
      Known country codes, this list must be sorted to allow binary search.
      +
      private static int[]COUNTRY_IBAN_LENGTHS +
      Lengths for each country’s IBAN.
      +
      private booleancreateWithChecksum 
      private java.lang.Stringformatted 
      private static java.util.regex.PatternPATTERN +
      Norway = 15, Malta = 31 + "IBAN ".
      +
      + +
    • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
      protected IBAN() 
      +
    • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      private booleancheck() 
      java.lang.Objectclone() +
      Returns a clone if the implementation is cloneable.
      +
      intcompareTo(IBAN iban) 
      IBANcreateChecksum(boolean createWithChecksum) +
      Indicate that a correct check sum should be computed.
      +
      booleanequals(java.lang.Object object) 
      java.lang.Stringformat() +
      Return a formatted value of this standard number +This is best for human-readable representation, but is +not necessarily a format for computation.
      +
      private intgetLengthForCountryCode(java.lang.String countryCode) +
      Returns the IBAN length for a given country code.
      +
      java.util.Collection<java.lang.String>getTypedVariants() 
      inthashCode() 
      booleanisValid() +
      Check this number for validity.
      +
      IBANnormalize() +
      Normalize the value by removing all unwanted characters or +replacing characters with the ones required for verification.
      +
      java.lang.StringnormalizedValue() +
      Return normalized value of this standard number.
      +
      private java.lang.Stringparse(java.lang.String raw) 
      IBANreset() 
      IBANverify() +
      Verify the number.
      +
      + + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, toString, wait, wait, wait
      • +
      +
    • +
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        PATTERN

        +
        private static final java.util.regex.Pattern PATTERN
        +

        Norway = 15, Malta = 31 + "IBAN ".

        +
      • +
      + + + +
        +
      • +

        check

        +
        private static final MOD9710 check
        +
      • +
      + + + +
        +
      • +

        COUNTRY_CODES

        +
        private static final java.lang.String[] COUNTRY_CODES
        +

        Known country codes, this list must be sorted to allow binary search.

        +
      • +
      + + + +
        +
      • +

        COUNTRY_IBAN_LENGTHS

        +
        private static final int[] COUNTRY_IBAN_LENGTHS
        +

        Lengths for each country’s IBAN. The indices match the indices of COUNTRY_CODES, the values are the +expected length.

        +
      • +
      + + + +
        +
      • +

        formatted

        +
        private java.lang.String formatted
        +
      • +
      + + + +
        +
      • +

        country

        +
        private java.lang.String country
        +
      • +
      + + + +
        +
      • +

        createWithChecksum

        +
        private boolean createWithChecksum
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        IBAN

        +
        protected IBAN()
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        compareTo

        +
        public int compareTo(IBAN iban)
        +
        +
        Specified by:
        +
        compareTo in interface java.lang.Comparable<IBAN>
        +
        +
      • +
      + + + +
        +
      • +

        createChecksum

        +
        public IBAN createChecksum(boolean createWithChecksum)
        +
        Description copied from class: StandardNumber
        +

        Indicate that a correct check sum should be computed.

        +
        +
        Specified by:
        +
        createChecksum in class StandardNumber
        +
        Parameters:
        +
        createWithChecksum - if checksum is included
        +
        Returns:
        +
        this standard number
        +
        +
      • +
      + + + +
        +
      • +

        normalize

        +
        public IBAN 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 IBAN verify()
        +
        Description copied from class: StandardNumber
        +

        Verify the number.

        +
        +
        Specified by:
        +
        verify in class StandardNumber
        +
        Returns:
        +
        this standard number if verification was successful
        +
        +
      • +
      + + + +
        +
      • +

        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
        +
        +
      • +
      + + + + + + + +
        +
      • +

        getTypedVariants

        +
        public java.util.Collection<java.lang.String> getTypedVariants()
        +
        +
        Specified by:
        +
        getTypedVariants in class StandardNumber
        +
        +
      • +
      + + + +
        +
      • +

        check

        +
        private boolean check()
        +
      • +
      + + + +
        +
      • +

        parse

        +
        private java.lang.String parse(java.lang.String raw)
        +
      • +
      + + + +
        +
      • +

        getLengthForCountryCode

        +
        private int getLengthForCountryCode(java.lang.String countryCode)
        +

        Returns the IBAN length for a given country code.

        +
        +
        Parameters:
        +
        countryCode - a non-null, uppercase, two-character country code.
        +
        Returns:
        +
        the IBAN length for the given country, or -1 if the input is not a known, two-character country code.
        +
        Throws:
        +
        java.lang.NullPointerException - if the input is null.
        +
        +
      • +
      + + + +
        +
      • +

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

        Returns a clone if the implementation is cloneable.

        +
        +
        Overrides:
        +
        clone in class StandardNumberSpi
        +
        Returns:
        +
        a clone if the implementation is cloneable.
        +
        Throws:
        +
        java.lang.CloneNotSupportedException - if this is called on an + implementation that does not support Cloneable
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + + + +
+ + + + diff --git a/docs/javadoc/org/xbib/standardnumber/ISAN.html b/docs/javadoc/org/xbib/standardnumber/ISAN.html new file mode 100644 index 0000000..a47cb91 --- /dev/null +++ b/docs/javadoc/org/xbib/standardnumber/ISAN.html @@ -0,0 +1,686 @@ + + + + + +ISAN (standardnumber 1.0.0 API) + + + + + + + +
+ + + + + + + +
+ + + +
+
org.xbib.standardnumber
+

Class ISAN

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable, java.lang.Comparable<ISAN>
    +
    +
    +
    +
    class ISAN
    +extends StandardNumber
    +implements java.lang.Cloneable, java.lang.Comparable<ISAN>
    +

    ISO 15706 International Standard Audiovisual Number (ISAN).

    +

    The International Standard Audiovisual Number (ISAN) is a unique identifier for +audiovisual works and related versions, similar to ISBN for books.

    +

    It was developed within an ISO (International Organisation for Standardisation) TC46/SC9 +working group. ISAN is managed and run by ISAN-IA.

    +

    The ISAN standard (ISO standard 15706:2002 and ISO 15706-2) is recommended or required +as the audiovisual identifier of choice for producers, studios, broadcasters, +Internet media providers and video games publishers who need to encode, track, and +distribute video in a variety of formats.

    +

    It provides a unique, internationally recognized and permanent reference number for each +audiovisual work and related versions registered in the ISAN system.

    +

    ISAN identifies works throughout their entire life cycle from conception, to production, +to distribution and consumption.

    +

    ISANs can be incorporated in both digital and physical media, such as theatrical +release prints, DVDs, publications, advertising, marketing materials and packaging, +as well as licensing contracts to uniquely identify works.

    +

    The ISAN identifier is incorporated in many draft and final standards such as +AACS, DCI, MPEG, DVB, and ATSC.

    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private static MOD3736check 
      private java.lang.Stringformatted 
      private static java.util.regex.PatternPATTERN 
      private booleanversioned 
      + +
    • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
      protected ISAN() 
      +
    • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      private booleancheck() 
      private java.lang.Stringclean(java.lang.String value) 
      java.lang.Objectclone() +
      Returns a clone if the implementation is cloneable.
      +
      intcompareTo(ISAN isan) 
      ISANcreateChecksum(boolean createWithChecksum) +
      Indicate that a correct check sum should be computed.
      +
      booleanequals(java.lang.Object object) 
      java.lang.Stringformat() +
      Return a formatted value of this standard number +This is best for human-readable representation, but is +not necessarily a format for computation.
      +
      java.util.Collection<java.lang.String>getTypedVariants() 
      inthashCode() 
      booleanisValid() +
      Check this number for validity.
      +
      ISANnormalize() +
      Normalize the value by removing all unwanted characters or +replacing characters with the ones required for verification.
      +
      java.lang.StringnormalizedValue() +
      Return normalized value of this standard number.
      +
      ISANreset() 
      ISANverify() +
      Verify the number.
      +
      ISANversioned() 
      + + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, toString, wait, wait, wait
      • +
      +
    • +
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        PATTERN

        +
        private static final java.util.regex.Pattern PATTERN
        +
      • +
      + + + +
        +
      • +

        check

        +
        private static final MOD3736 check
        +
      • +
      + + + +
        +
      • +

        formatted

        +
        private java.lang.String formatted
        +
      • +
      + + + +
        +
      • +

        versioned

        +
        private boolean versioned
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ISAN

        +
        protected ISAN()
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        compareTo

        +
        public int compareTo(ISAN isan)
        +
        +
        Specified by:
        +
        compareTo in interface java.lang.Comparable<ISAN>
        +
        +
      • +
      + + + +
        +
      • +

        createChecksum

        +
        public ISAN createChecksum(boolean createWithChecksum)
        +
        Description copied from class: StandardNumber
        +

        Indicate that a correct check sum should be computed.

        +
        +
        Specified by:
        +
        createChecksum in class StandardNumber
        +
        Parameters:
        +
        createWithChecksum - if checksum is included
        +
        Returns:
        +
        this standard number
        +
        +
      • +
      + + + +
        +
      • +

        normalize

        +
        public ISAN 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 ISAN verify()
        +
        Description copied from class: StandardNumber
        +

        Verify the number.

        +
        +
        Specified by:
        +
        verify in class StandardNumber
        +
        Returns:
        +
        this standard number if verification was successful
        +
        +
      • +
      + + + +
        +
      • +

        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
        +
        +
      • +
      + + + +
        +
      • +

        versioned

        +
        public ISAN versioned()
        +
      • +
      + + + + + + + +
        +
      • +

        getTypedVariants

        +
        public java.util.Collection<java.lang.String> getTypedVariants()
        +
        +
        Specified by:
        +
        getTypedVariants in class StandardNumber
        +
        +
      • +
      + + + +
        +
      • +

        check

        +
        private boolean check()
        +
      • +
      + + + +
        +
      • +

        clean

        +
        private java.lang.String clean(java.lang.String value)
        +
      • +
      + + + +
        +
      • +

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

        Returns a clone if the implementation is cloneable.

        +
        +
        Overrides:
        +
        clone in class StandardNumberSpi
        +
        Returns:
        +
        a clone if the implementation is cloneable.
        +
        Throws:
        +
        java.lang.CloneNotSupportedException - if this is called on an + implementation that does not support Cloneable
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + + + +
+ + + + diff --git a/docs/javadoc/org/xbib/standardnumber/ISBN.ISBNRangeMessageConfigurator.html b/docs/javadoc/org/xbib/standardnumber/ISBN.ISBNRangeMessageConfigurator.html new file mode 100644 index 0000000..452141c --- /dev/null +++ b/docs/javadoc/org/xbib/standardnumber/ISBN.ISBNRangeMessageConfigurator.html @@ -0,0 +1,399 @@ + + + + + +ISBN.ISBNRangeMessageConfigurator (standardnumber 1.0.0 API) + + + + + + + +
+ + + + + + + +
+ + + +
+
org.xbib.standardnumber
+

Class ISBN.ISBNRangeMessageConfigurator

+
+
+ +
+
    +
  • +
    +
    Enclosing class:
    +
    ISBN
    +
    +
    +
    +
    private static final class ISBN.ISBNRangeMessageConfigurator
    +extends java.lang.Object
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private java.util.Deque<java.lang.StringBuilder>content 
      private intlength 
      private java.lang.Stringprefix 
      private java.lang.StringrangeBegin 
      private java.lang.StringrangeEnd 
      private java.util.List<java.lang.String>ranges 
      private booleanvalid 
      +
    • +
    + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      (package private) java.util.List<java.lang.String>getRanges() 
      private voidprocessEvent(javax.xml.stream.events.XMLEvent e) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        content

        +
        private final java.util.Deque<java.lang.StringBuilder> content
        +
      • +
      + + + +
        +
      • +

        ranges

        +
        private final java.util.List<java.lang.String> ranges
        +
      • +
      + + + +
        +
      • +

        prefix

        +
        private java.lang.String prefix
        +
      • +
      + + + +
        +
      • +

        rangeBegin

        +
        private java.lang.String rangeBegin
        +
      • +
      + + + +
        +
      • +

        rangeEnd

        +
        private java.lang.String rangeEnd
        +
      • +
      + + + +
        +
      • +

        length

        +
        private int length
        +
      • +
      + + + +
        +
      • +

        valid

        +
        private boolean valid
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ISBNRangeMessageConfigurator

        +
        public ISBNRangeMessageConfigurator()
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        processEvent

        +
        private void processEvent(javax.xml.stream.events.XMLEvent e)
        +
      • +
      + + + +
        +
      • +

        getRanges

        +
        java.util.List<java.lang.String> getRanges()
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + + + +
+ + + + diff --git a/docs/javadoc/org/xbib/standardnumber/ISBN.html b/docs/javadoc/org/xbib/standardnumber/ISBN.html new file mode 100644 index 0000000..d9108dd --- /dev/null +++ b/docs/javadoc/org/xbib/standardnumber/ISBN.html @@ -0,0 +1,874 @@ + + + + + +ISBN (standardnumber 1.0.0 API) + + + + + + + +
+ + + + + + + +
+ + + +
+
org.xbib.standardnumber
+

Class ISBN

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable, java.lang.Comparable<ISBN>
    +
    +
    +
    +
    class ISBN
    +extends StandardNumber
    +implements java.lang.Cloneable, java.lang.Comparable<ISBN>
    +

    ISO 2108 International Standard Book Number (ISBN), Z39.50 BIB-1 Use Attribute 7.

    +

    The International Standard Book Number is a 13-digit number +that uniquely identifies books and book-like products published +internationally.

    +

    The purpose of the ISBN is to establish and identify one title or +edition of a title from one specific publisher +and is unique to that edition, allowing for more efficient marketing of products by booksellers, +libraries, universities, wholesalers and distributors.

    +

    Every ISBN consists of thirteen digits and whenever it is printed it is preceded by the letters ISBN. +The thirteen-digit number is divided into four parts of variable length, each part separated by a hyphen.

    +

    This class is based upon the ISBN converter and formatter class by +Openly Informatics, Inc.

    +

    See The ISBN Users' Manual, +The IETF URN Charter, +The IANA URN assignments, +ISBN prefix generation

    +
  • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private booleancreateWithChecksum 
      private booleaneanPreferred 
      private java.lang.Stringeanvalue 
      private booleanisEAN 
      private static java.util.regex.PatternPATTERN 
      private static java.util.List<java.lang.String>ranges 
      private booleanvalid 
      + +
    • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
      protected ISBN() 
      +
    • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      private booleancheck() 
      java.lang.Objectclone() +
      Returns a clone if the implementation is cloneable.
      +
      intcompareTo(ISBN isbn) 
      private charcreateCheckDigit10(java.lang.String value) +
      Returns a ISBN check digit for the first 9 digits in a string.
      +
      private charcreateCheckDigit13(java.lang.String value) +
      Returns an ISBN check digit for the first 12 digits in a string.
      +
      ISBNcreateChecksum(boolean createWithChecksum) +
      Indicate that a correct check sum should be computed.
      +
      private java.lang.Stringdehyphenate(java.lang.String isbn) 
      ISBNean(boolean eanPreferred) +
      Prefer European Article Number (EAN, ISBN-13).
      +
      booleanequals(java.lang.Object object) 
      private java.lang.Stringfix(java.lang.String isbn) 
      java.lang.Stringformat() +
      Get printable representation of this standard book number.
      +
      java.lang.StringgetCountryAndPublisherCode() +
      Get country and publisher code.
      +
      java.util.Collection<java.lang.String>getTypedVariants() 
      inthashCode() 
      private java.lang.Stringhyphenate(java.lang.String pref, + java.lang.String s) 
      booleanisEAN() 
      private intisInRange(java.lang.String isbn, + java.lang.String begin, + java.lang.String end) +
      Check if ISBN is within a given value range.
      +
      booleanisValid() +
      Check for this ISBN number validity.
      +
      ISBNnormalize() +
      Normalize the value by removing all unwanted characters or +replacing characters with the ones required for verification.
      +
      java.lang.StringnormalizedValue() +
      Get the normalized value of this standard book number.
      +
      ISBNreset() 
      ISBNverify() +
      Verify the number.
      +
      + + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, toString, wait, wait, wait
      • +
      +
    • +
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        PATTERN

        +
        private static final java.util.regex.Pattern PATTERN
        +
      • +
      + + + +
        +
      • +

        ranges

        +
        private static final java.util.List<java.lang.String> ranges
        +
      • +
      + + + +
        +
      • +

        createWithChecksum

        +
        private boolean createWithChecksum
        +
      • +
      + + + +
        +
      • +

        eanvalue

        +
        private java.lang.String eanvalue
        +
      • +
      + + + +
        +
      • +

        eanPreferred

        +
        private boolean eanPreferred
        +
      • +
      + + + +
        +
      • +

        valid

        +
        private boolean valid
        +
      • +
      + + + +
        +
      • +

        isEAN

        +
        private boolean isEAN
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ISBN

        +
        protected ISBN()
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        createChecksum

        +
        public ISBN createChecksum(boolean createWithChecksum)
        +
        Description copied from class: StandardNumber
        +

        Indicate that a correct check sum should be computed.

        +
        +
        Specified by:
        +
        createChecksum in class StandardNumber
        +
        Parameters:
        +
        createWithChecksum - if checksum is included
        +
        Returns:
        +
        this standard number
        +
        +
      • +
      + + + +
        +
      • +

        compareTo

        +
        public int compareTo(ISBN isbn)
        +
        +
        Specified by:
        +
        compareTo in interface java.lang.Comparable<ISBN>
        +
        +
      • +
      + + + +
        +
      • +

        normalize

        +
        public ISBN 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()
        +

        Check for this ISBN number validity.

        +
        +
        Specified by:
        +
        isValid in class StandardNumber
        +
        Returns:
        +
        true if valid, false otherwise
        +
        +
      • +
      + + + +
        +
      • +

        verify

        +
        public ISBN verify()
        +
        Description copied from class: StandardNumber
        +

        Verify the number.

        +
        +
        Specified by:
        +
        verify in class StandardNumber
        +
        Returns:
        +
        this standard number if verification was successful
        +
        +
      • +
      + + + +
        +
      • +

        normalizedValue

        +
        public java.lang.String normalizedValue()
        +

        Get the normalized value of this standard book number.

        +
        +
        Specified by:
        +
        normalizedValue in class StandardNumber
        +
        Returns:
        +
        the value of this standard book number
        +
        +
      • +
      + + + +
        +
      • +

        format

        +
        public java.lang.String format()
        +

        Get printable representation of this standard book number.

        +
        +
        Specified by:
        +
        format in class StandardNumber
        +
        Returns:
        +
        ISBN-13, with (fixed) check digit
        +
        +
      • +
      + + + + + + + +
        +
      • +

        getTypedVariants

        +
        public java.util.Collection<java.lang.String> getTypedVariants()
        +
        +
        Specified by:
        +
        getTypedVariants in class StandardNumber
        +
        +
      • +
      + + + +
        +
      • +

        isEAN

        +
        public boolean isEAN()
        +
      • +
      + + + +
        +
      • +

        ean

        +
        public ISBN ean(boolean eanPreferred)
        +

        Prefer European Article Number (EAN, ISBN-13).

        +
        +
        Parameters:
        +
        eanPreferred - true if EAN should be preferred
        +
        Returns:
        +
        this ISBN object
        +
        +
      • +
      + + + +
        +
      • +

        getCountryAndPublisherCode

        +
        public java.lang.String getCountryAndPublisherCode()
        +

        Get country and publisher code.

        +
        +
        Returns:
        +
        the country/publisher code from ISBN
        +
        +
      • +
      + + + +
        +
      • +

        hyphenate

        +
        private java.lang.String hyphenate(java.lang.String pref,
        +                                   java.lang.String s)
        +
      • +
      + + + +
        +
      • +

        check

        +
        private boolean check()
        +
      • +
      + + + +
        +
      • +

        createCheckDigit10

        +
        private char createCheckDigit10(java.lang.String value)
        +

        Returns a ISBN check digit for the first 9 digits in a string.

        +
        +
        Parameters:
        +
        value - the value
        +
        Returns:
        +
        check digit
        +
        +
      • +
      + + + +
        +
      • +

        createCheckDigit13

        +
        private char createCheckDigit13(java.lang.String value)
        +

        Returns an ISBN check digit for the first 12 digits in a string.

        +
        +
        Parameters:
        +
        value - the value
        +
        Returns:
        +
        check digit
        +
        +
      • +
      + + + +
        +
      • +

        fix

        +
        private java.lang.String fix(java.lang.String isbn)
        +
      • +
      + + + +
        +
      • +

        isInRange

        +
        private int isInRange(java.lang.String isbn,
        +                      java.lang.String begin,
        +                      java.lang.String end)
        +

        Check if ISBN is within a given value range.

        +
        +
        Parameters:
        +
        isbn - ISBN to check
        +
        begin - lower ISBN
        +
        end - higher ISBN
        +
        Returns:
        +
        -1 if too low, 1 if too high, 0 if range matches
        +
        +
      • +
      + + + +
        +
      • +

        dehyphenate

        +
        private java.lang.String dehyphenate(java.lang.String isbn)
        +
      • +
      + + + +
        +
      • +

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

        Returns a clone if the implementation is cloneable.

        +
        +
        Overrides:
        +
        clone in class StandardNumberSpi
        +
        Returns:
        +
        a clone if the implementation is cloneable.
        +
        Throws:
        +
        java.lang.CloneNotSupportedException - if this is called on an + implementation that does not support Cloneable
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + + + +
+ + + + diff --git a/docs/javadoc/org/xbib/standardnumber/ISMN.html b/docs/javadoc/org/xbib/standardnumber/ISMN.html new file mode 100644 index 0000000..fdf8ded --- /dev/null +++ b/docs/javadoc/org/xbib/standardnumber/ISMN.html @@ -0,0 +1,660 @@ + + + + + +ISMN (standardnumber 1.0.0 API) + + + + + + + +
+ + + + + + + +
+ + + +
+
org.xbib.standardnumber
+

Class ISMN

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable, java.lang.Comparable<ISMN>
    +
    +
    +
    +
    class ISMN
    +extends StandardNumber
    +implements java.lang.Cloneable, java.lang.Comparable<ISMN>
    +

    ISO 10957 International Standard Music Number (ISMN), Z39.50 BIB-1 Use Attribute 1092.

    +

    The International Standard Music Number (ISMN) is a thirteen-character alphanumeric identifier +for printed music developed by ISO. The original proposal for an ISMN was made by the +UK Branch of IAML (International Association of Music Libraries, Archives and Documentation +Centres).

    +

    The original format comprised four elements: a distinguishing prefix M, a publisher ID, +an item ID and a check digit, typically looking like M-2306-7118-7.

    +

    From 1 January 2008 the ISMN was defined as a thirteen digit identifier beginning 979-0 where +the zero replaced M in the old-style number. The resulting number is identical with its +EAN-13 number as encoded in the item’s barcode.

    +

    See ISMN Manual 2008

    +
  • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
      protected ISMN() 
      +
    • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      private booleancheck() 
      java.lang.Objectclone() +
      Returns a clone if the implementation is cloneable.
      +
      intcompareTo(ISMN ismn) 
      ISMNcreateChecksum(boolean createWithChecksum) +
      Indicate that a correct check sum should be computed.
      +
      private java.lang.Stringdehyphenate(java.lang.String isbn) 
      booleanequals(java.lang.Object object) 
      java.lang.Stringformat() +
      Return a formatted value of this standard number +This is best for human-readable representation, but is +not necessarily a format for computation.
      +
      java.util.Collection<java.lang.String>getTypedVariants() 
      inthashCode() 
      booleanisValid() +
      Check this number for validity.
      +
      ISMNnormalize() +
      Normalize the value by removing all unwanted characters or +replacing characters with the ones required for verification.
      +
      java.lang.StringnormalizedValue() +
      Return normalized value of this standard number.
      +
      ISMNreset() 
      GTINtoGTIN() 
      ISMNverify() +
      Verify the number.
      +
      + + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, toString, wait, wait, wait
      • +
      +
    • +
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        PATTERN

        +
        private static final java.util.regex.Pattern PATTERN
        +
      • +
      + + + +
        +
      • +

        createWithChecksum

        +
        private boolean createWithChecksum
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ISMN

        +
        protected ISMN()
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        compareTo

        +
        public int compareTo(ISMN ismn)
        +
        +
        Specified by:
        +
        compareTo in interface java.lang.Comparable<ISMN>
        +
        +
      • +
      + + + +
        +
      • +

        createChecksum

        +
        public ISMN createChecksum(boolean createWithChecksum)
        +
        Description copied from class: StandardNumber
        +

        Indicate that a correct check sum should be computed.

        +
        +
        Specified by:
        +
        createChecksum in class StandardNumber
        +
        Parameters:
        +
        createWithChecksum - if checksum is included
        +
        Returns:
        +
        this standard number
        +
        +
      • +
      + + + +
        +
      • +

        normalize

        +
        public ISMN 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 ISMN verify()
        +
        Description copied from class: StandardNumber
        +

        Verify the number.

        +
        +
        Specified by:
        +
        verify in class StandardNumber
        +
        Returns:
        +
        this standard number if verification was successful
        +
        +
      • +
      + + + +
        +
      • +

        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
        +
        +
      • +
      + + + + + + + +
        +
      • +

        getTypedVariants

        +
        public java.util.Collection<java.lang.String> getTypedVariants()
        +
        +
        Specified by:
        +
        getTypedVariants in class StandardNumber
        +
        +
      • +
      + + + + + + + +
        +
      • +

        check

        +
        private boolean check()
        +
      • +
      + + + +
        +
      • +

        dehyphenate

        +
        private java.lang.String dehyphenate(java.lang.String isbn)
        +
      • +
      + + + +
        +
      • +

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

        Returns a clone if the implementation is cloneable.

        +
        +
        Overrides:
        +
        clone in class StandardNumberSpi
        +
        Returns:
        +
        a clone if the implementation is cloneable.
        +
        Throws:
        +
        java.lang.CloneNotSupportedException - if this is called on an + implementation that does not support Cloneable
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + + + +
+ + + + diff --git a/docs/javadoc/org/xbib/standardnumber/ISNI.html b/docs/javadoc/org/xbib/standardnumber/ISNI.html new file mode 100644 index 0000000..1746aab --- /dev/null +++ b/docs/javadoc/org/xbib/standardnumber/ISNI.html @@ -0,0 +1,669 @@ + + + + + +ISNI (standardnumber 1.0.0 API) + + + + + + + +
+ + + + + + + +
+ + + +
+
org.xbib.standardnumber
+

Class ISNI

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable, java.lang.Comparable<ISNI>
    +
    +
    +
    Direct Known Subclasses:
    +
    ORCID
    +
    +
    +
    +
    class ISNI
    +extends StandardNumber
    +implements java.lang.Cloneable, java.lang.Comparable<ISNI>
    +

    ISO 27729 International Standard Name Identifier (ISNI).

    +

    The International Standard Name Identifier (ISNI) is a method for uniquely identifying +the public identities of contributors to media content such as books, TV programmes, +and newspaper articles. Such an identifier consists of 16 numerical digits divided +into four blocks.

    +

    Checksum calculation is in accordance to ISO/IEC 7064:2003, MOD 11-2

    +
  • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
      protected ISNI() 
      protected ISNI(java.lang.String type) 
      +
    • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      private booleancheck() 
      private java.lang.Stringclean(java.lang.String isbn) 
      java.lang.Objectclone() +
      Returns a clone if the implementation is cloneable.
      +
      intcompareTo(ISNI isni) 
      ISNIcreateChecksum(boolean createWithChecksum) +
      Indicate that a correct check sum should be computed.
      +
      booleanequals(java.lang.Object object) 
      java.lang.Stringformat() +
      Format this number.
      +
      java.util.Collection<java.lang.String>getTypedVariants() 
      inthashCode() 
      booleanisValid() +
      Check this number for validity.
      +
      ISNInormalize() +
      Normalize the value by removing all unwanted characters or +replacing characters with the ones required for verification.
      +
      java.lang.StringnormalizedValue() +
      Returns the value representation of the standard number.
      +
      ISNIreset() 
      ISNIverify() +
      Verify the number.
      +
      + + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, toString, wait, wait, wait
      • +
      +
    • +
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        PATTERN

        +
        private static final java.util.regex.Pattern PATTERN
        +
      • +
      + + + +
        +
      • +

        check

        +
        private static final MOD112 check
        +
      • +
      + + + +
        +
      • +

        formatted

        +
        private java.lang.String formatted
        +
      • +
      + + + +
        +
      • +

        createWithChecksum

        +
        private boolean createWithChecksum
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ISNI

        +
        protected ISNI()
        +
      • +
      + + + +
        +
      • +

        ISNI

        +
        protected ISNI(java.lang.String type)
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        createChecksum

        +
        public ISNI createChecksum(boolean createWithChecksum)
        +
        Description copied from class: StandardNumber
        +

        Indicate that a correct check sum should be computed.

        +
        +
        Specified by:
        +
        createChecksum in class StandardNumber
        +
        Parameters:
        +
        createWithChecksum - if checksum is included
        +
        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 ISNI verify()
        +
        Description copied from class: StandardNumber
        +

        Verify the number.

        +
        +
        Specified by:
        +
        verify in class StandardNumber
        +
        Returns:
        +
        this standard number if verification was successful
        +
        +
      • +
      + + + +
        +
      • +

        normalizedValue

        +
        public java.lang.String normalizedValue()
        +

        Returns the value representation of the standard number.

        +
        +
        Specified by:
        +
        normalizedValue in class StandardNumber
        +
        Returns:
        +
        value
        +
        +
      • +
      + + + +
        +
      • +

        format

        +
        public java.lang.String format()
        +

        Format this number.

        +
        +
        Specified by:
        +
        format in class StandardNumber
        +
        Returns:
        +
        the formatted number
        +
        +
      • +
      + + + +
        +
      • +

        normalize

        +
        public ISNI 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
        +
        +
      • +
      + + + + + + + +
        +
      • +

        getTypedVariants

        +
        public java.util.Collection<java.lang.String> getTypedVariants()
        +
        +
        Specified by:
        +
        getTypedVariants in class StandardNumber
        +
        +
      • +
      + + + +
        +
      • +

        check

        +
        private boolean check()
        +
      • +
      + + + +
        +
      • +

        clean

        +
        private java.lang.String clean(java.lang.String isbn)
        +
      • +
      + + + +
        +
      • +

        compareTo

        +
        public int compareTo(ISNI isni)
        +
        +
        Specified by:
        +
        compareTo in interface java.lang.Comparable<ISNI>
        +
        +
      • +
      + + + +
        +
      • +

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

        Returns a clone if the implementation is cloneable.

        +
        +
        Overrides:
        +
        clone in class StandardNumberSpi
        +
        Returns:
        +
        a clone if the implementation is cloneable.
        +
        Throws:
        +
        java.lang.CloneNotSupportedException - if this is called on an + implementation that does not support Cloneable
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + + + +
+ + + + diff --git a/docs/javadoc/org/xbib/standardnumber/ISSN.html b/docs/javadoc/org/xbib/standardnumber/ISSN.html new file mode 100644 index 0000000..5de394e --- /dev/null +++ b/docs/javadoc/org/xbib/standardnumber/ISSN.html @@ -0,0 +1,711 @@ + + + + + +ISSN (standardnumber 1.0.0 API) + + + + + + + +
+ + + + + + + +
+ + + +
+
org.xbib.standardnumber
+

Class ISSN

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable, java.lang.Comparable<ISSN>
    +
    +
    +
    +
    class ISSN
    +extends StandardNumber
    +implements java.lang.Cloneable, java.lang.Comparable<ISSN>
    +

    ISO 3297 International Standard Serial Number (ISSN), Z39.50 BIB-1 Use Attribute 8.

    +

    The International Standard Serial Number (ISSN) is a unique +eight-digit number used to identify a print or electronic periodical +publication. The ISSN system was adopted as international standard +ISO 3297 in 1975. The ISO subcommittee TC 46/SC 9 is responsible +for the standard.

    +

    Quoted from "All about ISSN":

    +

    The ISSN (International Standard Serial Number) is an eight-digit number +which identifies periodical publications as such, including electronic +serials.

    +

    The ISSN is a numeric code which is used as an identifier: it has no +signification in itself and does not contain in itself any information +referring to the origin or contents of the publication.

    +

    The ISSN takes the form of the acronym ISSN followed by two groups +of four digits, separated by a hyphen. The eighth character is a +control digit calculated according to a modulo 11 algorithm on +the basis of the 7 preceding digits; this eighth control character +may be an "X" if the result of the computing is equal to "10", +in order to avoid any ambiguity.

    +

    The ISSN is linked to a standardized form of the title of the +identified serial, known as the "key title", which repeats +the title of the publication, qualifying it with additional elements +in order to distinguish it from other publications having identical +titles.

    +

    If the title of the publication changes in any significant way, +a new ISSN must be assigned in order to correspond to this new form +of title and avoid any confusion. A serial publication whose +title is modified several times in the course of its existence +will be assigned each time a new ISSN, thus allowing precise +identification of each form of the title : in fact it is then +considered that they are different publications even if there +is a logical link between them.

    +

    Contrary to other types of publications, the world of serial +publications is particularly changeable and complex : +the lifetime of a title may be extremely short; many publications +may be part of a complex set of relationships, etc. +These particularities themselves necessitated the introduction +of the ISSN.

    +
  • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
      protected ISSN() 
      +
    • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      private booleancheck() 
      java.lang.Objectclone() +
      Returns a clone if the implementation is cloneable.
      +
      intcompareTo(ISSN issn) 
      ISSNcreateChecksum(boolean createWithChecksum) +
      Indicate that a correct check sum should be computed.
      +
      private java.lang.Stringdehyphenate(java.lang.String isbn) 
      booleanequals(java.lang.Object object) 
      java.lang.Stringformat() +
      Format this number.
      +
      java.util.Collection<java.lang.String>getTypedVariants() 
      inthashCode() 
      booleanisValid() +
      Check this number for validity.
      +
      ISSNnormalize() +
      Normalize the value by removing all unwanted characters or +replacing characters with the ones required for verification.
      +
      java.lang.StringnormalizedValue() +
      Returns the value representation of the standard number.
      +
      ISSNreset() 
      GTINtoGTIN() 
      GTINtoGTIN(java.lang.String additionalCode) 
      ISSNverify() +
      Verify the number.
      +
      + + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, toString, wait, wait, wait
      • +
      +
    • +
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        PATTERN

        +
        private static final java.util.regex.Pattern PATTERN
        +
      • +
      + + + +
        +
      • +

        formatted

        +
        private java.lang.String formatted
        +
      • +
      + + + +
        +
      • +

        createWithChecksum

        +
        private boolean createWithChecksum
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ISSN

        +
        protected ISSN()
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        compareTo

        +
        public int compareTo(ISSN issn)
        +
        +
        Specified by:
        +
        compareTo in interface java.lang.Comparable<ISSN>
        +
        +
      • +
      + + + +
        +
      • +

        createChecksum

        +
        public ISSN createChecksum(boolean createWithChecksum)
        +
        Description copied from class: StandardNumber
        +

        Indicate that a correct check sum should be computed.

        +
        +
        Specified by:
        +
        createChecksum in class StandardNumber
        +
        Parameters:
        +
        createWithChecksum - if checksum is included
        +
        Returns:
        +
        this standard number
        +
        +
      • +
      + + + +
        +
      • +

        normalize

        +
        public ISSN 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 ISSN verify()
        +
        Description copied from class: StandardNumber
        +

        Verify the number.

        +
        +
        Specified by:
        +
        verify in class StandardNumber
        +
        Returns:
        +
        this standard number if verification was successful
        +
        +
      • +
      + + + +
        +
      • +

        normalizedValue

        +
        public java.lang.String normalizedValue()
        +

        Returns the value representation of the standard number.

        +
        +
        Specified by:
        +
        normalizedValue in class StandardNumber
        +
        Returns:
        +
        value
        +
        +
      • +
      + + + +
        +
      • +

        format

        +
        public java.lang.String format()
        +

        Format this number.

        +
        +
        Specified by:
        +
        format in class StandardNumber
        +
        Returns:
        +
        the formatted number
        +
        +
      • +
      + + + + + + + +
        +
      • +

        getTypedVariants

        +
        public java.util.Collection<java.lang.String> getTypedVariants()
        +
        +
        Specified by:
        +
        getTypedVariants in class StandardNumber
        +
        +
      • +
      + + + + + + + + + + + +
        +
      • +

        check

        +
        private boolean check()
        +
      • +
      + + + +
        +
      • +

        dehyphenate

        +
        private java.lang.String dehyphenate(java.lang.String isbn)
        +
      • +
      + + + +
        +
      • +

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

        Returns a clone if the implementation is cloneable.

        +
        +
        Overrides:
        +
        clone in class StandardNumberSpi
        +
        Returns:
        +
        a clone if the implementation is cloneable.
        +
        Throws:
        +
        java.lang.CloneNotSupportedException - if this is called on an + implementation that does not support Cloneable
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + + + +
+ + + + diff --git a/docs/javadoc/org/xbib/standardnumber/ISTC.html b/docs/javadoc/org/xbib/standardnumber/ISTC.html new file mode 100644 index 0000000..10cabe4 --- /dev/null +++ b/docs/javadoc/org/xbib/standardnumber/ISTC.html @@ -0,0 +1,655 @@ + + + + + +ISTC (standardnumber 1.0.0 API) + + + + + + + +
+ + + + + + + +
+ + + +
+
org.xbib.standardnumber
+

Class ISTC

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable, java.lang.Comparable<ISTC>
    +
    +
    +
    +
    class ISTC
    +extends StandardNumber
    +implements java.lang.Cloneable, java.lang.Comparable<ISTC>
    +

    ISO 21047 International Standard Text Code (ISTC).

    +

    The International Standard Text Code (ISTC) is a numbering system for the unique identification +of text-based works; the term “work” can refer to any content appearing in conventional +printed books, audio-books, static e-books or enhanced digital books, as well as content +which might appear in a newspaper or journal.

    +

    The ISTC provides sales analysis systems, retail websites, library catalogs and other +bibliographic systems with a method of automatically linking together publications +of the “same content” and/or “related content”, thus improving discoverability of +products and efficiencies.

    +

    An ISTC number is the link between a user’s search for a piece of content and the +ultimate sale or loan of a publication.

    +

    The standard was formally published in March 2009.

    +

    Checksum algorithm is ISO 7064 MOD 16/3.

    +
  • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
      protected ISTC() 
      +
    • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      private booleancheck() 
      private java.lang.Stringclean(java.lang.String raw) 
      java.lang.Objectclone() +
      Returns a clone if the implementation is cloneable.
      +
      intcompareTo(ISTC istc) 
      ISTCcreateChecksum(boolean createWithChecksum) +
      Indicate that a correct check sum should be computed.
      +
      booleanequals(java.lang.Object object) 
      java.lang.Stringformat() +
      Return a formatted value of this standard number +This is best for human-readable representation, but is +not necessarily a format for computation.
      +
      java.util.Collection<java.lang.String>getTypedVariants() 
      inthashCode() 
      booleanisValid() +
      Check this number for validity.
      +
      ISTCnormalize() +
      Normalize the value by removing all unwanted characters or +replacing characters with the ones required for verification.
      +
      java.lang.StringnormalizedValue() +
      Return normalized value of this standard number.
      +
      ISTCreset() 
      ISTCverify() +
      Verify the number.
      +
      + + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, toString, wait, wait, wait
      • +
      +
    • +
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        PATTERN

        +
        private static final java.util.regex.Pattern PATTERN
        +
      • +
      + + + +
        +
      • +

        formatted

        +
        private java.lang.String formatted
        +
      • +
      + + + +
        +
      • +

        createWithChecksum

        +
        private boolean createWithChecksum
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ISTC

        +
        protected ISTC()
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        compareTo

        +
        public int compareTo(ISTC istc)
        +
        +
        Specified by:
        +
        compareTo in interface java.lang.Comparable<ISTC>
        +
        +
      • +
      + + + +
        +
      • +

        createChecksum

        +
        public ISTC createChecksum(boolean createWithChecksum)
        +
        Description copied from class: StandardNumber
        +

        Indicate that a correct check sum should be computed.

        +
        +
        Specified by:
        +
        createChecksum in class StandardNumber
        +
        Parameters:
        +
        createWithChecksum - if checksum is included
        +
        Returns:
        +
        this standard number
        +
        +
      • +
      + + + +
        +
      • +

        normalize

        +
        public ISTC 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 ISTC verify()
        +
        Description copied from class: StandardNumber
        +

        Verify the number.

        +
        +
        Specified by:
        +
        verify in class StandardNumber
        +
        Returns:
        +
        this standard number if verification was successful
        +
        +
      • +
      + + + +
        +
      • +

        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
        +
        +
      • +
      + + + + + + + +
        +
      • +

        getTypedVariants

        +
        public java.util.Collection<java.lang.String> getTypedVariants()
        +
        +
        Specified by:
        +
        getTypedVariants in class StandardNumber
        +
        +
      • +
      + + + +
        +
      • +

        check

        +
        private boolean check()
        +
      • +
      + + + +
        +
      • +

        clean

        +
        private java.lang.String clean(java.lang.String raw)
        +
      • +
      + + + +
        +
      • +

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

        Returns a clone if the implementation is cloneable.

        +
        +
        Overrides:
        +
        clone in class StandardNumberSpi
        +
        Returns:
        +
        a clone if the implementation is cloneable.
        +
        Throws:
        +
        java.lang.CloneNotSupportedException - if this is called on an + implementation that does not support Cloneable
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + + + +
+ + + + diff --git a/docs/javadoc/org/xbib/standardnumber/ISWC.html b/docs/javadoc/org/xbib/standardnumber/ISWC.html new file mode 100644 index 0000000..07eb088 --- /dev/null +++ b/docs/javadoc/org/xbib/standardnumber/ISWC.html @@ -0,0 +1,640 @@ + + + + + +ISWC (standardnumber 1.0.0 API) + + + + + + + +
+ + + + + + + +
+ + + +
+
org.xbib.standardnumber
+

Class ISWC

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable, java.lang.Comparable<ISWC>
    +
    +
    +
    +
    class ISWC
    +extends StandardNumber
    +implements java.lang.Cloneable, java.lang.Comparable<ISWC>
    +

    ISO 15707 International Standard Musical Work Code (ISWC).

    +

    International Standard Musical Work Code (ISWC) is a unique identifier for +musical works, similar to ISBN.

    +

    Its primary purpose is in collecting society administration, and to clearly identify works in +legal contracts. It would also be useful in library cataloging.

    +

    Due to the fact that a musical work can have multiple authors, it is inevitable that, +on rare occasions, a duplicate ISWC might exist and might not be detected immediately.

    +

    Because of the existing business practices among collecting societies, it is not possible +to simply declare an ISWC as obsolete. In such cases, as soon as they are identified, +the system will deal with duplicate registrations by linking such registration records +in the ISWC database.

    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private java.lang.Stringformatted 
      private static java.util.regex.PatternPATTERN 
      + +
    • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
      protected ISWC() 
      +
    • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      private booleancheck() 
      private java.lang.Stringclean(java.lang.String raw) 
      java.lang.Objectclone() +
      Returns a clone if the implementation is cloneable.
      +
      intcompareTo(ISWC iswc) 
      ISWCcreateChecksum(boolean createChecksum) +
      Indicate that a correct check sum should be computed.
      +
      booleanequals(java.lang.Object object) 
      java.lang.Stringformat() +
      Return a formatted value of this standard number +This is best for human-readable representation, but is +not necessarily a format for computation.
      +
      java.util.Collection<java.lang.String>getTypedVariants() 
      inthashCode() 
      booleanisValid() +
      Check this number for validity.
      +
      ISWCnormalize() +
      Normalize the value by removing all unwanted characters or +replacing characters with the ones required for verification.
      +
      java.lang.StringnormalizedValue() +
      Return normalized value of this standard number.
      +
      ISWCreset() 
      ISWCverify() +
      Verify the number.
      +
      + + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, toString, wait, wait, wait
      • +
      +
    • +
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        PATTERN

        +
        private static final java.util.regex.Pattern PATTERN
        +
      • +
      + + + +
        +
      • +

        formatted

        +
        private java.lang.String formatted
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ISWC

        +
        protected ISWC()
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        createChecksum

        +
        public ISWC createChecksum(boolean createChecksum)
        +
        Description copied from class: StandardNumber
        +

        Indicate that a correct check sum should be computed.

        +
        +
        Specified by:
        +
        createChecksum in class StandardNumber
        +
        Parameters:
        +
        createChecksum - if checksum is included
        +
        Returns:
        +
        this standard number
        +
        +
      • +
      + + + +
        +
      • +

        normalize

        +
        public ISWC 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 ISWC verify()
        +
        Description copied from class: StandardNumber
        +

        Verify the number.

        +
        +
        Specified by:
        +
        verify in class StandardNumber
        +
        Returns:
        +
        this standard number if verification was successful
        +
        +
      • +
      + + + +
        +
      • +

        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
        +
        +
      • +
      + + + + + + + +
        +
      • +

        getTypedVariants

        +
        public java.util.Collection<java.lang.String> getTypedVariants()
        +
        +
        Specified by:
        +
        getTypedVariants in class StandardNumber
        +
        +
      • +
      + + + +
        +
      • +

        check

        +
        private boolean check()
        +
      • +
      + + + +
        +
      • +

        clean

        +
        private java.lang.String clean(java.lang.String raw)
        +
      • +
      + + + +
        +
      • +

        compareTo

        +
        public int compareTo(ISWC iswc)
        +
        +
        Specified by:
        +
        compareTo in interface java.lang.Comparable<ISWC>
        +
        +
      • +
      + + + +
        +
      • +

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

        Returns a clone if the implementation is cloneable.

        +
        +
        Overrides:
        +
        clone in class StandardNumberSpi
        +
        Returns:
        +
        a clone if the implementation is cloneable.
        +
        Throws:
        +
        java.lang.CloneNotSupportedException - if this is called on an + implementation that does not support Cloneable
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + + + +
+ + + + diff --git a/docs/javadoc/org/xbib/standardnumber/NoSuchStandardNumberException.html b/docs/javadoc/org/xbib/standardnumber/NoSuchStandardNumberException.html new file mode 100644 index 0000000..f698352 --- /dev/null +++ b/docs/javadoc/org/xbib/standardnumber/NoSuchStandardNumberException.html @@ -0,0 +1,300 @@ + + + + + +NoSuchStandardNumberException (standardnumber 1.0.0 API) + + + + + + + +
+ + + + + + + +
+ + + +
+
org.xbib.standardnumber
+

Class NoSuchStandardNumberException

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.io.Serializable
    +
    +
    +
    +
    public class NoSuchStandardNumberException
    +extends java.lang.Exception
    +

    An exception that is thrown if a standard number implementation is not available.

    +
    +
    See Also:
    +
    Serialized Form
    +
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private static longserialVersionUID 
      +
    • +
    + + + +
      +
    • + + +

      Method Summary

      +
        +
      • + + +

        Methods inherited from class java.lang.Throwable

        +addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
      • +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
      • +
      +
    • +
    +
  • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        NoSuchStandardNumberException

        +
        public NoSuchStandardNumberException(java.lang.String msg)
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + + + +
+ + + + diff --git a/docs/javadoc/org/xbib/standardnumber/ORCID.html b/docs/javadoc/org/xbib/standardnumber/ORCID.html new file mode 100644 index 0000000..0ee4e55 --- /dev/null +++ b/docs/javadoc/org/xbib/standardnumber/ORCID.html @@ -0,0 +1,507 @@ + + + + + +ORCID (standardnumber 1.0.0 API) + + + + + + + +
+ + + + + + + +
+ + + +
+
org.xbib.standardnumber
+

Class ORCID

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable, java.lang.Comparable<ISNI>
    +
    +
    +
    +
    class ORCID
    +extends ISNI
    +

    Open Researcher and Contributor ID - ORCID.

    +

    ORCID is compatible to International Standard Name Identifier (ISNI, ISO 2772).

    +

    Checksum calculation is according to ISO/IEC 7064:2003, MOD 11-2.

    +
  • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ORCID

        +
        protected ORCID()
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        set

        +
        public ORCID 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 ORCID createChecksum(boolean createChecksum)
        +
        Description copied from class: StandardNumber
        +

        Indicate that a correct check sum should be computed.

        +
        +
        Overrides:
        +
        createChecksum in class ISNI
        +
        Parameters:
        +
        createChecksum - if checksum is included
        +
        Returns:
        +
        this standard number
        +
        +
      • +
      + + + +
        +
      • +

        normalize

        +
        public ORCID normalize()
        +
        Description copied from class: StandardNumber
        +

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

        +
        +
        Overrides:
        +
        normalize in class ISNI
        +
        Returns:
        +
        this standard number
        +
        +
      • +
      + + + +
        +
      • +

        verify

        +
        public ORCID verify()
        +
        Description copied from class: StandardNumber
        +

        Verify the number.

        +
        +
        Overrides:
        +
        verify in class ISNI
        +
        Returns:
        +
        this standard number if verification was successful
        +
        +
      • +
      + + + +
        +
      • +

        toURI

        +
        public java.net.URI toURI()
        +
      • +
      + + + +
        +
      • +

        compareTo

        +
        public int compareTo(ISNI isni)
        +
        +
        Specified by:
        +
        compareTo in interface java.lang.Comparable<ISNI>
        +
        Overrides:
        +
        compareTo in class ISNI
        +
        +
      • +
      + + + +
        +
      • +

        equals

        +
        public boolean equals(java.lang.Object object)
        +
        +
        Overrides:
        +
        equals in class ISNI
        +
        +
      • +
      + + + +
        +
      • +

        hashCode

        +
        public int hashCode()
        +
        +
        Overrides:
        +
        hashCode in class ISNI
        +
        +
      • +
      + + + +
        +
      • +

        clone

        +
        public java.lang.Object clone()
        +                       throws java.lang.CloneNotSupportedException
        +
        Description copied from class: StandardNumberSpi
        +

        Returns a clone if the implementation is cloneable.

        +
        +
        Overrides:
        +
        clone in class ISNI
        +
        Returns:
        +
        a clone if the implementation is cloneable.
        +
        Throws:
        +
        java.lang.CloneNotSupportedException - if this is called on an + implementation that does not support Cloneable
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + + + +
+ + + + diff --git a/docs/javadoc/org/xbib/standardnumber/PPN.html b/docs/javadoc/org/xbib/standardnumber/PPN.html new file mode 100644 index 0000000..435ef17 --- /dev/null +++ b/docs/javadoc/org/xbib/standardnumber/PPN.html @@ -0,0 +1,645 @@ + + + + + +PPN (standardnumber 1.0.0 API) + + + + + + + +
+ + + + + + + +
+ + + +
+
org.xbib.standardnumber
+

Class PPN

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable, java.lang.Comparable<PPN>
    +
    +
    +
    +
    class PPN
    +extends StandardNumber
    +implements java.lang.Cloneable, java.lang.Comparable<PPN>
    +

    Pica Productie Nummer (PPN).

    +

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

    +
  • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
      protected PPN() 
      +
    • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      private booleancheck() 
      java.lang.Objectclone() +
      Returns a clone if the implementation is cloneable.
      +
      intcompareTo(PPN o) 
      PPNcreateChecksum(boolean createWithChecksum) +
      Indicate that a correct check sum should be computed.
      +
      private java.lang.Stringdehyphenate(java.lang.String value) 
      booleanequals(java.lang.Object object) 
      java.lang.Stringformat() +
      Return a formatted value of this standard number +This is best for human-readable representation, but is +not necessarily a format for computation.
      +
      java.util.Collection<java.lang.String>getTypedVariants() 
      inthashCode() 
      booleanisValid() +
      Check this number for validity.
      +
      PPNnormalize() +
      Normalize the value by removing all unwanted characters or +replacing characters with the ones required for verification.
      +
      java.lang.StringnormalizedValue() +
      Return normalized value of this standard number.
      +
      PPNreset() 
      PPNverify() +
      Verify the number.
      +
      + + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, toString, wait, wait, wait
      • +
      +
    • +
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        PATTERN

        +
        private static final java.util.regex.Pattern PATTERN
        +
      • +
      + + + +
        +
      • +

        formatted

        +
        private java.lang.String formatted
        +
      • +
      + + + +
        +
      • +

        createWithChecksum

        +
        private boolean createWithChecksum
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PPN

        +
        protected PPN()
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        compareTo

        +
        public int compareTo(PPN o)
        +
        +
        Specified by:
        +
        compareTo in interface java.lang.Comparable<PPN>
        +
        +
      • +
      + + + +
        +
      • +

        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
        +
        +
      • +
      + + + +
        +
      • +

        createChecksum

        +
        public PPN createChecksum(boolean createWithChecksum)
        +
        Description copied from class: StandardNumber
        +

        Indicate that a correct check sum should be computed.

        +
        +
        Specified by:
        +
        createChecksum in class StandardNumber
        +
        Parameters:
        +
        createWithChecksum - if checksum is included
        +
        Returns:
        +
        this standard number
        +
        +
      • +
      + + + +
        +
      • +

        normalize

        +
        public PPN 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 PPN verify()
        +
        Description copied from class: StandardNumber
        +

        Verify the number.

        +
        +
        Specified by:
        +
        verify in class StandardNumber
        +
        Returns:
        +
        this standard number if verification was successful
        +
        +
      • +
      + + + +
        +
      • +

        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
        +
        +
      • +
      + + + + + + + +
        +
      • +

        getTypedVariants

        +
        public java.util.Collection<java.lang.String> getTypedVariants()
        +
        +
        Specified by:
        +
        getTypedVariants in class StandardNumber
        +
        +
      • +
      + + + +
        +
      • +

        check

        +
        private boolean check()
        +
      • +
      + + + +
        +
      • +

        dehyphenate

        +
        private java.lang.String dehyphenate(java.lang.String value)
        +
      • +
      + + + +
        +
      • +

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

        Returns a clone if the implementation is cloneable.

        +
        +
        Overrides:
        +
        clone in class StandardNumberSpi
        +
        Returns:
        +
        a clone if the implementation is cloneable.
        +
        Throws:
        +
        java.lang.CloneNotSupportedException - if this is called on an + implementation that does not support Cloneable
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + + + +
+ + + + diff --git a/docs/javadoc/org/xbib/standardnumber/SICI.html b/docs/javadoc/org/xbib/standardnumber/SICI.html new file mode 100644 index 0000000..c3cdaa1 --- /dev/null +++ b/docs/javadoc/org/xbib/standardnumber/SICI.html @@ -0,0 +1,702 @@ + + + + + +SICI (standardnumber 1.0.0 API) + + + + + + + +
+ + + + + + + +
+ + + +
+
org.xbib.standardnumber
+

Class SICI

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable, java.lang.Comparable<SICI>
    +
    +
    +
    +
    class SICI
    +extends StandardNumber
    +implements java.lang.Cloneable, java.lang.Comparable<SICI>
    +

    Z39.56 Serial Item and Contribution Identifier.

    +

    The SICI code (Serial Item and Contribution Identifier) is described in the +American standard ANSI/NISO Z39.56. The SICI code is known among +international scientific publishers and reproduction rights agencies. +The SICI even provides for the unambiguous identification of each article +or contribution published in a given issue of a serial publication.

    +

    The SICI contains

    +
    +
      +
    • +

      the ISSN

      +
    • +
    • +

      the date of publication, between brackets and formatted according to the +formula YYYYMM

      +
    • +
    • +

      the issue number

      +
    • +
    • +

      the version number of the standard, here 1, preceded by a semicolon

      +
    • +
    • +

      and lastly a hyphen which precedes the control character calculated +on the basis of all the preceding characters

      +
    • +
    +
    +

    Example:

    +0095-4403(199502/03)21:3<12:WATIIB>2.0.TX;2-J
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private static java.lang.StringALPHABET 
      private booleancreateWithChecksum 
      private java.lang.Stringformatted 
      private static intmodulus 
      private static java.util.regex.PatternPATTERN 
      + +
    • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
      protected SICI() 
      +
    • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      private booleancheck() 
      private java.lang.Stringclean(java.lang.String raw) 
      java.lang.Objectclone() +
      Returns a clone if the implementation is cloneable.
      +
      intcompareTo(SICI sici) 
      SICIcreateChecksum(boolean createWithChecksum) +
      Indicate that a correct check sum should be computed.
      +
      booleanequals(java.lang.Object object) 
      java.lang.Stringformat() +
      Return a formatted value of this standard number +This is best for human-readable representation, but is +not necessarily a format for computation.
      +
      java.util.Collection<java.lang.String>getTypedVariants() 
      inthashCode() 
      booleanisValid() +
      Check this number for validity.
      +
      SICInormalize() +
      Normalize the value by removing all unwanted characters or +replacing characters with the ones required for verification.
      +
      java.lang.StringnormalizedValue() +
      Return normalized value of this standard number.
      +
      SICIreset() 
      SICIverify() +
      Verify the number.
      +
      + + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, toString, wait, wait, wait
      • +
      +
    • +
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        PATTERN

        +
        private static final java.util.regex.Pattern PATTERN
        +
      • +
      + + + + + + + +
        +
      • +

        modulus

        +
        private static final int modulus
        +
      • +
      + + + +
        +
      • +

        formatted

        +
        private java.lang.String formatted
        +
      • +
      + + + +
        +
      • +

        createWithChecksum

        +
        private boolean createWithChecksum
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        SICI

        +
        protected SICI()
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        compareTo

        +
        public int compareTo(SICI sici)
        +
        +
        Specified by:
        +
        compareTo in interface java.lang.Comparable<SICI>
        +
        +
      • +
      + + + +
        +
      • +

        createChecksum

        +
        public SICI createChecksum(boolean createWithChecksum)
        +
        Description copied from class: StandardNumber
        +

        Indicate that a correct check sum should be computed.

        +
        +
        Specified by:
        +
        createChecksum in class StandardNumber
        +
        Parameters:
        +
        createWithChecksum - if checksum is included
        +
        Returns:
        +
        this standard number
        +
        +
      • +
      + + + +
        +
      • +

        normalize

        +
        public SICI 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 SICI verify()
        +
        Description copied from class: StandardNumber
        +

        Verify the number.

        +
        +
        Specified by:
        +
        verify in class StandardNumber
        +
        Returns:
        +
        this standard number if verification was successful
        +
        +
      • +
      + + + +
        +
      • +

        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
        +
        +
      • +
      + + + + + + + +
        +
      • +

        getTypedVariants

        +
        public java.util.Collection<java.lang.String> getTypedVariants()
        +
        +
        Specified by:
        +
        getTypedVariants in class StandardNumber
        +
        +
      • +
      + + + +
        +
      • +

        check

        +
        private boolean check()
        +
      • +
      + + + +
        +
      • +

        clean

        +
        private java.lang.String clean(java.lang.String raw)
        +
      • +
      + + + +
        +
      • +

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

        Returns a clone if the implementation is cloneable.

        +
        +
        Overrides:
        +
        clone in class StandardNumberSpi
        +
        Returns:
        +
        a clone if the implementation is cloneable.
        +
        Throws:
        +
        java.lang.CloneNotSupportedException - if this is called on an + implementation that does not support Cloneable
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + + + +
+ + + + diff --git a/docs/javadoc/org/xbib/standardnumber/StandardNumber.html b/docs/javadoc/org/xbib/standardnumber/StandardNumber.html new file mode 100644 index 0000000..b9854b8 --- /dev/null +++ b/docs/javadoc/org/xbib/standardnumber/StandardNumber.html @@ -0,0 +1,547 @@ + + + + + +StandardNumber (standardnumber 1.0.0 API) + + + + + + + +
+ + + + + + + +
+ + + +
+
org.xbib.standardnumber
+

Class 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 TypeField and Description
      protected java.lang.Stringtype 
      protected java.lang.Stringvalue 
      +
    • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
      protected StandardNumber(java.lang.String type) 
      +
    • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and TypeMethod and Description
      abstract StandardNumbercreateChecksum(boolean withChecksum) +
      Indicate that a correct check sum should be computed.
      +
      abstract java.lang.Stringformat() +
      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 booleanisValid() +
      Check this number for validity.
      +
      abstract StandardNumbernormalize() +
      Normalize the value by removing all unwanted characters or +replacing characters with the ones required for verification.
      +
      abstract java.lang.StringnormalizedValue() +
      Return normalized value of this standard number.
      +
      abstract StandardNumberreset() 
      StandardNumberset(java.lang.CharSequence value) +
      Set the input value of this standard number.
      +
      java.lang.Stringtype() +
      Return the type of this standard number.
      +
      abstract StandardNumberverify() +
      Verify the number.
      +
      + +
        +
      • + + +

        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
        +
        +
      • +
      + + + + + + + +
        +
      • +

        getTypedVariants

        +
        public abstract java.util.Collection<java.lang.String> getTypedVariants()
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + + + +
+ + + + diff --git a/docs/javadoc/org/xbib/standardnumber/StandardNumberSpi.html b/docs/javadoc/org/xbib/standardnumber/StandardNumberSpi.html new file mode 100644 index 0000000..b9e53e5 --- /dev/null +++ b/docs/javadoc/org/xbib/standardnumber/StandardNumberSpi.html @@ -0,0 +1,325 @@ + + + + + +StandardNumberSpi (standardnumber 1.0.0 API) + + + + + + + +
+ + + + + + + +
+ + + +
+
org.xbib.standardnumber
+

Class StandardNumberSpi

+
+
+ +
+
    +
  • +
    +
    Direct Known Subclasses:
    +
    StandardNumber
    +
    +
    +
    +
    abstract class StandardNumberSpi
    +extends java.lang.Object
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      StandardNumberSpi() 
      +
    • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      java.lang.Objectclone() +
      Returns a clone if the implementation is cloneable.
      +
      static StandardNumbergetInstance(java.lang.Package thePackage, + java.lang.ClassLoader classLoader, + java.lang.String type) 
      static StandardNumbergetInstance(java.lang.String type) 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        StandardNumberSpi

        +
        StandardNumberSpi()
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + + + + + + + + + +
        +
      • +

        clone

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

        Returns a clone if the implementation is cloneable.

        +
        +
        Overrides:
        +
        clone in class java.lang.Object
        +
        Returns:
        +
        a clone if the implementation is cloneable.
        +
        Throws:
        +
        java.lang.CloneNotSupportedException - if this is called on an + implementation that does not support Cloneable
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + + + +
+ + + + diff --git a/docs/javadoc/org/xbib/standardnumber/UPC.html b/docs/javadoc/org/xbib/standardnumber/UPC.html new file mode 100644 index 0000000..f739aa1 --- /dev/null +++ b/docs/javadoc/org/xbib/standardnumber/UPC.html @@ -0,0 +1,627 @@ + + + + + +UPC (standardnumber 1.0.0 API) + + + + + + + +
+ + + + + + + +
+ + + +
+
org.xbib.standardnumber
+

Class UPC

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable, java.lang.Comparable<UPC>
    +
    +
    +
    +
    class UPC
    +extends StandardNumber
    +implements java.lang.Cloneable, java.lang.Comparable<UPC>
    +

    ISO 15420 Universal Product Code (UPC).

    +

    The Universal Product Code (UPC) is a barcode symbology (i.e., a specific type of barcode) +that is widely used in the United States, Canada, the United Kingdom, Australia, +New Zealand and in other countries for tracking trade items in stores. +Its most common form, the UPC-A, consists of 12 numerical digits, which are uniquely +assigned to each trade item.

    +

    Along with the related EAN barcode, the UPC is the barcode mainly used for scanning +of trade items at the point of sale, per GS1 specifications.

    +

    UPC data structures are a component of GTINs (Global Trade Item Numbers).

    +

    All of these data structures follow the global GS1 specification which bases on +international standards.

    +
  • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
      protected UPC() 
      +
    • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      private booleancheck() 
      java.lang.Objectclone() +
      Returns a clone if the implementation is cloneable.
      +
      intcompareTo(UPC upc) 
      UPCcreateChecksum(boolean createWithChecksum) +
      Indicate that a correct check sum should be computed.
      +
      booleanequals(java.lang.Object object) 
      java.lang.Stringformat() +
      Return a formatted value of this standard number +This is best for human-readable representation, but is +not necessarily a format for computation.
      +
      java.util.Collection<java.lang.String>getTypedVariants() 
      inthashCode() 
      booleanisValid() +
      Check this number for validity.
      +
      UPCnormalize() +
      Normalize the value by removing all unwanted characters or +replacing characters with the ones required for verification.
      +
      java.lang.StringnormalizedValue() +
      Return normalized value of this standard number.
      +
      UPCreset() 
      UPCverify() +
      Verify the number.
      +
      + + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, toString, wait, wait, wait
      • +
      +
    • +
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        PATTERN

        +
        private static final java.util.regex.Pattern PATTERN
        +
      • +
      + + + +
        +
      • +

        createWithChecksum

        +
        private boolean createWithChecksum
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        UPC

        +
        protected UPC()
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        compareTo

        +
        public int compareTo(UPC upc)
        +
        +
        Specified by:
        +
        compareTo in interface java.lang.Comparable<UPC>
        +
        +
      • +
      + + + +
        +
      • +

        createChecksum

        +
        public UPC createChecksum(boolean createWithChecksum)
        +
        Description copied from class: StandardNumber
        +

        Indicate that a correct check sum should be computed.

        +
        +
        Specified by:
        +
        createChecksum in class StandardNumber
        +
        Parameters:
        +
        createWithChecksum - if checksum is included
        +
        Returns:
        +
        this standard number
        +
        +
      • +
      + + + +
        +
      • +

        normalize

        +
        public UPC 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 UPC verify()
        +
        Description copied from class: StandardNumber
        +

        Verify the number.

        +
        +
        Specified by:
        +
        verify in class StandardNumber
        +
        Returns:
        +
        this standard number if verification was successful
        +
        +
      • +
      + + + +
        +
      • +

        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
        +
        +
      • +
      + + + + + + + +
        +
      • +

        getTypedVariants

        +
        public java.util.Collection<java.lang.String> getTypedVariants()
        +
        +
        Specified by:
        +
        getTypedVariants in class StandardNumber
        +
        +
      • +
      + + + +
        +
      • +

        check

        +
        private boolean check()
        +
      • +
      + + + +
        +
      • +

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

        Returns a clone if the implementation is cloneable.

        +
        +
        Overrides:
        +
        clone in class StandardNumberSpi
        +
        Returns:
        +
        a clone if the implementation is cloneable.
        +
        Throws:
        +
        java.lang.CloneNotSupportedException - if this is called on an + implementation that does not support Cloneable
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + + + +
+ + + + diff --git a/docs/javadoc/org/xbib/standardnumber/ZDB.html b/docs/javadoc/org/xbib/standardnumber/ZDB.html new file mode 100644 index 0000000..605bcbb --- /dev/null +++ b/docs/javadoc/org/xbib/standardnumber/ZDB.html @@ -0,0 +1,670 @@ + + + + + +ZDB (standardnumber 1.0.0 API) + + + + + + + +
+ + + + + + + +
+ + + +
+
org.xbib.standardnumber
+

Class ZDB

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    java.lang.Cloneable, java.lang.Comparable<ZDB>
    +
    +
    +
    +
    class ZDB
    +extends StandardNumber
    +implements java.lang.Cloneable, java.lang.Comparable<ZDB>
    +

    Zeitschriftendatenbank ID.

    +

    ZDB is the world’s largest specialized database for serial titles (journals, annuals, newspapers, also +e-journals).

    +

    See Prüfziffernberechnung in ILTIS, +DNB Wiki

    +
  • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + + + +
      Constructors 
      ModifierConstructor and Description
      protected ZDB() 
      +
    • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      private booleancheck() 
      java.lang.Objectclone() +
      Returns a clone if the implementation is cloneable.
      +
      intcompareTo(ZDB o) 
      ZDBcreateChecksum(boolean createWithChecksum) +
      Indicate that a correct check sum should be computed.
      +
      private java.lang.Stringdehyphenate(java.lang.String value) 
      booleanequals(java.lang.Object object) 
      java.lang.Stringformat() +
      Return a formatted value of this standard number +This is best for human-readable representation, but is +not necessarily a format for computation.
      +
      java.util.Collection<java.lang.String>getTypedVariants() 
      inthashCode() 
      booleanisValid() +
      Check this number for validity.
      +
      ZDBnormalize() +
      Normalize the value by removing all unwanted characters or +replacing characters with the ones required for verification.
      +
      java.lang.StringnormalizedValue() +
      Return normalized value of this standard number.
      +
      ZDBreset() 
      java.lang.Stringtype() +
      Return the type of this standard number.
      +
      ZDBverify() +
      Verify the number.
      +
      + + +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +finalize, getClass, notify, notifyAll, toString, wait, wait, wait
      • +
      +
    • +
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Detail

      + + + +
        +
      • +

        PATTERN

        +
        private static final java.util.regex.Pattern PATTERN
        +
      • +
      + + + +
        +
      • +

        formatted

        +
        private java.lang.String formatted
        +
      • +
      + + + +
        +
      • +

        createWithChecksum

        +
        private boolean createWithChecksum
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        ZDB

        +
        protected ZDB()
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        type

        +
        public java.lang.String type()
        +
        Description copied from class: StandardNumber
        +

        Return the type of this standard number.

        +
        +
        Overrides:
        +
        type in class StandardNumber
        +
        Returns:
        +
        the type
        +
        +
      • +
      + + + +
        +
      • +

        compareTo

        +
        public int compareTo(ZDB o)
        +
        +
        Specified by:
        +
        compareTo in interface java.lang.Comparable<ZDB>
        +
        +
      • +
      + + + +
        +
      • +

        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
        +
        +
      • +
      + + + +
        +
      • +

        createChecksum

        +
        public ZDB createChecksum(boolean createWithChecksum)
        +
        Description copied from class: StandardNumber
        +

        Indicate that a correct check sum should be computed.

        +
        +
        Specified by:
        +
        createChecksum in class StandardNumber
        +
        Parameters:
        +
        createWithChecksum - if checksum is included
        +
        Returns:
        +
        this standard number
        +
        +
      • +
      + + + +
        +
      • +

        normalize

        +
        public ZDB 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 ZDB verify()
        +
        Description copied from class: StandardNumber
        +

        Verify the number.

        +
        +
        Specified by:
        +
        verify in class StandardNumber
        +
        Returns:
        +
        this standard number if verification was successful
        +
        +
      • +
      + + + +
        +
      • +

        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
        +
        +
      • +
      + + + + + + + +
        +
      • +

        getTypedVariants

        +
        public java.util.Collection<java.lang.String> getTypedVariants()
        +
        +
        Specified by:
        +
        getTypedVariants in class StandardNumber
        +
        +
      • +
      + + + +
        +
      • +

        check

        +
        private boolean check()
        +
      • +
      + + + +
        +
      • +

        dehyphenate

        +
        private java.lang.String dehyphenate(java.lang.String value)
        +
      • +
      + + + +
        +
      • +

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

        Returns a clone if the implementation is cloneable.

        +
        +
        Overrides:
        +
        clone in class StandardNumberSpi
        +
        Returns:
        +
        a clone if the implementation is cloneable.
        +
        Throws:
        +
        java.lang.CloneNotSupportedException - if this is called on an + implementation that does not support Cloneable
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + + + +
+ + + + diff --git a/docs/javadoc/org/xbib/standardnumber/check/Digit.html b/docs/javadoc/org/xbib/standardnumber/check/Digit.html new file mode 100644 index 0000000..2a4f363 --- /dev/null +++ b/docs/javadoc/org/xbib/standardnumber/check/Digit.html @@ -0,0 +1,319 @@ + + + + + +Digit (standardnumber 1.0.0 API) + + + + + + + +
+ + + + + + + +
+ + + +
+
org.xbib.standardnumber.checksum
+

Interface Digit

+
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethod and Description
      intcompute(java.lang.String digits) +
      Computes the check digit value
      +
      java.lang.Stringencode(java.lang.String digits) +
      Add check digits to a string containing digits
      +
      intgetDigit(java.lang.String digits) +
      Extract just the check digit from an encoded string
      +
      java.lang.StringgetNumber(java.lang.String digits) +
      Extracts the raw data without the check digits
      +
      booleanverify(java.lang.String digits) +
      Verify a string that has been encoded with a check digit
      +
      +
    • +
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        encode

        +
        java.lang.String encode(java.lang.String digits)
        +

        Add check digits to a string containing digits

        +
        +
        Parameters:
        +
        digits - the input data string containing only digits '0'-'9'
        +
        Returns:
        +
        a new string containing data and check digits
        +
        +
      • +
      + + + +
        +
      • +

        verify

        +
        boolean verify(java.lang.String digits)
        +

        Verify a string that has been encoded with a check digit

        +
        +
        Parameters:
        +
        digits - input digits
        +
        Returns:
        +
        true if valid, false otherwise
        +
        +
      • +
      + + + +
        +
      • +

        compute

        +
        int compute(java.lang.String digits)
        +

        Computes the check digit value

        +
        +
        Parameters:
        +
        digits - - a string containing data
        +
        Returns:
        +
        an integer representing the check digit
        +
        +
      • +
      + + + +
        +
      • +

        getDigit

        +
        int getDigit(java.lang.String digits)
        +

        Extract just the check digit from an encoded string

        +
        +
        Parameters:
        +
        digits - input data containing check and data digits
        +
        Returns:
        +
        the check digit, as an int
        +
        +
      • +
      + + + +
        +
      • +

        getNumber

        +
        java.lang.String getNumber(java.lang.String digits)
        +

        Extracts the raw data without the check digits

        +
        +
        Parameters:
        +
        digits — A - string containing only digits 0-9
        +
        Returns:
        +
        a string without check digits
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + + + +
+ + + + diff --git a/docs/javadoc/org/xbib/standardnumber/check/DihedralGroup.html b/docs/javadoc/org/xbib/standardnumber/check/DihedralGroup.html new file mode 100644 index 0000000..acebca4 --- /dev/null +++ b/docs/javadoc/org/xbib/standardnumber/check/DihedralGroup.html @@ -0,0 +1,391 @@ + + + + + +DihedralGroup (standardnumber 1.0.0 API) + + + + + + + +
+ + + + + + + +
+ + + +
+
org.xbib.standardnumber.checksum
+

Class DihedralGroup

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Digit
    +
    +
    +
    +
    public class DihedralGroup
    +extends java.lang.Object
    +implements Digit
    +

    Verhoeff’s algorithm for checksum computation

    +
    +
      +
    1. +

      Verhoeff, Error Detecting Decimal Codes, Mathematical Centre Tract 29, The Mathematical Centre, Amsterdam, 1969

      +
    2. +
    +
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      DihedralGroup() 
      +
    • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      intcompute(java.lang.String digits) +
      Computes the check digit value
      +
      java.lang.Stringencode(java.lang.String digits) +
      Add check digits to a string containing digits
      +
      intgetDigit(java.lang.String digits) +
      Extract just the check digit from an encoded string
      +
      java.lang.StringgetNumber(java.lang.String digits) +
      Extracts the raw data without the check digits
      +
      booleanverify(java.lang.String digits) +
      Verify a string that has been encoded with a check digit
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        DihedralGroup

        +
        public DihedralGroup()
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        encode

        +
        public java.lang.String encode(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Add check digits to a string containing digits

        +
        +
        Specified by:
        +
        encode in interface Digit
        +
        Parameters:
        +
        digits - the input data string containing only digits '0'-'9'
        +
        Returns:
        +
        a new string containing data and check digits
        +
        +
      • +
      + + + +
        +
      • +

        verify

        +
        public boolean verify(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Verify a string that has been encoded with a check digit

        +
        +
        Specified by:
        +
        verify in interface Digit
        +
        Parameters:
        +
        digits - input digits
        +
        Returns:
        +
        true if valid, false otherwise
        +
        +
      • +
      + + + +
        +
      • +

        compute

        +
        public int compute(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Computes the check digit value

        +
        +
        Specified by:
        +
        compute in interface Digit
        +
        Parameters:
        +
        digits - - a string containing data
        +
        Returns:
        +
        an integer representing the check digit
        +
        +
      • +
      + + + +
        +
      • +

        getDigit

        +
        public int getDigit(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Extract just the check digit from an encoded string

        +
        +
        Specified by:
        +
        getDigit in interface Digit
        +
        Parameters:
        +
        digits - input data containing check and data digits
        +
        Returns:
        +
        the check digit, as an int
        +
        +
      • +
      + + + +
        +
      • +

        getNumber

        +
        public java.lang.String getNumber(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Extracts the raw data without the check digits

        +
        +
        Specified by:
        +
        getNumber in interface Digit
        +
        Returns:
        +
        a string without check digits
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + + + +
+ + + + diff --git a/docs/javadoc/org/xbib/standardnumber/check/LuhnMOD10.html b/docs/javadoc/org/xbib/standardnumber/check/LuhnMOD10.html new file mode 100644 index 0000000..181f6da --- /dev/null +++ b/docs/javadoc/org/xbib/standardnumber/check/LuhnMOD10.html @@ -0,0 +1,383 @@ + + + + + +LuhnMOD10 (standardnumber 1.0.0 API) + + + + + + + +
+ + + + + + + +
+ + + +
+
org.xbib.standardnumber.checksum
+

Class LuhnMOD10

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Digit
    +
    +
    +
    +
    public class LuhnMOD10
    +extends java.lang.Object
    +implements Digit
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      LuhnMOD10() 
      +
    • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      intcompute(java.lang.String digits) +
      Computes the check digit value
      +
      java.lang.Stringencode(java.lang.String digits) +
      Add check digits to a string containing digits
      +
      intgetDigit(java.lang.String digits) +
      Extract just the check digit from an encoded string
      +
      java.lang.StringgetNumber(java.lang.String digits) +
      Extracts the raw data without the check digits
      +
      booleanverify(java.lang.String digits) +
      Verify a string that has been encoded with a check digit
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        LuhnMOD10

        +
        public LuhnMOD10()
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        encode

        +
        public java.lang.String encode(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Add check digits to a string containing digits

        +
        +
        Specified by:
        +
        encode in interface Digit
        +
        Parameters:
        +
        digits - the input data string containing only digits '0'-'9'
        +
        Returns:
        +
        a new string containing data and check digits
        +
        +
      • +
      + + + +
        +
      • +

        verify

        +
        public boolean verify(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Verify a string that has been encoded with a check digit

        +
        +
        Specified by:
        +
        verify in interface Digit
        +
        Parameters:
        +
        digits - input digits
        +
        Returns:
        +
        true if valid, false otherwise
        +
        +
      • +
      + + + +
        +
      • +

        compute

        +
        public int compute(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Computes the check digit value

        +
        +
        Specified by:
        +
        compute in interface Digit
        +
        Parameters:
        +
        digits - - a string containing data
        +
        Returns:
        +
        an integer representing the check digit
        +
        +
      • +
      + + + +
        +
      • +

        getDigit

        +
        public int getDigit(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Extract just the check digit from an encoded string

        +
        +
        Specified by:
        +
        getDigit in interface Digit
        +
        Parameters:
        +
        digits - input data containing check and data digits
        +
        Returns:
        +
        the check digit, as an int
        +
        +
      • +
      + + + +
        +
      • +

        getNumber

        +
        public java.lang.String getNumber(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Extracts the raw data without the check digits

        +
        +
        Specified by:
        +
        getNumber in interface Digit
        +
        Returns:
        +
        a string without check digits
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + + + +
+ + + + diff --git a/docs/javadoc/org/xbib/standardnumber/check/iso7064/MOD1110.html b/docs/javadoc/org/xbib/standardnumber/check/iso7064/MOD1110.html new file mode 100644 index 0000000..4c8c0f1 --- /dev/null +++ b/docs/javadoc/org/xbib/standardnumber/check/iso7064/MOD1110.html @@ -0,0 +1,383 @@ + + + + + +MOD1110 (standardnumber 1.0.0 API) + + + + + + + +
+ + + + + + + +
+ + + +
+
org.xbib.standardnumber.checksum.iso7064
+

Class MOD1110

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Digit
    +
    +
    +
    +
    public class MOD1110
    +extends java.lang.Object
    +implements Digit
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      MOD1110() 
      +
    • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      intcompute(java.lang.String digits) +
      Computes the check digit value
      +
      java.lang.Stringencode(java.lang.String digits) +
      Add check digits to a string containing digits
      +
      intgetDigit(java.lang.String digits) +
      Extract just the check digit from an encoded string
      +
      java.lang.StringgetNumber(java.lang.String digits) +
      Extracts the raw data without the check digits
      +
      booleanverify(java.lang.String digits) +
      Verify a string that has been encoded with a check digit
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        MOD1110

        +
        public MOD1110()
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        encode

        +
        public java.lang.String encode(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Add check digits to a string containing digits

        +
        +
        Specified by:
        +
        encode in interface Digit
        +
        Parameters:
        +
        digits - the input data string containing only digits '0'-'9'
        +
        Returns:
        +
        a new string containing data and check digits
        +
        +
      • +
      + + + +
        +
      • +

        verify

        +
        public boolean verify(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Verify a string that has been encoded with a check digit

        +
        +
        Specified by:
        +
        verify in interface Digit
        +
        Parameters:
        +
        digits - input digits
        +
        Returns:
        +
        true if valid, false otherwise
        +
        +
      • +
      + + + +
        +
      • +

        compute

        +
        public int compute(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Computes the check digit value

        +
        +
        Specified by:
        +
        compute in interface Digit
        +
        Parameters:
        +
        digits - - a string containing data
        +
        Returns:
        +
        an integer representing the check digit
        +
        +
      • +
      + + + +
        +
      • +

        getDigit

        +
        public int getDigit(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Extract just the check digit from an encoded string

        +
        +
        Specified by:
        +
        getDigit in interface Digit
        +
        Parameters:
        +
        digits - input data containing check and data digits
        +
        Returns:
        +
        the check digit, as an int
        +
        +
      • +
      + + + +
        +
      • +

        getNumber

        +
        public java.lang.String getNumber(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Extracts the raw data without the check digits

        +
        +
        Specified by:
        +
        getNumber in interface Digit
        +
        Returns:
        +
        a string without check digits
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + + + +
+ + + + diff --git a/docs/javadoc/org/xbib/standardnumber/check/iso7064/MOD112.html b/docs/javadoc/org/xbib/standardnumber/check/iso7064/MOD112.html new file mode 100644 index 0000000..da53eff --- /dev/null +++ b/docs/javadoc/org/xbib/standardnumber/check/iso7064/MOD112.html @@ -0,0 +1,383 @@ + + + + + +MOD112 (standardnumber 1.0.0 API) + + + + + + + +
+ + + + + + + +
+ + + +
+
org.xbib.standardnumber.checksum.iso7064
+

Class MOD112

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Digit
    +
    +
    +
    +
    public class MOD112
    +extends java.lang.Object
    +implements Digit
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      MOD112() 
      +
    • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      intcompute(java.lang.String digits) +
      Computes the check digit value
      +
      java.lang.Stringencode(java.lang.String digits) +
      Add check digits to a string containing digits
      +
      intgetDigit(java.lang.String digits) +
      Extract just the check digit from an encoded string
      +
      java.lang.StringgetNumber(java.lang.String digits) +
      Extracts the raw data without the check digits
      +
      booleanverify(java.lang.String digits) +
      Verify a string that has been encoded with a check digit
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        MOD112

        +
        public MOD112()
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        encode

        +
        public java.lang.String encode(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Add check digits to a string containing digits

        +
        +
        Specified by:
        +
        encode in interface Digit
        +
        Parameters:
        +
        digits - the input data string containing only digits '0'-'9'
        +
        Returns:
        +
        a new string containing data and check digits
        +
        +
      • +
      + + + +
        +
      • +

        verify

        +
        public boolean verify(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Verify a string that has been encoded with a check digit

        +
        +
        Specified by:
        +
        verify in interface Digit
        +
        Parameters:
        +
        digits - input digits
        +
        Returns:
        +
        true if valid, false otherwise
        +
        +
      • +
      + + + +
        +
      • +

        compute

        +
        public int compute(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Computes the check digit value

        +
        +
        Specified by:
        +
        compute in interface Digit
        +
        Parameters:
        +
        digits - - a string containing data
        +
        Returns:
        +
        an integer representing the check digit
        +
        +
      • +
      + + + +
        +
      • +

        getDigit

        +
        public int getDigit(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Extract just the check digit from an encoded string

        +
        +
        Specified by:
        +
        getDigit in interface Digit
        +
        Parameters:
        +
        digits - input data containing check and data digits
        +
        Returns:
        +
        the check digit, as an int
        +
        +
      • +
      + + + +
        +
      • +

        getNumber

        +
        public java.lang.String getNumber(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Extracts the raw data without the check digits

        +
        +
        Specified by:
        +
        getNumber in interface Digit
        +
        Returns:
        +
        a string without check digits
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + + + +
+ + + + diff --git a/docs/javadoc/org/xbib/standardnumber/check/iso7064/MOD3736.html b/docs/javadoc/org/xbib/standardnumber/check/iso7064/MOD3736.html new file mode 100644 index 0000000..227dbbd --- /dev/null +++ b/docs/javadoc/org/xbib/standardnumber/check/iso7064/MOD3736.html @@ -0,0 +1,383 @@ + + + + + +MOD3736 (standardnumber 1.0.0 API) + + + + + + + +
+ + + + + + + +
+ + + +
+
org.xbib.standardnumber.checksum.iso7064
+

Class MOD3736

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Digit
    +
    +
    +
    +
    public class MOD3736
    +extends java.lang.Object
    +implements Digit
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      MOD3736() 
      +
    • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      intcompute(java.lang.String digits) +
      Computes the check digit value
      +
      java.lang.Stringencode(java.lang.String digits) +
      Add check digits to a string containing digits
      +
      intgetDigit(java.lang.String digits) +
      Extract just the check digit from an encoded string
      +
      java.lang.StringgetNumber(java.lang.String digits) +
      Extracts the raw data without the check digits
      +
      booleanverify(java.lang.String digits) +
      Verify a string that has been encoded with a check digit
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        MOD3736

        +
        public MOD3736()
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        encode

        +
        public java.lang.String encode(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Add check digits to a string containing digits

        +
        +
        Specified by:
        +
        encode in interface Digit
        +
        Parameters:
        +
        digits - the input data string containing only digits '0'-'9'
        +
        Returns:
        +
        a new string containing data and check digits
        +
        +
      • +
      + + + +
        +
      • +

        verify

        +
        public boolean verify(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Verify a string that has been encoded with a check digit

        +
        +
        Specified by:
        +
        verify in interface Digit
        +
        Parameters:
        +
        digits - input digits
        +
        Returns:
        +
        true if valid, false otherwise
        +
        +
      • +
      + + + +
        +
      • +

        compute

        +
        public int compute(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Computes the check digit value

        +
        +
        Specified by:
        +
        compute in interface Digit
        +
        Parameters:
        +
        digits - - a string containing data
        +
        Returns:
        +
        an integer representing the check digit
        +
        +
      • +
      + + + +
        +
      • +

        getDigit

        +
        public int getDigit(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Extract just the check digit from an encoded string

        +
        +
        Specified by:
        +
        getDigit in interface Digit
        +
        Parameters:
        +
        digits - input data containing check and data digits
        +
        Returns:
        +
        the check digit, as an int
        +
        +
      • +
      + + + +
        +
      • +

        getNumber

        +
        public java.lang.String getNumber(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Extracts the raw data without the check digits

        +
        +
        Specified by:
        +
        getNumber in interface Digit
        +
        Returns:
        +
        a string without check digits
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + + + +
+ + + + diff --git a/docs/javadoc/org/xbib/standardnumber/check/iso7064/MOD9710.html b/docs/javadoc/org/xbib/standardnumber/check/iso7064/MOD9710.html new file mode 100644 index 0000000..013a884 --- /dev/null +++ b/docs/javadoc/org/xbib/standardnumber/check/iso7064/MOD9710.html @@ -0,0 +1,383 @@ + + + + + +MOD9710 (standardnumber 1.0.0 API) + + + + + + + +
+ + + + + + + +
+ + + +
+
org.xbib.standardnumber.checksum.iso7064
+

Class MOD9710

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Digit
    +
    +
    +
    +
    public class MOD9710
    +extends java.lang.Object
    +implements Digit
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      MOD9710() 
      +
    • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      intcompute(java.lang.String digits) +
      Computes the check digit value
      +
      java.lang.Stringencode(java.lang.String digits) +
      Add check digits to a string containing digits
      +
      intgetDigit(java.lang.String digits) +
      Extract just the check digit from an encoded string
      +
      java.lang.StringgetNumber(java.lang.String digits) +
      Extracts the raw data without the check digits
      +
      booleanverify(java.lang.String digits) +
      Verify a string that has been encoded with a check digit
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        MOD9710

        +
        public MOD9710()
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        encode

        +
        public java.lang.String encode(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Add check digits to a string containing digits

        +
        +
        Specified by:
        +
        encode in interface Digit
        +
        Parameters:
        +
        digits - the input data string containing only digits '0'-'9'
        +
        Returns:
        +
        a new string containing data and check digits
        +
        +
      • +
      + + + +
        +
      • +

        verify

        +
        public boolean verify(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Verify a string that has been encoded with a check digit

        +
        +
        Specified by:
        +
        verify in interface Digit
        +
        Parameters:
        +
        digits - input digits
        +
        Returns:
        +
        true if valid, false otherwise
        +
        +
      • +
      + + + +
        +
      • +

        compute

        +
        public int compute(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Computes the check digit value

        +
        +
        Specified by:
        +
        compute in interface Digit
        +
        Parameters:
        +
        digits - - a string containing data
        +
        Returns:
        +
        an integer representing the check digit
        +
        +
      • +
      + + + +
        +
      • +

        getDigit

        +
        public int getDigit(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Extract just the check digit from an encoded string

        +
        +
        Specified by:
        +
        getDigit in interface Digit
        +
        Parameters:
        +
        digits - input data containing check and data digits
        +
        Returns:
        +
        the check digit, as an int
        +
        +
      • +
      + + + +
        +
      • +

        getNumber

        +
        public java.lang.String getNumber(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Extracts the raw data without the check digits

        +
        +
        Specified by:
        +
        getNumber in interface Digit
        +
        Returns:
        +
        a string without check digits
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + + + +
+ + + + diff --git a/docs/javadoc/org/xbib/standardnumber/check/iso7064/package-frame.html b/docs/javadoc/org/xbib/standardnumber/check/iso7064/package-frame.html new file mode 100644 index 0000000..7a06b1b --- /dev/null +++ b/docs/javadoc/org/xbib/standardnumber/check/iso7064/package-frame.html @@ -0,0 +1,22 @@ + + + + + +org.xbib.standardnumber.checksum.iso7064 (standardnumber 1.0.0 API) + + + + +

org.xbib.standardnumber.checksum.iso7064

+
+

Classes

+ +
+ + diff --git a/docs/javadoc/org/xbib/standardnumber/check/iso7064/package-summary.html b/docs/javadoc/org/xbib/standardnumber/check/iso7064/package-summary.html new file mode 100644 index 0000000..e293989 --- /dev/null +++ b/docs/javadoc/org/xbib/standardnumber/check/iso7064/package-summary.html @@ -0,0 +1,150 @@ + + + + + +org.xbib.standardnumber.checksum.iso7064 (standardnumber 1.0.0 API) + + + + + + + +
+ + + + + + + +
+ + +
+

Package org.xbib.standardnumber.checksum.iso7064

+
+
+ +
+ +
+ + + + + + + +
+ + + + diff --git a/docs/javadoc/org/xbib/standardnumber/check/iso7064/package-tree.html b/docs/javadoc/org/xbib/standardnumber/check/iso7064/package-tree.html new file mode 100644 index 0000000..651bf50 --- /dev/null +++ b/docs/javadoc/org/xbib/standardnumber/check/iso7064/package-tree.html @@ -0,0 +1,136 @@ + + + + + +org.xbib.standardnumber.checksum.iso7064 Class Hierarchy (standardnumber 1.0.0 API) + + + + + + + +
+ + + + + + + +
+ + +
+

Hierarchy For Package org.xbib.standardnumber.checksum.iso7064

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + + + + + + +
+ + + + diff --git a/docs/javadoc/org/xbib/standardnumber/check/package-frame.html b/docs/javadoc/org/xbib/standardnumber/check/package-frame.html new file mode 100644 index 0000000..937fe1a --- /dev/null +++ b/docs/javadoc/org/xbib/standardnumber/check/package-frame.html @@ -0,0 +1,24 @@ + + + + + +org.xbib.standardnumber.checksum (standardnumber 1.0.0 API) + + + + +

org.xbib.standardnumber.checksum

+
+

Interfaces

+ +

Classes

+ +
+ + diff --git a/docs/javadoc/org/xbib/standardnumber/check/package-summary.html b/docs/javadoc/org/xbib/standardnumber/check/package-summary.html new file mode 100644 index 0000000..ea8b366 --- /dev/null +++ b/docs/javadoc/org/xbib/standardnumber/check/package-summary.html @@ -0,0 +1,166 @@ + + + + + +org.xbib.standardnumber.checksum (standardnumber 1.0.0 API) + + + + + + + +
+ + + + + + + +
+ + +
+

Package org.xbib.standardnumber.checksum

+
+
+ +
+ +
+ + + + + + + +
+ + + + diff --git a/docs/javadoc/org/xbib/standardnumber/check/package-tree.html b/docs/javadoc/org/xbib/standardnumber/check/package-tree.html new file mode 100644 index 0000000..ab9c20a --- /dev/null +++ b/docs/javadoc/org/xbib/standardnumber/check/package-tree.html @@ -0,0 +1,138 @@ + + + + + +org.xbib.standardnumber.checksum Class Hierarchy (standardnumber 1.0.0 API) + + + + + + + +
+ + + + + + + +
+ + +
+

Hierarchy For Package org.xbib.standardnumber.checksum

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +
+ +
+ + + + + + + +
+ + + + diff --git a/docs/javadoc/org/xbib/standardnumber/checksum/Digit.html b/docs/javadoc/org/xbib/standardnumber/checksum/Digit.html new file mode 100644 index 0000000..d7e8d6c --- /dev/null +++ b/docs/javadoc/org/xbib/standardnumber/checksum/Digit.html @@ -0,0 +1,319 @@ + + + + + +Digit (standardnumber 1.0.0 API) + + + + + + + +
+ + + + + + + +
+ + + +
+
org.xbib.standardnumber.checksum
+

Interface Digit

+
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Abstract Methods 
      Modifier and TypeMethod and Description
      intcompute(java.lang.String digits) +
      Computes the check digit value.
      +
      java.lang.Stringencode(java.lang.String digits) +
      Add check digits to a string containing digits.
      +
      intgetDigit(java.lang.String digits) +
      Extract just the check digit from an encoded string.
      +
      java.lang.StringgetNumber(java.lang.String digits) +
      Extracts the raw data without the check digits.
      +
      booleanverify(java.lang.String digits) +
      Verify a string that has been encoded with a check digit.
      +
      +
    • +
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        encode

        +
        java.lang.String encode(java.lang.String digits)
        +

        Add check digits to a string containing digits.

        +
        +
        Parameters:
        +
        digits - the input data string containing only digits '0'-'9'
        +
        Returns:
        +
        a new string containing data and check digits
        +
        +
      • +
      + + + +
        +
      • +

        verify

        +
        boolean verify(java.lang.String digits)
        +

        Verify a string that has been encoded with a check digit.

        +
        +
        Parameters:
        +
        digits - input digits
        +
        Returns:
        +
        true if valid, false otherwise
        +
        +
      • +
      + + + +
        +
      • +

        compute

        +
        int compute(java.lang.String digits)
        +

        Computes the check digit value.

        +
        +
        Parameters:
        +
        digits - - a string containing data
        +
        Returns:
        +
        an integer representing the check digit
        +
        +
      • +
      + + + +
        +
      • +

        getDigit

        +
        int getDigit(java.lang.String digits)
        +

        Extract just the check digit from an encoded string.

        +
        +
        Parameters:
        +
        digits - input data containing check and data digits
        +
        Returns:
        +
        the check digit, as an int
        +
        +
      • +
      + + + +
        +
      • +

        getNumber

        +
        java.lang.String getNumber(java.lang.String digits)
        +

        Extracts the raw data without the check digits.

        +
        +
        Parameters:
        +
        digits — A - string containing only digits 0-9
        +
        Returns:
        +
        a string without check digits
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + + + +
+ + + + diff --git a/docs/javadoc/org/xbib/standardnumber/checksum/DihedralGroup.html b/docs/javadoc/org/xbib/standardnumber/checksum/DihedralGroup.html new file mode 100644 index 0000000..7bf6a86 --- /dev/null +++ b/docs/javadoc/org/xbib/standardnumber/checksum/DihedralGroup.html @@ -0,0 +1,462 @@ + + + + + +DihedralGroup (standardnumber 1.0.0 API) + + + + + + + +
+ + + + + + + +
+ + + +
+
org.xbib.standardnumber.checksum
+

Class DihedralGroup

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Digit
    +
    +
    +
    +
    public class DihedralGroup
    +extends java.lang.Object
    +implements Digit
    +

    Verhoeff’s algorithm for checksum computation.

    +
    +
      +
    1. +

      Verhoeff, Error Detecting Decimal Codes, Mathematical Centre Tract 29, The Mathematical Centre, Amsterdam, 1969

      +
    2. +
    +
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private static int[][]a +
      The dihedral addition matrix A + B = a[A][B].
      +
      private static int[]inverse +
      The dihedral inverse map, A + inverse[A] = 0.
      +
      private static int[][]p +
      pThe ermutation weighting matrix P[position][value].
      +
      +
    • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      DihedralGroup() 
      +
    • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      intcompute(java.lang.String digits) +
      Computes the check digit value.
      +
      java.lang.Stringencode(java.lang.String digits) +
      Add check digits to a string containing digits.
      +
      intgetDigit(java.lang.String digits) +
      Extract just the check digit from an encoded string.
      +
      java.lang.StringgetNumber(java.lang.String digits) +
      Extracts the raw data without the check digits.
      +
      booleanverify(java.lang.String digits) +
      Verify a string that has been encoded with a check digit.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        a

        +
        private static final int[][] a
        +

        The dihedral addition matrix A + B = a[A][B].

        +
      • +
      + + + +
        +
      • +

        inverse

        +
        private static final int[] inverse
        +

        The dihedral inverse map, A + inverse[A] = 0.

        +
      • +
      + + + +
        +
      • +

        p

        +
        private static final int[][] p
        +

        pThe ermutation weighting matrix P[position][value].

        +
      • +
      +
    • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        DihedralGroup

        +
        public DihedralGroup()
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        encode

        +
        public java.lang.String encode(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Add check digits to a string containing digits.

        +
        +
        Specified by:
        +
        encode in interface Digit
        +
        Parameters:
        +
        digits - the input data string containing only digits '0'-'9'
        +
        Returns:
        +
        a new string containing data and check digits
        +
        +
      • +
      + + + +
        +
      • +

        verify

        +
        public boolean verify(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Verify a string that has been encoded with a check digit.

        +
        +
        Specified by:
        +
        verify in interface Digit
        +
        Parameters:
        +
        digits - input digits
        +
        Returns:
        +
        true if valid, false otherwise
        +
        +
      • +
      + + + +
        +
      • +

        compute

        +
        public int compute(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Computes the check digit value.

        +
        +
        Specified by:
        +
        compute in interface Digit
        +
        Parameters:
        +
        digits - - a string containing data
        +
        Returns:
        +
        an integer representing the check digit
        +
        +
      • +
      + + + +
        +
      • +

        getDigit

        +
        public int getDigit(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Extract just the check digit from an encoded string.

        +
        +
        Specified by:
        +
        getDigit in interface Digit
        +
        Parameters:
        +
        digits - input data containing check and data digits
        +
        Returns:
        +
        the check digit, as an int
        +
        +
      • +
      + + + +
        +
      • +

        getNumber

        +
        public java.lang.String getNumber(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Extracts the raw data without the check digits.

        +
        +
        Specified by:
        +
        getNumber in interface Digit
        +
        Returns:
        +
        a string without check digits
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + + + +
+ + + + diff --git a/docs/javadoc/org/xbib/standardnumber/checksum/LuhnMOD10.html b/docs/javadoc/org/xbib/standardnumber/checksum/LuhnMOD10.html new file mode 100644 index 0000000..50cea8a --- /dev/null +++ b/docs/javadoc/org/xbib/standardnumber/checksum/LuhnMOD10.html @@ -0,0 +1,396 @@ + + + + + +LuhnMOD10 (standardnumber 1.0.0 API) + + + + + + + +
+ + + + + + + +
+ + + +
+
org.xbib.standardnumber.checksum
+

Class LuhnMOD10

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Digit
    +
    +
    +
    +
    public class LuhnMOD10
    +extends java.lang.Object
    +implements Digit
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      LuhnMOD10() 
      +
    • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      intcompute(java.lang.String digits) +
      Computes the check digit value.
      +
      private intcomputeSum(java.lang.String digits) 
      java.lang.Stringencode(java.lang.String digits) +
      Add check digits to a string containing digits.
      +
      intgetDigit(java.lang.String digits) +
      Extract just the check digit from an encoded string.
      +
      java.lang.StringgetNumber(java.lang.String digits) +
      Extracts the raw data without the check digits.
      +
      booleanverify(java.lang.String digits) +
      Verify a string that has been encoded with a check digit.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        LuhnMOD10

        +
        public LuhnMOD10()
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        encode

        +
        public java.lang.String encode(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Add check digits to a string containing digits.

        +
        +
        Specified by:
        +
        encode in interface Digit
        +
        Parameters:
        +
        digits - the input data string containing only digits '0'-'9'
        +
        Returns:
        +
        a new string containing data and check digits
        +
        +
      • +
      + + + +
        +
      • +

        verify

        +
        public boolean verify(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Verify a string that has been encoded with a check digit.

        +
        +
        Specified by:
        +
        verify in interface Digit
        +
        Parameters:
        +
        digits - input digits
        +
        Returns:
        +
        true if valid, false otherwise
        +
        +
      • +
      + + + +
        +
      • +

        compute

        +
        public int compute(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Computes the check digit value.

        +
        +
        Specified by:
        +
        compute in interface Digit
        +
        Parameters:
        +
        digits - - a string containing data
        +
        Returns:
        +
        an integer representing the check digit
        +
        +
      • +
      + + + +
        +
      • +

        getDigit

        +
        public int getDigit(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Extract just the check digit from an encoded string.

        +
        +
        Specified by:
        +
        getDigit in interface Digit
        +
        Parameters:
        +
        digits - input data containing check and data digits
        +
        Returns:
        +
        the check digit, as an int
        +
        +
      • +
      + + + +
        +
      • +

        getNumber

        +
        public java.lang.String getNumber(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Extracts the raw data without the check digits.

        +
        +
        Specified by:
        +
        getNumber in interface Digit
        +
        Returns:
        +
        a string without check digits
        +
        +
      • +
      + + + +
        +
      • +

        computeSum

        +
        private int computeSum(java.lang.String digits)
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + + + +
+ + + + diff --git a/docs/javadoc/org/xbib/standardnumber/checksum/iso7064/MOD1110.html b/docs/javadoc/org/xbib/standardnumber/checksum/iso7064/MOD1110.html new file mode 100644 index 0000000..a6c7fd2 --- /dev/null +++ b/docs/javadoc/org/xbib/standardnumber/checksum/iso7064/MOD1110.html @@ -0,0 +1,423 @@ + + + + + +MOD1110 (standardnumber 1.0.0 API) + + + + + + + +
+ + + + + + + +
+ + + +
+
org.xbib.standardnumber.checksum.iso7064
+

Class MOD1110

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Digit
    +
    +
    +
    +
    public class MOD1110
    +extends java.lang.Object
    +implements Digit
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private static java.lang.StringALPHABET 
      +
    • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      MOD1110() 
      +
    • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      intcompute(java.lang.String digits) +
      Computes the check digit value.
      +
      java.lang.Stringencode(java.lang.String digits) +
      Add check digits to a string containing digits.
      +
      intgetDigit(java.lang.String digits) +
      Extract just the check digit from an encoded string.
      +
      java.lang.StringgetNumber(java.lang.String digits) +
      Extracts the raw data without the check digits.
      +
      booleanverify(java.lang.String digits) +
      Verify a string that has been encoded with a check digit.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        MOD1110

        +
        public MOD1110()
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        encode

        +
        public java.lang.String encode(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Add check digits to a string containing digits.

        +
        +
        Specified by:
        +
        encode in interface Digit
        +
        Parameters:
        +
        digits - the input data string containing only digits '0'-'9'
        +
        Returns:
        +
        a new string containing data and check digits
        +
        +
      • +
      + + + +
        +
      • +

        verify

        +
        public boolean verify(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Verify a string that has been encoded with a check digit.

        +
        +
        Specified by:
        +
        verify in interface Digit
        +
        Parameters:
        +
        digits - input digits
        +
        Returns:
        +
        true if valid, false otherwise
        +
        +
      • +
      + + + +
        +
      • +

        compute

        +
        public int compute(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Computes the check digit value.

        +
        +
        Specified by:
        +
        compute in interface Digit
        +
        Parameters:
        +
        digits - - a string containing data
        +
        Returns:
        +
        an integer representing the check digit
        +
        +
      • +
      + + + +
        +
      • +

        getDigit

        +
        public int getDigit(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Extract just the check digit from an encoded string.

        +
        +
        Specified by:
        +
        getDigit in interface Digit
        +
        Parameters:
        +
        digits - input data containing check and data digits
        +
        Returns:
        +
        the check digit, as an int
        +
        +
      • +
      + + + +
        +
      • +

        getNumber

        +
        public java.lang.String getNumber(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Extracts the raw data without the check digits.

        +
        +
        Specified by:
        +
        getNumber in interface Digit
        +
        Returns:
        +
        a string without check digits
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + + + +
+ + + + diff --git a/docs/javadoc/org/xbib/standardnumber/checksum/iso7064/MOD112.html b/docs/javadoc/org/xbib/standardnumber/checksum/iso7064/MOD112.html new file mode 100644 index 0000000..00be510 --- /dev/null +++ b/docs/javadoc/org/xbib/standardnumber/checksum/iso7064/MOD112.html @@ -0,0 +1,383 @@ + + + + + +MOD112 (standardnumber 1.0.0 API) + + + + + + + +
+ + + + + + + +
+ + + +
+
org.xbib.standardnumber.checksum.iso7064
+

Class MOD112

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Digit
    +
    +
    +
    +
    public class MOD112
    +extends java.lang.Object
    +implements Digit
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      MOD112() 
      +
    • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      intcompute(java.lang.String digits) +
      Computes the check digit value.
      +
      java.lang.Stringencode(java.lang.String digits) +
      Add check digits to a string containing digits.
      +
      intgetDigit(java.lang.String digits) +
      Extract just the check digit from an encoded string.
      +
      java.lang.StringgetNumber(java.lang.String digits) +
      Extracts the raw data without the check digits.
      +
      booleanverify(java.lang.String digits) +
      Verify a string that has been encoded with a check digit.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        MOD112

        +
        public MOD112()
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        encode

        +
        public java.lang.String encode(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Add check digits to a string containing digits.

        +
        +
        Specified by:
        +
        encode in interface Digit
        +
        Parameters:
        +
        digits - the input data string containing only digits '0'-'9'
        +
        Returns:
        +
        a new string containing data and check digits
        +
        +
      • +
      + + + +
        +
      • +

        verify

        +
        public boolean verify(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Verify a string that has been encoded with a check digit.

        +
        +
        Specified by:
        +
        verify in interface Digit
        +
        Parameters:
        +
        digits - input digits
        +
        Returns:
        +
        true if valid, false otherwise
        +
        +
      • +
      + + + +
        +
      • +

        compute

        +
        public int compute(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Computes the check digit value.

        +
        +
        Specified by:
        +
        compute in interface Digit
        +
        Parameters:
        +
        digits - - a string containing data
        +
        Returns:
        +
        an integer representing the check digit
        +
        +
      • +
      + + + +
        +
      • +

        getDigit

        +
        public int getDigit(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Extract just the check digit from an encoded string.

        +
        +
        Specified by:
        +
        getDigit in interface Digit
        +
        Parameters:
        +
        digits - input data containing check and data digits
        +
        Returns:
        +
        the check digit, as an int
        +
        +
      • +
      + + + +
        +
      • +

        getNumber

        +
        public java.lang.String getNumber(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Extracts the raw data without the check digits.

        +
        +
        Specified by:
        +
        getNumber in interface Digit
        +
        Returns:
        +
        a string without check digits
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + + + +
+ + + + diff --git a/docs/javadoc/org/xbib/standardnumber/checksum/iso7064/MOD3736.html b/docs/javadoc/org/xbib/standardnumber/checksum/iso7064/MOD3736.html new file mode 100644 index 0000000..7144d0a --- /dev/null +++ b/docs/javadoc/org/xbib/standardnumber/checksum/iso7064/MOD3736.html @@ -0,0 +1,423 @@ + + + + + +MOD3736 (standardnumber 1.0.0 API) + + + + + + + +
+ + + + + + + +
+ + + +
+
org.xbib.standardnumber.checksum.iso7064
+

Class MOD3736

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Digit
    +
    +
    +
    +
    public class MOD3736
    +extends java.lang.Object
    +implements Digit
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private static java.lang.StringALPHABET 
      +
    • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      MOD3736() 
      +
    • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      intcompute(java.lang.String digits) +
      Computes the check digit value.
      +
      java.lang.Stringencode(java.lang.String digits) +
      Add check digits to a string containing digits.
      +
      intgetDigit(java.lang.String digits) +
      Extract just the check digit from an encoded string.
      +
      java.lang.StringgetNumber(java.lang.String digits) +
      Extracts the raw data without the check digits.
      +
      booleanverify(java.lang.String digits) +
      Verify a string that has been encoded with a check digit.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Constructor Detail

      + + + +
        +
      • +

        MOD3736

        +
        public MOD3736()
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        encode

        +
        public java.lang.String encode(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Add check digits to a string containing digits.

        +
        +
        Specified by:
        +
        encode in interface Digit
        +
        Parameters:
        +
        digits - the input data string containing only digits '0'-'9'
        +
        Returns:
        +
        a new string containing data and check digits
        +
        +
      • +
      + + + +
        +
      • +

        verify

        +
        public boolean verify(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Verify a string that has been encoded with a check digit.

        +
        +
        Specified by:
        +
        verify in interface Digit
        +
        Parameters:
        +
        digits - input digits
        +
        Returns:
        +
        true if valid, false otherwise
        +
        +
      • +
      + + + +
        +
      • +

        compute

        +
        public int compute(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Computes the check digit value.

        +
        +
        Specified by:
        +
        compute in interface Digit
        +
        Parameters:
        +
        digits - - a string containing data
        +
        Returns:
        +
        an integer representing the check digit
        +
        +
      • +
      + + + +
        +
      • +

        getDigit

        +
        public int getDigit(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Extract just the check digit from an encoded string.

        +
        +
        Specified by:
        +
        getDigit in interface Digit
        +
        Parameters:
        +
        digits - input data containing check and data digits
        +
        Returns:
        +
        the check digit, as an int
        +
        +
      • +
      + + + +
        +
      • +

        getNumber

        +
        public java.lang.String getNumber(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Extracts the raw data without the check digits.

        +
        +
        Specified by:
        +
        getNumber in interface Digit
        +
        Returns:
        +
        a string without check digits
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + + + +
+ + + + diff --git a/docs/javadoc/org/xbib/standardnumber/checksum/iso7064/MOD9710.html b/docs/javadoc/org/xbib/standardnumber/checksum/iso7064/MOD9710.html new file mode 100644 index 0000000..b72ac29 --- /dev/null +++ b/docs/javadoc/org/xbib/standardnumber/checksum/iso7064/MOD9710.html @@ -0,0 +1,419 @@ + + + + + +MOD9710 (standardnumber 1.0.0 API) + + + + + + + +
+ + + + + + + +
+ + + +
+
org.xbib.standardnumber.checksum.iso7064
+

Class MOD9710

+
+
+ +
+
    +
  • +
    +
    All Implemented Interfaces:
    +
    Digit
    +
    +
    +
    +
    public class MOD9710
    +extends java.lang.Object
    +implements Digit
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      private static java.math.BigDecimalCONSTANT_97 
      +
    • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      MOD9710() 
      +
    • +
    + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      All Methods Instance Methods Concrete Methods 
      Modifier and TypeMethod and Description
      intcompute(java.lang.String digits) +
      Computes the check digit value.
      +
      java.lang.Stringencode(java.lang.String digits) +
      Add check digits to a string containing digits.
      +
      intgetDigit(java.lang.String digits) +
      Extract just the check digit from an encoded string.
      +
      java.lang.StringgetNumber(java.lang.String digits) +
      Extracts the raw data without the check digits.
      +
      booleanverify(java.lang.String digits) +
      Verify a string that has been encoded with a check digit.
      +
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

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

      Field Detail

      + + + +
        +
      • +

        CONSTANT_97

        +
        private static final java.math.BigDecimal CONSTANT_97
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        MOD9710

        +
        public MOD9710()
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        encode

        +
        public java.lang.String encode(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Add check digits to a string containing digits.

        +
        +
        Specified by:
        +
        encode in interface Digit
        +
        Parameters:
        +
        digits - the input data string containing only digits '0'-'9'
        +
        Returns:
        +
        a new string containing data and check digits
        +
        +
      • +
      + + + +
        +
      • +

        verify

        +
        public boolean verify(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Verify a string that has been encoded with a check digit.

        +
        +
        Specified by:
        +
        verify in interface Digit
        +
        Parameters:
        +
        digits - input digits
        +
        Returns:
        +
        true if valid, false otherwise
        +
        +
      • +
      + + + +
        +
      • +

        compute

        +
        public int compute(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Computes the check digit value.

        +
        +
        Specified by:
        +
        compute in interface Digit
        +
        Parameters:
        +
        digits - - a string containing data
        +
        Returns:
        +
        an integer representing the check digit
        +
        +
      • +
      + + + +
        +
      • +

        getDigit

        +
        public int getDigit(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Extract just the check digit from an encoded string.

        +
        +
        Specified by:
        +
        getDigit in interface Digit
        +
        Parameters:
        +
        digits - input data containing check and data digits
        +
        Returns:
        +
        the check digit, as an int
        +
        +
      • +
      + + + +
        +
      • +

        getNumber

        +
        public java.lang.String getNumber(java.lang.String digits)
        +
        Description copied from interface: Digit
        +

        Extracts the raw data without the check digits.

        +
        +
        Specified by:
        +
        getNumber in interface Digit
        +
        Returns:
        +
        a string without check digits
        +
        +
      • +
      +
    • +
    +
  • +
+
+
+ + +
+ + + + + + + +
+ + + + diff --git a/docs/javadoc/org/xbib/standardnumber/checksum/iso7064/package-frame.html b/docs/javadoc/org/xbib/standardnumber/checksum/iso7064/package-frame.html new file mode 100644 index 0000000..2f4e313 --- /dev/null +++ b/docs/javadoc/org/xbib/standardnumber/checksum/iso7064/package-frame.html @@ -0,0 +1,22 @@ + + + + + +org.xbib.standardnumber.checksum.iso7064 (standardnumber 1.0.0 API) + + + + +

org.xbib.standardnumber.checksum.iso7064

+
+

Classes

+ +
+ + diff --git a/docs/javadoc/org/xbib/standardnumber/checksum/iso7064/package-summary.html b/docs/javadoc/org/xbib/standardnumber/checksum/iso7064/package-summary.html new file mode 100644 index 0000000..5ef31ed --- /dev/null +++ b/docs/javadoc/org/xbib/standardnumber/checksum/iso7064/package-summary.html @@ -0,0 +1,160 @@ + + + + + +org.xbib.standardnumber.checksum.iso7064 (standardnumber 1.0.0 API) + + + + + + + +
+ + + + + + + +
+ + +
+

Package org.xbib.standardnumber.checksum.iso7064

+
+
Classes for checksum computations according to ISO 7064.
+
+

See: Description

+
+
+ + + + +

Package org.xbib.standardnumber.checksum.iso7064 Description

+

Classes for checksum computations according to ISO 7064.

+
+ +
+ + + + + + + +
+ + + + diff --git a/docs/javadoc/org/xbib/standardnumber/checksum/iso7064/package-tree.html b/docs/javadoc/org/xbib/standardnumber/checksum/iso7064/package-tree.html new file mode 100644 index 0000000..d92df5f --- /dev/null +++ b/docs/javadoc/org/xbib/standardnumber/checksum/iso7064/package-tree.html @@ -0,0 +1,137 @@ + + + + + +org.xbib.standardnumber.checksum.iso7064 Class Hierarchy (standardnumber 1.0.0 API) + + + + + + + +
+ + + + + + + +
+ + +
+

Hierarchy For Package org.xbib.standardnumber.checksum.iso7064

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + + + + + + +
+ + + + diff --git a/docs/javadoc/org/xbib/standardnumber/checksum/package-frame.html b/docs/javadoc/org/xbib/standardnumber/checksum/package-frame.html new file mode 100644 index 0000000..a1e8291 --- /dev/null +++ b/docs/javadoc/org/xbib/standardnumber/checksum/package-frame.html @@ -0,0 +1,24 @@ + + + + + +org.xbib.standardnumber.checksum (standardnumber 1.0.0 API) + + + + +

org.xbib.standardnumber.checksum

+
+

Interfaces

+ +

Classes

+ +
+ + diff --git a/docs/javadoc/org/xbib/standardnumber/checksum/package-summary.html b/docs/javadoc/org/xbib/standardnumber/checksum/package-summary.html new file mode 100644 index 0000000..cfc96e5 --- /dev/null +++ b/docs/javadoc/org/xbib/standardnumber/checksum/package-summary.html @@ -0,0 +1,169 @@ + + + + + +org.xbib.standardnumber.checksum (standardnumber 1.0.0 API) + + + + + + + +
+ + + + + + + +
+ + +
+

Package org.xbib.standardnumber.checksum

+
+
Classes for computing checksums.
+
+

See: Description

+
+
+ + + + +

Package org.xbib.standardnumber.checksum Description

+

Classes for computing checksums.

+
+ +
+ + + + + + + +
+ + + + diff --git a/docs/javadoc/org/xbib/standardnumber/checksum/package-tree.html b/docs/javadoc/org/xbib/standardnumber/checksum/package-tree.html new file mode 100644 index 0000000..60f55fe --- /dev/null +++ b/docs/javadoc/org/xbib/standardnumber/checksum/package-tree.html @@ -0,0 +1,139 @@ + + + + + +org.xbib.standardnumber.checksum Class Hierarchy (standardnumber 1.0.0 API) + + + + + + + +
+ + + + + + + +
+ + +
+

Hierarchy For Package org.xbib.standardnumber.checksum

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +
+ +
+ + + + + + + +
+ + + + diff --git a/docs/javadoc/org/xbib/standardnumber/package-frame.html b/docs/javadoc/org/xbib/standardnumber/package-frame.html new file mode 100644 index 0000000..fff1cca --- /dev/null +++ b/docs/javadoc/org/xbib/standardnumber/package-frame.html @@ -0,0 +1,42 @@ + + + + + +org.xbib.standardnumber (standardnumber 1.0.0 API) + + + + +

org.xbib.standardnumber

+
+

Classes

+ +

Exceptions

+ +
+ + diff --git a/docs/javadoc/org/xbib/standardnumber/package-summary.html b/docs/javadoc/org/xbib/standardnumber/package-summary.html new file mode 100644 index 0000000..78da0a2 --- /dev/null +++ b/docs/javadoc/org/xbib/standardnumber/package-summary.html @@ -0,0 +1,278 @@ + + + + + +org.xbib.standardnumber (standardnumber 1.0.0 API) + + + + + + + +
+ + + + + + + +
+ + +
+

Package org.xbib.standardnumber

+
+
Classes for standard numbers.
+
+

See: Description

+
+
+ + + + +

Package org.xbib.standardnumber Description

+

Classes for standard numbers.

+
+ +
+ + + + + + + +
+ + + + diff --git a/docs/javadoc/org/xbib/standardnumber/package-tree.html b/docs/javadoc/org/xbib/standardnumber/package-tree.html new file mode 100644 index 0000000..9907fb6 --- /dev/null +++ b/docs/javadoc/org/xbib/standardnumber/package-tree.html @@ -0,0 +1,171 @@ + + + + + +org.xbib.standardnumber Class Hierarchy (standardnumber 1.0.0 API) + + + + + + + +
+ + + + + + + +
+ + +
+

Hierarchy For Package org.xbib.standardnumber

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + + + + + + +
+ + + + diff --git a/docs/javadoc/overview-frame.html b/docs/javadoc/overview-frame.html new file mode 100644 index 0000000..de6b93c --- /dev/null +++ b/docs/javadoc/overview-frame.html @@ -0,0 +1,22 @@ + + + + + +Overview List (standardnumber 1.0.0 API) + + + + +
All Classes
+
+

Packages

+ +
+

 

+ + diff --git a/docs/javadoc/overview-summary.html b/docs/javadoc/overview-summary.html new file mode 100644 index 0000000..36012bf --- /dev/null +++ b/docs/javadoc/overview-summary.html @@ -0,0 +1,160 @@ + + + + + +Overview (standardnumber 1.0.0 API) + + + + + + + +
+ + + + + + + +
+ + +
+

standardnumber 1.0.0 API

+
+
+
+
Standard numbers for Java
+
+

See: Description

+
+
+ + + + + + + + + + + + + + + + + + + + +
Packages 
PackageDescription
org.xbib.standardnumber +
Classes for standard numbers.
+
org.xbib.standardnumber.checksum +
Classes for computing checksums.
+
org.xbib.standardnumber.checksum.iso7064 +
Classes for checksum computations according to ISO 7064.
+
+
+
+ + +

Standard numbers for Java

+
+ +
+ + + + + + + +
+ + + + diff --git a/docs/javadoc/overview-tree.html b/docs/javadoc/overview-tree.html new file mode 100644 index 0000000..a0d2f1b --- /dev/null +++ b/docs/javadoc/overview-tree.html @@ -0,0 +1,183 @@ + + + + + +Class Hierarchy (standardnumber 1.0.0 API) + + + + + + + +
+ + + + + + + +
+ + +
+

Hierarchy For All Packages

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +

Interface Hierarchy

+ +
+ +
+ + + + + + + +
+ + + + diff --git a/docs/javadoc/package-list b/docs/javadoc/package-list new file mode 100644 index 0000000..7d195c5 --- /dev/null +++ b/docs/javadoc/package-list @@ -0,0 +1,3 @@ +org.xbib.standardnumber +org.xbib.standardnumber.checksum +org.xbib.standardnumber.checksum.iso7064 diff --git a/docs/javadoc/script.js b/docs/javadoc/script.js new file mode 100644 index 0000000..b346356 --- /dev/null +++ b/docs/javadoc/script.js @@ -0,0 +1,30 @@ +function show(type) +{ + count = 0; + for (var key in methods) { + var row = document.getElementById(key); + if ((methods[key] & type) != 0) { + row.style.display = ''; + row.className = (count++ % 2) ? rowColor : altColor; + } + else + row.style.display = 'none'; + } + updateTabs(type); +} + +function updateTabs(type) +{ + for (var value in tabs) { + var sNode = document.getElementById(tabs[value][0]); + var spanNode = sNode.firstChild; + if (value == type) { + sNode.className = activeTableTab; + spanNode.innerHTML = tabs[value][1]; + } + else { + sNode.className = tableTab; + spanNode.innerHTML = "" + tabs[value][1] + ""; + } + } +} diff --git a/docs/javadoc/serialized-form.html b/docs/javadoc/serialized-form.html new file mode 100644 index 0000000..afd6761 --- /dev/null +++ b/docs/javadoc/serialized-form.html @@ -0,0 +1,138 @@ + + + + + +Serialized Form (standardnumber 1.0.0 API) + + + + + + + +
+ + + + + + + +
+ + +
+

Serialized Form

+
+
+ +
+ +
+ + + + + + + +
+ + + + diff --git a/docs/javadoc/stylesheet.css b/docs/javadoc/stylesheet.css new file mode 100644 index 0000000..3242ab9 --- /dev/null +++ b/docs/javadoc/stylesheet.css @@ -0,0 +1,732 @@ +/* Asciidoclet Java 7/8 javadoc stylesheet + * + * Javadoc stylesheet based on http://docs.oracle.com/javase/8/docs/api/stylesheet.css + * with additional styles from Asciidoctor. + */ + +@import url('coderay-asciidoctor.css'); + +/* Javadoc style sheet */ +/* +Overall document style +*/ + +/* Asciidoclet +@import url('resources/fonts/dejavu.css'); +*/ + +body { + background-color:#ffffff; + color:#353833; + font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; + font-size:14px; + margin:0; +} +a:link, a:visited { + text-decoration:none; + color:#4A6782; +} +a:hover, a:focus { + text-decoration:none; + color:#bb7a2a; +} +a:active { + text-decoration:none; + color:#4A6782; +} +a[name] { + color:#353833; +} +a[name]:hover { + text-decoration:none; + color:#353833; +} +pre { + font-family:'DejaVu Sans Mono', monospace; + font-size:14px; +} +h1 { + font-size:20px; +} +h2 { + font-size:18px; +} +h3 { + font-size:16px; + font-style:italic; +} +h4 { + font-size:13px; +} +h5 { + font-size:12px; +} +h6 { + font-size:11px; +} +ul { + list-style-type:disc; +} +code, tt, dt code, table tr td dt code { + color:rgba(0,0,0,.9); + font-family:'DejaVu Sans Mono', monospace; + font-size:13px; + line-height:1.4; +} +pre > code { + font-size: 14px !important; +} +table tr td dt code { + vertical-align:top; +} +sup { + font-size:8px; +} +/* +Document title and Copyright styles +*/ +.clear { + clear:both; + height:0px; + overflow:hidden; +} +.aboutLanguage { + float:right; + padding:0px 21px; + font-size:11px; + z-index:200; + margin-top:-9px; +} +.legalCopy { + margin:.5em; + float:left; +} +.bar a, .bar a:link, .bar a:visited, .bar a:active { + color:#FFFFFF; + text-decoration:none; +} +.bar a:hover, .bar a:focus { + color:#bb7a2a; +} +.tab { + background-color:#0066FF; + color:#ffffff; + padding:8px; + width:5em; + font-weight:bold; +} +/* +Navigation bar styles +*/ +.bar { + background-color:#4D7A97; + color:#FFFFFF; + padding:.8em .5em .4em .8em; + height:auto;/*height:1.8em;*/ + font-size:11px; + margin:0; +} +.topNav { + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.bottomNav { + margin-top:10px; + background-color:#4D7A97; + color:#FFFFFF; + float:left; + padding:0; + width:100%; + clear:right; + height:2.8em; + padding-top:10px; + overflow:hidden; + font-size:12px; +} +.subNav { + background-color:#dee3e9; + float:left; + width:100%; + overflow:hidden; + font-size:12px; +} +.subNav div { + clear:left; + float:left; + padding:0 0 5px 6px; + text-transform:uppercase; +} +ul.navList, ul.subNavList { + float:left; + margin:0 25px 0 0; + padding:0; +} +ul.navList li{ + list-style:none; + float:left; + padding: 5px 6px; + text-transform:uppercase; +} +ul.subNavList li{ + list-style:none; + float:left; +} +.topNav a:link, .topNav a:active, .topNav a:visited, .bottomNav a:link, .bottomNav a:active, .bottomNav a:visited { + color:#FFFFFF; + text-decoration:none; + text-transform:uppercase; +} +.topNav a:hover, .bottomNav a:hover { + text-decoration:none; + color:#bb7a2a; + text-transform:uppercase; +} +.navBarCell1Rev { + background-color:#F8981D; + color:#253441; + margin: auto 5px; +} +.skipNav { + position:absolute; + top:auto; + left:-9999px; + overflow:hidden; +} +/* +Page header and footer styles +*/ +.header, .footer { + clear:both; + margin:0 20px; + padding:5px 0 0 0; +} +.indexHeader { + margin:10px; + position:relative; +} +.indexHeader span{ + margin-right:15px; +} +.indexHeader h1 { + font-size:13px; +} +.title { + color:#2c4557; + margin:10px 0; +} +.subTitle { + margin:5px 0 0 0; +} +.header ul { + margin:0 0 15px 0; + padding:0; +} +.footer ul { + margin:20px 0 5px 0; +} +.header ul li, .footer ul li { + list-style:none; + font-size:13px; +} +/* +Heading styles +*/ +div.details ul.blockList ul.blockList ul.blockList li.blockList h4, div.details ul.blockList ul.blockList ul.blockListLast li.blockList h4 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList ul.blockList li.blockList h3 { + background-color:#dee3e9; + border:1px solid #d0d9e0; + margin:0 0 6px -8px; + padding:7px 5px; +} +ul.blockList ul.blockList li.blockList h3 { + padding:0; + margin:15px 0; +} +ul.blockList li.blockList h2 { + padding:0px 0 20px 0; +} +/* +Page layout container styles +*/ +.contentContainer, .sourceContainer, .classUseContainer, .serializedFormContainer, .constantValuesContainer { + clear:both; + padding:10px 20px; + position:relative; +} +.indexContainer { + margin:10px; + position:relative; + font-size:12px; +} +.indexContainer h2 { + font-size:13px; + padding:0 0 3px 0; +} +.indexContainer ul { + margin:0; + padding:0; +} +.indexContainer ul li { + list-style:none; + padding-top:2px; +} +/*.contentContainer dl dt, .contentContainer .description dl dt, .contentContainer .details dl dt, .serializedFormContainer dl dt { */ +.contentContainer dl dt, .serializedFormContainer dl dt, .dlist dl dt { + font-size:13px; + font-weight:bold; + margin:10px 0 0 0; +} + +/*.contentContainer .description dl dd, .contentContainer .details dl dd, .serializedFormContainer dl dd { */ +.contentContainer dl dd, .serializedFormContainer dl dd { + margin:5px 0 10px 0px; + font-size:14px; + font-family:'DejaVu Sans Mono',monospace; +} + +.serializedFormContainer dl.nameValue dt { + margin-left:1px; + font-size:1.1em; + display:inline; + font-weight:bold; +} +.serializedFormContainer dl.nameValue dd { + margin:0 0 0 1px; + font-size:1.1em; + display:inline; +} +/* +List styles +*/ +ul.horizontal li { + display:inline; + font-size:0.9em; +} +ul.inheritance { + margin:0; + padding:0; +} +ul.inheritance li { + display:inline; + list-style:none; +} +ul.inheritance li ul.inheritance { + margin-left:15px; + padding-left:15px; + padding-top:1px; +} +ul.blockList, ul.blockListLast { + margin:10px 0 10px 0; + padding:0; +} +ul.blockList li.blockList, ul.blockListLast li.blockList { + list-style:none; + margin-bottom:15px; + line-height:1.4; +} +ul.blockList ul.blockList li.blockList, ul.blockList ul.blockListLast li.blockList { + padding:0px 20px 5px 10px; + border:1px solid #ededed; + background-color:#f8f8f8; +} +ul.blockList ul.blockList ul.blockList li.blockList, ul.blockList ul.blockList ul.blockListLast li.blockList { + padding:0 0 5px 8px; + background-color:#ffffff; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockList { + margin-left:0; + padding-left:0; + padding-bottom:15px; + border:none; +} +ul.blockList ul.blockList ul.blockList ul.blockList li.blockListLast { + list-style:none; + border-bottom:none; + padding-bottom:0; +} +table tr td dl, table tr td dl dt, table tr td dl dd { + margin-top:0; + margin-bottom:1px; +} +/* +Table styles +- Asciidoclet - added .packageSummary to table styles below, used by Java 7 output. +*/ +.overviewSummary, .memberSummary, .typeSummary, .useSummary, .constantsSummary, .deprecatedSummary, .packageSummary { + width:100%; + border-left:1px solid #EEE; + border-right:1px solid #EEE; + border-bottom:1px solid #EEE; +} +.overviewSummary, .memberSummary { + padding:0px; +} +.overviewSummary caption, .memberSummary caption, .typeSummary caption, .packageSummary caption, +.useSummary caption, .constantsSummary caption, .deprecatedSummary caption { + position:relative; + text-align:left; + background-repeat:no-repeat; + color:#253441; + font-weight:bold; + clear:none; + overflow:hidden; + padding:0px; + padding-top:10px; + padding-left:1px; + margin:0px; + white-space:pre; +} +.overviewSummary caption a:link, .memberSummary caption a:link, .typeSummary caption a:link, .packageSummary caption a:link, +.useSummary caption a:link, .constantsSummary caption a:link, .deprecatedSummary caption a:link, +.overviewSummary caption a:hover, .memberSummary caption a:hover, .typeSummary caption a:hover, .packageSummary caption a:hover, +.useSummary caption a:hover, .constantsSummary caption a:hover, .deprecatedSummary caption a:hover, +.overviewSummary caption a:active, .memberSummary caption a:active, .typeSummary caption a:active, .packageSummary caption a:active, +.useSummary caption a:active, .constantsSummary caption a:active, .deprecatedSummary caption a:active, +.overviewSummary caption a:visited, .memberSummary caption a:visited, .typeSummary caption a:visited, .packageSummary caption a:visited, +.useSummary caption a:visited, .constantsSummary caption a:visited, .deprecatedSummary caption a:visited { + color:#FFFFFF; +} +.overviewSummary caption span, .memberSummary caption span, .typeSummary caption span, .packageSummary caption span, +.useSummary caption span, .constantsSummary caption span, .deprecatedSummary caption span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + padding-bottom:7px; + display:inline-block; + float:left; + background-color:#F8981D; + border: none; + height:16px; +} +.memberSummary caption span.activeTableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#F8981D; + height:16px; +} +.memberSummary caption span.tableTab span { + white-space:nowrap; + padding-top:5px; + padding-left:12px; + padding-right:12px; + margin-right:3px; + display:inline-block; + float:left; + background-color:#4D7A97; + height:16px; +} +.memberSummary caption span.tableTab, .memberSummary caption span.activeTableTab { + padding-top:0px; + padding-left:0px; + padding-right:0px; + background-image:none; + float:none; + display:inline; +} +.overviewSummary .tabEnd, .memberSummary .tabEnd, .typeSummary .tabEnd, .packageSummary .tabEnd, +.useSummary .tabEnd, .constantsSummary .tabEnd, .deprecatedSummary .tabEnd { + display:none; + width:5px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .activeTableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + float:left; + background-color:#F8981D; +} +.memberSummary .tableTab .tabEnd { + display:none; + width:5px; + margin-right:3px; + position:relative; + background-color:#4D7A97; + float:left; + +} +.overviewSummary td, .memberSummary td, .typeSummary td, .packageSummary td, +.useSummary td, .constantsSummary td, .deprecatedSummary td { + text-align:left; + padding:0px 0px 12px 10px; + width:100%; +} +th.colOne, th.colFirst, th.colLast, .useSummary th, .constantsSummary th, +td.colOne, td.colFirst, td.colLast, .useSummary td, .constantsSummary td{ + vertical-align:top; + padding-right:0px; + padding-top:8px; + padding-bottom:3px; +} +th.colFirst, th.colLast, th.colOne, .constantsSummary th { + background:#dee3e9; + text-align:left; + padding:8px 3px 3px 7px; +} +td.colFirst, th.colFirst { + white-space:nowrap; + font-size:13px; +} +td.colLast, th.colLast { + font-size:13px; +} +td.colOne, th.colOne { + font-size:13px; +} +.overviewSummary td.colFirst, .overviewSummary th.colFirst, +.overviewSummary td.colOne, .overviewSummary th.colOne, +.memberSummary td.colFirst, .memberSummary th.colFirst, +.memberSummary td.colOne, .memberSummary th.colOne, +.typeSummary td.colFirst, .packageSummary td.colFirst{ + width:25%; + vertical-align:top; +} +td.colOne a:link, td.colOne a:active, td.colOne a:visited, td.colOne a:hover, td.colFirst a:link, td.colFirst a:active, td.colFirst a:visited, td.colFirst a:hover, td.colLast a:link, td.colLast a:active, td.colLast a:visited, td.colLast a:hover, .constantValuesContainer td a:link, .constantValuesContainer td a:active, .constantValuesContainer td a:visited, .constantValuesContainer td a:hover { + font-weight:bold; +} +.tableSubHeadingColor { + background-color:#EEEEFF; +} +.altColor { + background-color:#FFFFFF; +} +.rowColor { + background-color:#EEEEEF; +} +/* +Content styles +*/ +.description pre { + margin-top:0; +} +.deprecatedContent { + margin:0; + padding:10px 0; +} +.docSummary { + padding:0; +} + +ul.blockList ul.blockList ul.blockList li.blockList h3 { + font-style:normal; +} + +div.block { + font-size:14px; + font-family:'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} + +td.colLast div { + padding-top:0px; +} + + +td.colLast a { + padding-bottom:3px; +} +/* +Formatting effect styles +*/ +.sourceLineNo { + color:green; + padding:0 30px 0 0; +} +h1.hidden { + visibility:hidden; + overflow:hidden; + font-size:10px; +} +div.block { + display:block; + margin:3px 10px 2px 0px; + color:rgba(0,0,0,.8); +} + +div.block h1, div.block h2, div.block h3, div.block h4, div.block h5, div.block h6 { + font-family:'DejaVu Sans', Arial, Helvetica, sans-serif; + font-weight:300; + font-style: normal; + color:#7a4a0e; +} +div.block *:not(pre) > code { + font-weight: normal; + padding: 2px 4px; + background-color: #f7f7f7; + -webkit-border-radius: 4px; + border-radius: 4px; +} +div.block a { + text-decoration: underline; +} +.deprecatedLabel, .descfrmTypeLabel, .memberNameLabel, .memberNameLink, +.overrideSpecifyLabel, .packageHierarchyLabel, .paramLabel, .returnLabel, +.seeLabel, .simpleTagLabel, .throwsLabel, .typeNameLabel, .typeNameLink { + font-weight:bold; +} +.deprecationComment, .emphasizedPhrase, .interfaceName { + font-style:italic; +} + +div.block div.block span.deprecationComment, div.block div.block span.emphasizedPhrase, +div.block div.block span.interfaceName { + font-style:normal; +} + +div.contentContainer ul.blockList li.blockList h2{ + padding-bottom:0px; +} + +/* Asciidoclet styles - adapted from + * https://github.com/asciidoctor/asciidoctor/blob/master/data/stylesheets/asciidoctor-default.css + */ + +/* Asciidoclet - reset to normal paragraph font in description text, javadoc wants monospace for some reason */ +.contentContainer dl dd { + font-family: 'DejaVu Serif', Georgia, "Times New Roman", Times, serif; +} + +span.strong { font-weight: bold; } + +/* select on .ulist, .olist */ +.ulist ul, .olist ol { margin-left: 1.5em; padding: inherit; } +ul.no-bullet, ol.no-bullet { margin-left: 1.5em; } +.ulist ul li ul, .ulist ul li ol { margin-left: 1.25em; margin-bottom: 0; font-size: 1em; } +ul.square li ul, ul.circle li ul, ul.disc li ul { list-style: inherit; } +ul.square { list-style-type: square; } +ul.circle { list-style-type: circle; } +ul.disc { list-style-type: disc; } +ul.no-bullet { list-style: none; } +.olist ol li ul, .olist ol li ol { margin-left: 1.25em; margin-bottom: 0; } + +blockquote { margin: 0 0 1.25em; padding: 0.5625em 1.25em 0 1.1875em; border-left: 3px solid #487c58; } +blockquote cite { display: block; font-size: inherit; color: #454545; } +blockquote cite:before { content: "\2014 \0020"; } +blockquote cite a, blockquote cite a:visited { color: #454545; } +blockquote, blockquote p { line-height: 1.6; color: #6e6e6e; } + +/* Added div.block */ +div.block table { background: white; margin-bottom: 1.25em; border: solid 1px #dddddd; } +div.block table thead, div.block table tfoot { background: whitesmoke; font-weight: bold; } +div.block table thead tr th, div.block table thead tr td, div.block table tfoot tr th, div.block table tfoot tr td { padding: 0.5em 0.625em 0.625em; font-size: inherit; color: #333333; text-align: left; } +div.block table tr th, div.block table tr td { padding: 0.5625em 0.625em; font-size: inherit; color: #333333; } +div.block table tr.even, div.block table tr.alt, div.block table tr:nth-of-type(even) { background: #f9f9f9; } + +.subheader, #content #toctitle, .admonitionblock td.content > .title, .exampleblock > .title, .imageblock > .title, .listingblock > .title, .literalblock > .title, .mathblock > .title, .openblock > .title, .paragraph > .title, .quoteblock > .title, .tableblock > .title, .verseblock > .title, .videoblock > .title, .dlist > .title, .olist > .title, .ulist > .title, .qlist > .title, .hdlist > .title, .tableblock > caption { line-height: 1.4; color: #7a4a0e; font-weight: 300; margin-top: 0.5em; margin-bottom: 0.25em; } + +.imageblock, .literalblock, .listingblock, .mathblock, .verseblock, .videoblock { margin-bottom: 1.25em; } +.admonitionblock td.content > .title, .exampleblock > .title, .imageblock > .title, .listingblock > .title, .literalblock > .title, .mathblock > .title, .openblock > .title, .paragraph > .title, .quoteblock > .title, .tableblock > .title, .verseblock > .title, .videoblock > .title, .dlist > .title, .olist > .title, .ulist > .title, .qlist > .title, .hdlist > .title { text-align: left; font-family: "DejaVu Sans", Arial, Helvetica; font-weight: 300; font-style: italic; } +.tableblock > caption { text-align: left; font-family: "DejaVu Sans", Arial, Helvetica; font-weight: 300; font-style: italic; white-space: nowrap; overflow: visible; max-width: 0; } +table.tableblock #preamble > .sectionbody > .paragraph:first-of-type p { font-size: inherit; } +div.block .admonitionblock > table { border: 0; background: none; width: 100%; } +.admonitionblock > table td.icon { text-align: center; width: 80px; } +.admonitionblock > table td.icon img { max-width: none; } +.admonitionblock > table td.icon .title { font-weight: 300; text-transform: uppercase; } +.admonitionblock > table td.content { padding-left: 1.125em; padding-right: 1.25em; border-left: 1px solid #d8d8d8; color: #6e6e6e; } +.admonitionblock > table td.content > :last-child > :last-child { margin-bottom: 0; } +.exampleblock > .content { border-style: solid; border-width: 1px; border-color: #e6e6e6; margin-bottom: 1.25em; padding: 1.25em; background: white; -webkit-border-radius: 4px; border-radius: 4px; } +.exampleblock > .content > :first-child { margin-top: 0; } +.exampleblock > .content > :last-child { margin-bottom: 0; } +.exampleblock > .content h1, .exampleblock > .content h2, .exampleblock > .content h3, .exampleblock > .content #toctitle, .sidebarblock.exampleblock > .content > .title, .exampleblock > .content h4, .exampleblock > .content h5, .exampleblock > .content h6, .exampleblock > .content p { color: #333333; } +.exampleblock > .content h1, .exampleblock > .content h2, .exampleblock > .content h3, .exampleblock > .content #toctitle, .sidebarblock.exampleblock > .content > .title, .exampleblock > .content h4, .exampleblock > .content h5, .exampleblock > .content h6 { line-height: 1; margin-bottom: 0.625em; } +.exampleblock > .content h1.subheader, .exampleblock > .content h2.subheader, .exampleblock > .content h3.subheader, .exampleblock > .content .subheader#toctitle, .sidebarblock.exampleblock > .content > .subheader.title, .exampleblock > .content h4.subheader, .exampleblock > .content h5.subheader, .exampleblock > .content h6.subheader { line-height: 1.4; } +.exampleblock.result > .content { -webkit-box-shadow: 0 1px 8px #e3e3dd; box-shadow: 0 1px 8px #e3e3dd; } +.sidebarblock { border-style: solid; border-width: 1px; border-color: #e3e3dd; margin-bottom: 1.25em; padding: 1.25em; background: #fafaf9; -webkit-border-radius: 4px; border-radius: 4px; } +.sidebarblock > :first-child { margin-top: 0; } +.sidebarblock > :last-child { margin-bottom: 0; } +.sidebarblock h1, .sidebarblock h2, .sidebarblock h3, .sidebarblock #toctitle, .sidebarblock > .content > .title, .sidebarblock h4, .sidebarblock h5, .sidebarblock h6, .sidebarblock p { color: #333333; } +.sidebarblock h1, .sidebarblock h2, .sidebarblock h3, .sidebarblock #toctitle, .sidebarblock > .content > .title, .sidebarblock h4, .sidebarblock h5, .sidebarblock h6 { line-height: 1; margin-bottom: 0.625em; } +.sidebarblock h1.subheader, .sidebarblock h2.subheader, .sidebarblock h3.subheader, .sidebarblock .subheader#toctitle, .sidebarblock > .content > .subheader.title, .sidebarblock h4.subheader, .sidebarblock h5.subheader, .sidebarblock h6.subheader { line-height: 1.4; } +.sidebarblock > .content > .title { color: #7a4a0e; margin-top: 0; line-height: 1.6; } +.exampleblock > .content > :last-child > :last-child, .exampleblock > .content .olist > ol > li:last-child > :last-child, .exampleblock > .content .ulist > ul > li:last-child > :last-child, .exampleblock > .content .qlist > ol > li:last-child > :last-child, .sidebarblock > .content > :last-child > :last-child, .sidebarblock > .content .olist > ol > li:last-child > :last-child, .sidebarblock > .content .ulist > ul > li:last-child > :last-child, .sidebarblock > .content .qlist > ol > li:last-child > :last-child { margin-bottom: 0; } +.literalblock pre,.listingblock pre:not(.highlight),.listingblock pre[class="highlight"],.listingblock pre[class^="highlight "],.listingblock pre.CodeRay{ background: #f7f7f7 } +.literalblock pre,.literalblock pre[class],.listingblock pre,.listingblock pre[class]{-webkit-border-radius:4px;border-radius:4px;word-wrap:break-word;padding:1em;font-size:.8125em} +.literalblock pre.nowrap,.literalblock pre[class].nowrap,.listingblock pre.nowrap,.listingblock pre[class].nowrap{overflow-x:auto;white-space:pre;word-wrap:normal} +.listingblock>.content{position:relative} +.listingblock code[data-lang]:before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:#999} +.listingblock:hover code[data-lang]:before{display:block} +.listingblock.terminal pre .command:before{content:attr(data-prompt);padding-right:.5em;color:#999} +.listingblock.terminal pre .command:not([data-prompt]):before{content:"$"} + +.quoteblock { margin: 0 0 1.25em 0; padding: 0.5625em 1.25em 0 1.1875em; border-left: 3px solid #487c58; } +.quoteblock blockquote { margin: 0 0 1.25em 0; padding: 0 0 0.625em 0; border: 0; } +.quoteblock blockquote > .paragraph:last-child p { margin-bottom: 0; } +.quoteblock .attribution { margin-top: -0.625em; padding-bottom: 0.625em; font-size: inherit; color: #454545; line-height: 1.6; } +.quoteblock .attribution br { display: none; } +.quoteblock .attribution cite { display: block; } + +table.tableblock{max-width:100%;border-collapse:separate;border-spacing:0} +table.tableblock td>.paragraph:last-child p>p:last-child,table.tableblock th>p:last-child,table.tableblock td>p:last-child{margin-bottom:0} +table.spread{width:100%} +table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede} +table.grid-all th.tableblock,table.grid-all td.tableblock{border-width:0 1px 1px 0} +table.grid-all tfoot>tr>th.tableblock,table.grid-all tfoot>tr>td.tableblock{border-width:1px 1px 0 0} +table.grid-cols th.tableblock,table.grid-cols td.tableblock{border-width:0 1px 0 0} +table.grid-all *>tr>.tableblock:last-child,table.grid-cols *>tr>.tableblock:last-child{border-right-width:0} +table.grid-rows th.tableblock,table.grid-rows td.tableblock{border-width:0 0 1px 0} +table.grid-all tbody>tr:last-child>th.tableblock,table.grid-all tbody>tr:last-child>td.tableblock,table.grid-all thead:last-child>tr>th.tableblock,table.grid-rows tbody>tr:last-child>th.tableblock,table.grid-rows tbody>tr:last-child>td.tableblock,table.grid-rows thead:last-child>tr>th.tableblock{border-bottom-width:0} +table.grid-rows tfoot>tr>th.tableblock,table.grid-rows tfoot>tr>td.tableblock{border-width:1px 0 0 0} +table.frame-all{border-width:1px} +table.frame-sides{border-width:0 1px} +table.frame-topbot{border-width:1px 0} +th.halign-left,td.halign-left{text-align:left} +th.halign-right,td.halign-right{text-align:right} +th.halign-center,td.halign-center{text-align:center} +th.valign-top,td.valign-top{vertical-align:top} +th.valign-bottom,td.valign-bottom{vertical-align:bottom} +th.valign-middle,td.valign-middle{vertical-align:middle} + +.dlist dl dd, .contentContainer .description .dlist dl dd, .contentContainer .details .dlist dl dd { margin-left: 1.125em; } + +.contentContainer hr { + border: 0 solid #ddddd8; + border-top-width: 1px; + height: 0; + margin: 1em 0 1.25em 0; +} + +.contentContainer hr + br { + display: none; +} + +p.tableblock { + margin-top: .5em; + margin-bottom: 0; +} + +/* Javadoc puts its output inside a