<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="de">
<head>
<!-- Generated by javadoc -->
<title>StandardNumber (standardnumber 1.0.0 API)</title>
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="StandardNumber (standardnumber 1.0.0 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":10,"i8":10,"i9":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../org/xbib/standardnumber/SICI.html" title="class in org.xbib.standardnumber"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../org/xbib/standardnumber/StandardNumberSpi.html" title="class in org.xbib.standardnumber"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/xbib/standardnumber/StandardNumber.html" target="_top">Frames</a></li>
<li><a href="StandardNumber.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field.summary">Field</a> | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field.detail">Field</a> | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.xbib.standardnumber</div>
<h2 title="Class StandardNumber" class="title">Class StandardNumber</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../org/xbib/standardnumber/StandardNumberSpi.html" title="class in org.xbib.standardnumber">org.xbib.standardnumber.StandardNumberSpi</a></li>
<li>
<ul class="inheritance">
<li>org.xbib.standardnumber.StandardNumber</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../org/xbib/standardnumber/ARK.html" title="class in org.xbib.standardnumber">ARK</a>, <a href="../../../org/xbib/standardnumber/DOI.html" title="class in org.xbib.standardnumber">DOI</a>, <a href="../../../org/xbib/standardnumber/EAN.html" title="class in org.xbib.standardnumber">EAN</a>, <a href="../../../org/xbib/standardnumber/GTIN.html" title="class in org.xbib.standardnumber">GTIN</a>, <a href="../../../org/xbib/standardnumber/IBAN.html" title="class in org.xbib.standardnumber">IBAN</a>, <a href="../../../org/xbib/standardnumber/ISAN.html" title="class in org.xbib.standardnumber">ISAN</a>, <a href="../../../org/xbib/standardnumber/ISBN.html" title="class in org.xbib.standardnumber">ISBN</a>, <a href="../../../org/xbib/standardnumber/ISMN.html" title="class in org.xbib.standardnumber">ISMN</a>, <a href="../../../org/xbib/standardnumber/ISNI.html" title="class in org.xbib.standardnumber">ISNI</a>, <a href="../../../org/xbib/standardnumber/ISSN.html" title="class in org.xbib.standardnumber">ISSN</a>, <a href="../../../org/xbib/standardnumber/ISTC.html" title="class in org.xbib.standardnumber">ISTC</a>, <a href="../../../org/xbib/standardnumber/ISWC.html" title="class in org.xbib.standardnumber">ISWC</a>, <a href="../../../org/xbib/standardnumber/PPN.html" title="class in org.xbib.standardnumber">PPN</a>, <a href="../../../org/xbib/standardnumber/SICI.html" title="class in org.xbib.standardnumber">SICI</a>, <a href="../../../org/xbib/standardnumber/UPC.html" title="class in org.xbib.standardnumber">UPC</a>, <a href="../../../org/xbib/standardnumber/ZDB.html" title="class in org.xbib.standardnumber">ZDB</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">StandardNumber</span>
extends <a href="../../../org/xbib/standardnumber/StandardNumberSpi.html" title="class in org.xbib.standardnumber">StandardNumberSpi</a></pre>
<div class="block"><p>Standard number implementation. A standard number is a number that</p>
<div class="ulist">
<ul>
<li>
<p>is backed by an international standard or a de-facto community use</p>
</li>
<li>
<p>can accept alphanumeric values (digits and letters and separator characters)</p>
</li>
<li>
<p>can be normalizedValue</p>
</li>
<li>
<p>can be verified and raise en error is verification fails</p>
</li>
<li>
<p>must have a createChecksum</p>
</li>
<li>
<p>can be formatted to a printable representation</p>
</li>
</ul>
</div></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/xbib/standardnumber/StandardNumber.html#type">type</a></span></code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/xbib/standardnumber/StandardNumber.html#value">value</a></span></code> </td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier</th>
<th class="colLast" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected </code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/xbib/standardnumber/StandardNumber.html#StandardNumber-java.lang.String-">StandardNumber</a></span>(java.lang.String type)</code> </td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>abstract <a href="../../../org/xbib/standardnumber/StandardNumber.html" title="class in org.xbib.standardnumber">StandardNumber</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/xbib/standardnumber/StandardNumber.html#createChecksum-boolean-">createChecksum</a></span>(boolean withChecksum)</code>
<div class="block">Indicate that a correct check sum should be computed.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>abstract java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/xbib/standardnumber/StandardNumber.html#format--">format</a></span>()</code>
<div class="block">Return a formatted value of this standard number
This is best for human-readable representation, but is
not necessarily a format for computation.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>abstract java.util.Collection<java.lang.String></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/xbib/standardnumber/StandardNumber.html#getTypedVariants--">getTypedVariants</a></span>()</code> </td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>abstract boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/xbib/standardnumber/StandardNumber.html#isValid--">isValid</a></span>()</code>
<div class="block">Check this number for validity.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>abstract <a href="../../../org/xbib/standardnumber/StandardNumber.html" title="class in org.xbib.standardnumber">StandardNumber</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/xbib/standardnumber/StandardNumber.html#normalize--">normalize</a></span>()</code>
<div class="block">Normalize the value by removing all unwanted characters or
replacing characters with the ones required for verification.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>abstract java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/xbib/standardnumber/StandardNumber.html#normalizedValue--">normalizedValue</a></span>()</code>
<div class="block">Return normalized value of this standard number.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>abstract <a href="../../../org/xbib/standardnumber/StandardNumber.html" title="class in org.xbib.standardnumber">StandardNumber</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/xbib/standardnumber/StandardNumber.html#reset--">reset</a></span>()</code> </td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="../../../org/xbib/standardnumber/StandardNumber.html" title="class in org.xbib.standardnumber">StandardNumber</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/xbib/standardnumber/StandardNumber.html#set-java.lang.CharSequence-">set</a></span>(java.lang.CharSequence value)</code>
<div class="block">Set the input value of this standard number.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/xbib/standardnumber/StandardNumber.html#type--">type</a></span>()</code>
<div class="block">Return the type of this standard number.</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>abstract <a href="../../../org/xbib/standardnumber/StandardNumber.html" title="class in org.xbib.standardnumber">StandardNumber</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/xbib/standardnumber/StandardNumber.html#verify--">verify</a></span>()</code>
<div class="block">Verify the number.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.xbib.standardnumber.StandardNumberSpi">
<!-- -->
</a>
<h3>Methods inherited from class org.xbib.standardnumber.<a href="../../../org/xbib/standardnumber/StandardNumberSpi.html" title="class in org.xbib.standardnumber">StandardNumberSpi</a></h3>
<code><a href="../../../org/xbib/standardnumber/StandardNumberSpi.html#clone--">clone</a>, <a href="../../../org/xbib/standardnumber/StandardNumberSpi.html#getInstance-java.lang.Package-java.lang.ClassLoader-java.lang.String-">getInstance</a>, <a href="../../../org/xbib/standardnumber/StandardNumberSpi.html#getInstance-java.lang.String-">getInstance</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="type">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>type</h4>
<pre>protected final java.lang.String type</pre>
</li>
</ul>
<a name="value">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>value</h4>
<pre>protected java.lang.String value</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="StandardNumber-java.lang.String-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>StandardNumber</h4>
<pre>protected StandardNumber(java.lang.String type)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="type--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>type</h4>
<pre>public java.lang.String type()</pre>
<div class="block"><p>Return the type of this standard number.</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the type</dd>
</dl>
</li>
</ul>
<a name="set-java.lang.CharSequence-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>set</h4>
<pre>public <a href="../../../org/xbib/standardnumber/StandardNumber.html" title="class in org.xbib.standardnumber">StandardNumber</a> set(java.lang.CharSequence value)</pre>
<div class="block"><p>Set the input value of this standard number. The input must be normalized
and verified before being accepted as valid.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - the raw input value</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this standard number</dd>
</dl>
</li>
</ul>
<a name="normalize--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>normalize</h4>
<pre>public abstract <a href="../../../org/xbib/standardnumber/StandardNumber.html" title="class in org.xbib.standardnumber">StandardNumber</a> normalize()</pre>
<div class="block"><p>Normalize the value by removing all unwanted characters or
replacing characters with the ones required for verification.</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this standard number</dd>
</dl>
</li>
</ul>
<a name="isValid--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isValid</h4>
<pre>public abstract boolean isValid()</pre>
<div class="block"><p>Check this number for validity.</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if valid, false otherwise</dd>
</dl>
</li>
</ul>
<a name="verify--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>verify</h4>
<pre>public abstract <a href="../../../org/xbib/standardnumber/StandardNumber.html" title="class in org.xbib.standardnumber">StandardNumber</a> verify()</pre>
<div class="block"><p>Verify the number.</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this standard number if verification was successful</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.lang.NumberFormatException</code> - if verification failed</dd>
</dl>
</li>
</ul>
<a name="createChecksum-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createChecksum</h4>
<pre>public abstract <a href="../../../org/xbib/standardnumber/StandardNumber.html" title="class in org.xbib.standardnumber">StandardNumber</a> createChecksum(boolean withChecksum)</pre>
<div class="block"><p>Indicate that a correct check sum should be computed.</p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>withChecksum</code> - if checksum is included</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this standard number</dd>
</dl>
</li>
</ul>
<a name="normalizedValue--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>normalizedValue</h4>
<pre>public abstract java.lang.String normalizedValue()</pre>
<div class="block"><p>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.</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the normalized value</dd>
</dl>
</li>
</ul>
<a name="format--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>format</h4>
<pre>public abstract java.lang.String format()</pre>
<div class="block"><p>Return a formatted value of this standard number
This is best for human-readable representation, but is
not necessarily a format for computation.</p></div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a formatted value</dd>
</dl>
</li>
</ul>
<a name="reset--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reset</h4>
<pre>public abstract <a href="../../../org/xbib/standardnumber/StandardNumber.html" title="class in org.xbib.standardnumber">StandardNumber</a> reset()</pre>
</li>
</ul>
<a name="getTypedVariants--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getTypedVariants</h4>
<pre>public abstract java.util.Collection<java.lang.String> getTypedVariants()</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../org/xbib/standardnumber/SICI.html" title="class in org.xbib.standardnumber"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../org/xbib/standardnumber/StandardNumberSpi.html" title="class in org.xbib.standardnumber"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/xbib/standardnumber/StandardNumber.html" target="_top">Frames</a></li>
<li><a href="StandardNumber.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li><a href="#field.summary">Field</a> | </li>
<li><a href="#constructor.summary">Constr</a> | </li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li><a href="#field.detail">Field</a> | </li>
<li><a href="#constructor.detail">Constr</a> | </li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>