Google Git
Sign in
apache / daffodil-site / 5a1180148a9e16cffe85c4758b76b8866ba01f41 / . / site / docs / 3.2.0 / javadoc / org / apache / daffodil / japi / infoset / InfosetInputter.html
blob: 11fee9791cc1cc995b8ba93a3b8219065b299c25 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>InfosetInputter (Apache Daffodil 3.2.0 Java 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="InfosetInputter (Apache Daffodil 3.2.0 Java API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":10,"i5":6,"i6":6,"i7":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>Prev&nbsp;Class</li>
<li><a href="../../../../../org/apache/daffodil/japi/infoset/InfosetInputterProxy.html" title="class in org.apache.daffodil.japi.infoset"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/daffodil/japi/infoset/InfosetInputter.html" target="_top">Frames</a></li>
<li><a href="InfosetInputter.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>Field&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>Field&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.apache.daffodil.japi.infoset</div>
<h2 title="Class InfosetInputter" class="title">Class InfosetInputter</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.daffodil.infoset.InfosetInputter</li>
<li>
<ul class="inheritance">
<li>org.apache.daffodil.japi.infoset.InfosetInputter</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>org.apache.daffodil.infoset.NextElementResolver, org.apache.daffodil.util.Cursor&lt;org.apache.daffodil.infoset.InfosetAccessor&gt;, org.apache.daffodil.util.CursorImplMixin&lt;org.apache.daffodil.infoset.InfosetAccessor&gt;</dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../org/apache/daffodil/japi/infoset/InfosetInputterProxy.html" title="class in org.apache.daffodil.japi.infoset">InfosetInputterProxy</a></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">InfosetInputter</span>
extends org.apache.daffodil.infoset.InfosetInputter</pre>
<div class="block">Abstract class used to determine how the infoset representation should be
input from a call to DataProcessor#unparse. This uses a Cursor API, such
that each call to advance/inspect must update a cursor value, minimizing
allocations. Callers of advance/inspect are expected to copy out any
information from advanceAccessor and inspectAccessor if they need to retain
the information after a call to advance/inspect.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.org.apache.daffodil.util.CursorImplMixin">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;org.apache.daffodil.util.CursorImplMixin</h3>
<code>org.apache.daffodil.util.CursorImplMixin.Advance$, org.apache.daffodil.util.CursorImplMixin.Inspect$, org.apache.daffodil.util.CursorImplMixin.OpKind, org.apache.daffodil.util.CursorImplMixin.Unsuccessful$</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/apache/daffodil/japi/infoset/InfosetInputter.html#InfosetInputter--">InfosetInputter</a></span>()</code>&nbsp;</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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract 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>abstract org.apache.daffodil.infoset.InfosetInputterEventType</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/daffodil/japi/infoset/InfosetInputter.html#getEventType--">getEventType</a></span>()</code>
<div class="block">Return the current infoset inputter event type</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/apache/daffodil/japi/infoset/InfosetInputter.html#getLocalName--">getLocalName</a></span>()</code>
<div class="block">Get the local name of the current event.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>abstract java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/daffodil/japi/infoset/InfosetInputter.html#getNamespaceURI--">getNamespaceURI</a></span>()</code>
<div class="block">Get the namespace of the current event.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>abstract java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/daffodil/japi/infoset/InfosetInputter.html#getSimpleText-org.apache.daffodil.dpath.NodeInfo.Kind-">getSimpleText</a></span>(org.apache.daffodil.dpath.NodeInfo.Kind&nbsp;primType)</code>
<div class="block">See getSimpleText(primType, runtimeProperties), which has a default
implementation to call this function without the runtimeProperties Map</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/daffodil/japi/infoset/InfosetInputter.html#getSimpleText-org.apache.daffodil.dpath.NodeInfo.Kind-java.util.Map-">getSimpleText</a></span>(org.apache.daffodil.dpath.NodeInfo.Kind&nbsp;primType,
java.util.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;runtimeProperties)</code>
<div class="block">Get the content of a simple type.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>abstract boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/daffodil/japi/infoset/InfosetInputter.html#hasNext--">hasNext</a></span>()</code>
<div class="block">Return true if there are remaining events.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>abstract org.apache.daffodil.util.MaybeBoolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/daffodil/japi/infoset/InfosetInputter.html#isNilled--">isNilled</a></span>()</code>
<div class="block">Determine if the current event is nilled.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>abstract void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../org/apache/daffodil/japi/infoset/InfosetInputter.html#next--">next</a></span>()</code>
<div class="block">Move the internal state to the next event.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.daffodil.infoset.InfosetInputter">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.daffodil.infoset.InfosetInputter</h3>
<code>accessor_$eq, accessor, advance, Advance, advanceAccessor, advanceMaybe, documentElement, fill, initialize, inspect, Inspect, inspectAccessor, inspectMaybe, isInitialized, maybeTopTRD, nextElement, org$apache$daffodil$infoset$NextElementResolver$_setter_$org$apache$daffodil$infoset$NextElementResolver$$trdStack_$eq, org$apache$daffodil$infoset$NextElementResolver$$trdStack, org$apache$daffodil$util$CursorImplMixin$$isFilled_$eq, org$apache$daffodil$util$CursorImplMixin$$isFilled, popTRD, priorOpKind_$eq, priorOpKind, pushTRD, supportsNamespaces, toString, tunable_$eq, tunable, Unsuccessful</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, wait, wait, wait</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.daffodil.util.CursorImplMixin">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.daffodil.util.CursorImplMixin</h3>
<code>$init$</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.daffodil.util.Cursor">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.daffodil.util.Cursor</h3>
<code>$init$, fini</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.apache.daffodil.infoset.NextElementResolver">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;org.apache.daffodil.infoset.NextElementResolver</h3>
<code>$init$</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="InfosetInputter--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>InfosetInputter</h4>
<pre>public&nbsp;InfosetInputter()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getEventType--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEventType</h4>
<pre>public abstract&nbsp;org.apache.daffodil.infoset.InfosetInputterEventType&nbsp;getEventType()</pre>
<div class="block">Return the current infoset inputter event type</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getEventType</code>&nbsp;in class&nbsp;<code>org.apache.daffodil.infoset.InfosetInputter</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>(undocumented)</dd>
</dl>
</li>
</ul>
<a name="getLocalName--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLocalName</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;getLocalName()</pre>
<div class="block">Get the local name of the current event. This will only be called when the
current event type is StartElement.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getLocalName</code>&nbsp;in class&nbsp;<code>org.apache.daffodil.infoset.InfosetInputter</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>(undocumented)</dd>
</dl>
</li>
</ul>
<a name="getNamespaceURI--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNamespaceURI</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;getNamespaceURI()</pre>
<div class="block">Get the namespace of the current event. This will only be called when the
current event type is StartElement. If the InfosetInputter does not
support namespaces, this shoud return null. This may return null to
represent no namespaces.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getNamespaceURI</code>&nbsp;in class&nbsp;<code>org.apache.daffodil.infoset.InfosetInputter</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>(undocumented)</dd>
</dl>
</li>
</ul>
<a name="getSimpleText-org.apache.daffodil.dpath.NodeInfo.Kind-java.util.Map-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSimpleText</h4>
<pre>public&nbsp;java.lang.String&nbsp;getSimpleText(org.apache.daffodil.dpath.NodeInfo.Kind&nbsp;primType,
java.util.Map&lt;java.lang.String,java.lang.String&gt;&nbsp;runtimeProperties)</pre>
<div class="block">Get the content of a simple type. This will only be called when the
current event type is StartElement and the element is a simple type. If
the event contains complex data, it is an error and should throw
NonTextFoundInSimpleContentException. If the element does not have any
simple content, this should return either null or the empty string.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>getSimpleText</code>&nbsp;in class&nbsp;<code>org.apache.daffodil.infoset.InfosetInputter</code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>primType</code> - (undocumented)</dd>
<dd><code>runtimeProperties</code> - (undocumented)</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>(undocumented)</dd>
</dl>
</li>
</ul>
<a name="getSimpleText-org.apache.daffodil.dpath.NodeInfo.Kind-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSimpleText</h4>
<pre>public abstract&nbsp;java.lang.String&nbsp;getSimpleText(org.apache.daffodil.dpath.NodeInfo.Kind&nbsp;primType)</pre>
<div class="block">See getSimpleText(primType, runtimeProperties), which has a default
implementation to call this function without the runtimeProperties Map</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>primType</code> - (undocumented)</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>(undocumented)</dd>
</dl>
</li>
</ul>
<a name="hasNext--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>hasNext</h4>
<pre>public abstract&nbsp;boolean&nbsp;hasNext()</pre>
<div class="block">Return true if there are remaining events. False otherwise.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>hasNext</code>&nbsp;in class&nbsp;<code>org.apache.daffodil.infoset.InfosetInputter</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>(undocumented)</dd>
</dl>
</li>
</ul>
<a name="isNilled--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isNilled</h4>
<pre>public abstract&nbsp;org.apache.daffodil.util.MaybeBoolean&nbsp;isNilled()</pre>
<div class="block">Determine if the current event is nilled. This will only be called when
the current event type is StartElement. Return MaybeBoolean.Nope if no
nil property is set, which implies the element is not nilled. Return
MaybeBoolean(false) if the nil property is set, but it is set to false.
Return MaybeBoolean(true) if the nil property is set to true.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>(undocumented)</dd>
</dl>
</li>
</ul>
<a name="next--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>next</h4>
<pre>public abstract&nbsp;void&nbsp;next()</pre>
<div class="block">Move the internal state to the next event.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code>next</code>&nbsp;in class&nbsp;<code>org.apache.daffodil.infoset.InfosetInputter</code></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><a href="../../../../../org/apache/daffodil/japi/infoset/InfosetInputterProxy.html" title="class in org.apache.daffodil.japi.infoset"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/daffodil/japi/infoset/InfosetInputter.html" target="_top">Frames</a></li>
<li><a href="InfosetInputter.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>Field&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>Field&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>