marc/docs/javadoc/org/xbib/marc/dialects/sisis/SisisInputStream.html

507 lines
19 KiB
HTML

<!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>SisisInputStream (marc 1.0.8 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="SisisInputStream (marc 1.0.8 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance 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>Prev&nbsp;Class</li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/xbib/marc/dialects/sisis/SisisInputStream.html" target="_top">Frames</a></li>
<li><a href="SisisInputStream.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</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.marc.dialects.sisis</div>
<h2 title="Class SisisInputStream" class="title">Class SisisInputStream</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>java.io.InputStream</li>
<li>
<ul class="inheritance">
<li>java.io.FilterInputStream</li>
<li>
<ul class="inheritance">
<li>java.io.BufferedInputStream</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/xbib/marc/io/PatternInputStream.html" title="class in org.xbib.marc.io">org.xbib.marc.io.PatternInputStream</a></li>
<li>
<ul class="inheritance">
<li>org.xbib.marc.dialects.sisis.SisisInputStream</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.io.Closeable, java.lang.AutoCloseable, <a href="../../../../../org/xbib/marc/io/ChunkStream.html" title="interface in org.xbib.marc.io">ChunkStream</a>&lt;byte[],<a href="../../../../../org/xbib/marc/io/BytesReference.html" title="interface in org.xbib.marc.io">BytesReference</a>&gt;</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">SisisInputStream</span>
extends <a href="../../../../../org/xbib/marc/io/PatternInputStream.html" title="class in org.xbib.marc.io">PatternInputStream</a></pre>
<div class="block">An input stream for reading SISIS format, a dialect of MARC.
Example:
<code>
0000:248821
0002:04.03.2009
0014.001:61 P 08/09-36B
0015.001:ger
0029.001:06
0100.001:Beimdiek, Christoph
0101.001:Hanrath, Wilhelm [Betreuer]
0331.001:Portierung des webbasierten multimedialen Lehr- und Lernsystems NUMAS zur numerischen Mathematik
und Statistik auf ein Linux-basiertes Serversystem
0425:2008
0519.001:Aachen, FH, Bachelorarbeit, 2008
9999:
0000:468277
0002:13.12.2013
0014.001:61 EU 13-46B
0015.001:eng
0029.001:06
0100.001:Belouanas, Abdel
0101.001:Helsper, Christoph [Betreuer]
0331.001:A proposal for future clean power production for morocco
0425:2013
0519.001:Aachen, FH, Bachelorarbeit, 2013
9999:
</code></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">&nbsp;</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 int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/xbib/marc/dialects/sisis/SisisInputStream.html#begin">begin</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected byte[]</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/xbib/marc/dialects/sisis/SisisInputStream.html#buffer">buffer</a></span></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/xbib/marc/dialects/sisis/SisisInputStream.html#end">end</a></span></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected <a href="../../../../../org/xbib/marc/io/BytesStreamOutput.html" title="class in org.xbib.marc.io">BytesStreamOutput</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/xbib/marc/dialects/sisis/SisisInputStream.html#ref">ref</a></span></code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.java.io.BufferedInputStream">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;java.io.BufferedInputStream</h3>
<code>buf, count, marklimit, markpos, pos</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.java.io.FilterInputStream">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;java.io.FilterInputStream</h3>
<code>in</code></li>
</ul>
</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">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../org/xbib/marc/dialects/sisis/SisisInputStream.html#SisisInputStream-java.io.InputStream-byte:A-org.xbib.marc.MarcGenerator-">SisisInputStream</a></span>(java.io.InputStream&nbsp;in,
byte[]&nbsp;pattern,
<a href="../../../../../org/xbib/marc/MarcGenerator.html" title="class in org.xbib.marc">MarcGenerator</a>&nbsp;marcGenerator)</code>
<div class="block">Create a SISIS input stream.</div>
</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">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</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>java.util.stream.Stream&lt;<a href="../../../../../org/xbib/marc/io/Chunk.html" title="interface in org.xbib.marc.io">Chunk</a>&lt;byte[],<a href="../../../../../org/xbib/marc/io/BytesReference.html" title="interface in org.xbib.marc.io">BytesReference</a>&gt;&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/xbib/marc/dialects/sisis/SisisInputStream.html#chunks--">chunks</a></span>()</code>
<div class="block">This methods creates a Java 8 stream of chunks.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/xbib/marc/dialects/sisis/SisisInputStream.html#close--">close</a></span>()</code>&nbsp;</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>protected void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/xbib/marc/dialects/sisis/SisisInputStream.html#processChunk-org.xbib.marc.io.Chunk-">processChunk</a></span>(<a href="../../../../../org/xbib/marc/io/Chunk.html" title="interface in org.xbib.marc.io">Chunk</a>&lt;byte[],<a href="../../../../../org/xbib/marc/io/BytesReference.html" title="interface in org.xbib.marc.io">BytesReference</a>&gt;&nbsp;chunk)</code>
<div class="block">This method can be overriden by classes to extend the processing of a chunk
before it is returned to the caller.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.xbib.marc.io.PatternInputStream">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.xbib.marc.io.<a href="../../../../../org/xbib/marc/io/PatternInputStream.html" title="class in org.xbib.marc.io">PatternInputStream</a></h3>
<code><a href="../../../../../org/xbib/marc/io/PatternInputStream.html#crlf-java.io.InputStream-">crlf</a>, <a href="../../../../../org/xbib/marc/io/PatternInputStream.html#lf-java.io.InputStream-">lf</a>, <a href="../../../../../org/xbib/marc/io/PatternInputStream.html#readChunk--">readChunk</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.io.BufferedInputStream">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.io.BufferedInputStream</h3>
<code>available, mark, markSupported, read, read, reset, skip</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.io.FilterInputStream">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.io.FilterInputStream</h3>
<code>read</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, 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="ref">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ref</h4>
<pre>protected final&nbsp;<a href="../../../../../org/xbib/marc/io/BytesStreamOutput.html" title="class in org.xbib.marc.io">BytesStreamOutput</a> ref</pre>
</li>
</ul>
<a name="buffer">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>buffer</h4>
<pre>protected&nbsp;byte[] buffer</pre>
</li>
</ul>
<a name="begin">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>begin</h4>
<pre>protected&nbsp;int begin</pre>
</li>
</ul>
<a name="end">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>end</h4>
<pre>protected&nbsp;int end</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="SisisInputStream-java.io.InputStream-byte:A-org.xbib.marc.MarcGenerator-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>SisisInputStream</h4>
<pre>public&nbsp;SisisInputStream(java.io.InputStream&nbsp;in,
byte[]&nbsp;pattern,
<a href="../../../../../org/xbib/marc/MarcGenerator.html" title="class in org.xbib.marc">MarcGenerator</a>&nbsp;marcGenerator)</pre>
<div class="block">Create a SISIS input stream.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>in</code> - the underlying input stream</dd>
<dd><code>pattern</code> - the pattern for the separator</dd>
<dd><code>marcGenerator</code> - a MARC generator</dd>
</dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="processChunk-org.xbib.marc.io.Chunk-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>processChunk</h4>
<pre>protected&nbsp;void&nbsp;processChunk(<a href="../../../../../org/xbib/marc/io/Chunk.html" title="interface in org.xbib.marc.io">Chunk</a>&lt;byte[],<a href="../../../../../org/xbib/marc/io/BytesReference.html" title="interface in org.xbib.marc.io">BytesReference</a>&gt;&nbsp;chunk)
throws java.io.IOException</pre>
<div class="block"><span class="descfrmTypeLabel">Description copied from class:&nbsp;<code><a href="../../../../../org/xbib/marc/io/PatternInputStream.html#processChunk-org.xbib.marc.io.Chunk-">PatternInputStream</a></code></span></div>
<div class="block">This method can be overriden by classes to extend the processing of a chunk
before it is returned to the caller.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code><a href="../../../../../org/xbib/marc/io/PatternInputStream.html#processChunk-org.xbib.marc.io.Chunk-">processChunk</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../org/xbib/marc/io/PatternInputStream.html" title="class in org.xbib.marc.io">PatternInputStream</a></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>chunk</code> - the chunk to be processed.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if chunk processing fails</dd>
</dl>
</li>
</ul>
<a name="close--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>public&nbsp;void&nbsp;close()
throws java.io.IOException</pre>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>close</code>&nbsp;in interface&nbsp;<code>java.io.Closeable</code></dd>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>close</code>&nbsp;in interface&nbsp;<code>java.lang.AutoCloseable</code></dd>
<dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
<dd><code>close</code>&nbsp;in class&nbsp;<code>java.io.BufferedInputStream</code></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code></dd>
</dl>
</li>
</ul>
<a name="chunks--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>chunks</h4>
<pre>public&nbsp;java.util.stream.Stream&lt;<a href="../../../../../org/xbib/marc/io/Chunk.html" title="interface in org.xbib.marc.io">Chunk</a>&lt;byte[],<a href="../../../../../org/xbib/marc/io/BytesReference.html" title="interface in org.xbib.marc.io">BytesReference</a>&gt;&gt;&nbsp;chunks()</pre>
<div class="block">This methods creates a Java 8 stream of chunks.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../../org/xbib/marc/io/ChunkStream.html#chunks--">chunks</a></code>&nbsp;in interface&nbsp;<code><a href="../../../../../org/xbib/marc/io/ChunkStream.html" title="interface in org.xbib.marc.io">ChunkStream</a>&lt;byte[],<a href="../../../../../org/xbib/marc/io/BytesReference.html" title="interface in org.xbib.marc.io">BytesReference</a>&gt;</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a stream of chunks</dd>
</dl>
</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>Prev&nbsp;Class</li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/xbib/marc/dialects/sisis/SisisInputStream.html" target="_top">Frames</a></li>
<li><a href="SisisInputStream.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All&nbsp;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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>