Google Git
Sign in
apache / daffodil-site / 5a1180148a9e16cffe85c4758b76b8866ba01f41 / . / site / docs / 3.2.0 / javadoc / org / apache / daffodil / japi / Compiler.html
blob: e53c5740269ae6dd6d6ca88ffa2ac126de730907 [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>Compiler (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="Compiler (Apache Daffodil 3.2.0 Java API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":42,"i7":42,"i8":42,"i9":42,"i10":42,"i11":42,"i12":42,"i13":10,"i14":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated 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/Daffodil.html" title="class in org.apache.daffodil.japi"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/daffodil/japi/Compiler.html" target="_top">Frames</a></li>
<li><a href="Compiler.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</div>
<h2 title="Class Compiler" class="title">Class Compiler</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.daffodil.japi.Compiler</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="typeNameLabel">Compiler</span>
extends java.lang.Object</pre>
<div class="block">Compile DFDL schemas into <a href="../../../../org/apache/daffodil/japi/ProcessorFactory.html" title="class in org.apache.daffodil.japi"><code>ProcessorFactory</code></a>'s or reload saved parsers into <a href="../../../../org/apache/daffodil/japi/DataProcessor.html" title="class in org.apache.daffodil.japi"><code>DataProcessor</code></a>'s.
<p>
Do not use the Compiler constructor to create a Compiler. Instead, use <a href="../../../../org/apache/daffodil/japi/Daffodil.html#compiler--"><code>Daffodil.compiler()</code></a>.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== 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/Compiler.html#Compiler-org.apache.daffodil.compiler.Compiler-">Compiler</a></span>(org.apache.daffodil.compiler.Compiler&nbsp;sCompiler)</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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated 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><a href="../../../../org/apache/daffodil/japi/ProcessorFactory.html" title="class in org.apache.daffodil.japi">ProcessorFactory</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/daffodil/japi/Compiler.html#compileFile-java.io.File-">compileFile</a></span>(java.io.File&nbsp;schemaFile)</code>
<div class="block">Compile DFDL schema file into a <a href="../../../../org/apache/daffodil/japi/ProcessorFactory.html" title="class in org.apache.daffodil.japi"><code>ProcessorFactory</code></a></div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/daffodil/japi/ProcessorFactory.html" title="class in org.apache.daffodil.japi">ProcessorFactory</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/daffodil/japi/Compiler.html#compileFile-java.io.File-java.lang.String-java.lang.String-">compileFile</a></span>(java.io.File&nbsp;schemaFile,
java.lang.String&nbsp;rootName,
java.lang.String&nbsp;rootNamespace)</code>
<div class="block">Compile DFDL schema file into a <a href="../../../../org/apache/daffodil/japi/ProcessorFactory.html" title="class in org.apache.daffodil.japi"><code>ProcessorFactory</code></a></div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/daffodil/japi/ProcessorFactory.html" title="class in org.apache.daffodil.japi">ProcessorFactory</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/daffodil/japi/Compiler.html#compileSource-java.net.URI-">compileSource</a></span>(java.net.URI&nbsp;uri)</code>
<div class="block">Compile DFDL schema source into a <a href="../../../../org/apache/daffodil/japi/ProcessorFactory.html" title="class in org.apache.daffodil.japi"><code>ProcessorFactory</code></a></div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/daffodil/japi/ProcessorFactory.html" title="class in org.apache.daffodil.japi">ProcessorFactory</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/daffodil/japi/Compiler.html#compileSource-java.net.URI-java.lang.String-java.lang.String-">compileSource</a></span>(java.net.URI&nbsp;uri,
java.lang.String&nbsp;rootName,
java.lang.String&nbsp;rootNamespace)</code>
<div class="block">Compile DFDL schema source into a <a href="../../../../org/apache/daffodil/japi/ProcessorFactory.html" title="class in org.apache.daffodil.japi"><code>ProcessorFactory</code></a></div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/daffodil/japi/DataProcessor.html" title="class in org.apache.daffodil.japi">DataProcessor</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/daffodil/japi/Compiler.html#reload-java.io.File-">reload</a></span>(java.io.File&nbsp;savedParser)</code>
<div class="block">Reload a saved parser from a file</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/daffodil/japi/DataProcessor.html" title="class in org.apache.daffodil.japi">DataProcessor</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/daffodil/japi/Compiler.html#reload-java.nio.channels.ReadableByteChannel-">reload</a></span>(java.nio.channels.ReadableByteChannel&nbsp;savedParser)</code>
<div class="block">Reload a saved parser from a <code>ReadableByteChannel</code></div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/daffodil/japi/Compiler.html#setDistinguishedRootNode-java.lang.String-java.lang.String-">setDistinguishedRootNode</a></span>(java.lang.String&nbsp;name,
java.lang.String&nbsp;namespace)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">Pass arguments to compileSource, or compileFile. Since 2.6.0.</span></div>
</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/daffodil/japi/Compiler.html#setExternalDFDLVariable-java.lang.String-java.lang.String-java.lang.String-">setExternalDFDLVariable</a></span>(java.lang.String&nbsp;name,
java.lang.String&nbsp;namespace,
java.lang.String&nbsp;value)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">Use DataProcessor.withExternalVariable. Since 2.6.0.</span></div>
</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/daffodil/japi/Compiler.html#setExternalDFDLVariables-java.util.AbstractMap-">setExternalDFDLVariables</a></span>(java.util.AbstractMap&lt;java.lang.String,java.lang.String&gt;&nbsp;extVarsMap)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">Use DataProcessor.withExternalVariables. Since 2.6.0.</span></div>
</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/daffodil/japi/Compiler.html#setExternalDFDLVariables-java.io.File-">setExternalDFDLVariables</a></span>(java.io.File&nbsp;extVarsFile)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">Use DataProcessor.withExternalVariables. Since 2.6.0.</span></div>
</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/daffodil/japi/Compiler.html#setTunable-java.lang.String-java.lang.String-">setTunable</a></span>(java.lang.String&nbsp;tunable,
java.lang.String&nbsp;value)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">Use withTunable. Since 2.6.0.</span></div>
</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/daffodil/japi/Compiler.html#setTunables-java.util.AbstractMap-">setTunables</a></span>(java.util.AbstractMap&lt;java.lang.String,java.lang.String&gt;&nbsp;tunables)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">Use withTunables. Since 2.6.0.</span></div>
</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/daffodil/japi/Compiler.html#setValidateDFDLSchemas-boolean-">setValidateDFDLSchemas</a></span>(boolean&nbsp;value)</code>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;
<div class="block"><span class="deprecationComment">Do not use this method. DFDL schema validation should be performed. Since 2.6.0.</span></div>
</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/daffodil/japi/Compiler.html" title="class in org.apache.daffodil.japi">Compiler</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/daffodil/japi/Compiler.html#withTunable-java.lang.String-java.lang.String-">withTunable</a></span>(java.lang.String&nbsp;tunable,
java.lang.String&nbsp;value)</code>
<div class="block">Create a new Compiler instance having a specific Daffodil tunable parameter value.</div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="../../../../org/apache/daffodil/japi/Compiler.html" title="class in org.apache.daffodil.japi">Compiler</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/daffodil/japi/Compiler.html#withTunables-java.util.AbstractMap-">withTunables</a></span>(java.util.AbstractMap&lt;java.lang.String,java.lang.String&gt;&nbsp;tunables)</code>
<div class="block">Create a new Compiler instance having specific Daffodil tunable parameter values.</div>
</td>
</tr>
</table>
<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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="Compiler-org.apache.daffodil.compiler.Compiler-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>Compiler</h4>
<pre>public&nbsp;Compiler(org.apache.daffodil.compiler.Compiler&nbsp;sCompiler)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="compileFile-java.io.File-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>compileFile</h4>
<pre>public&nbsp;<a href="../../../../org/apache/daffodil/japi/ProcessorFactory.html" title="class in org.apache.daffodil.japi">ProcessorFactory</a>&nbsp;compileFile(java.io.File&nbsp;schemaFile)
throws java.io.IOException</pre>
<div class="block">Compile DFDL schema file into a <a href="../../../../org/apache/daffodil/japi/ProcessorFactory.html" title="class in org.apache.daffodil.japi"><code>ProcessorFactory</code></a>
<p>
To allow jar-file packaging, (where schema files might be part of a jar),
it is recommended to use <a href="../../../../org/apache/daffodil/japi/Compiler.html#compileSource-java.net.URI-"><code>compileSource(java.net.URI)</code></a> instead.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>schemaFile</code> - DFDL schema file used to create a <a href="../../../../org/apache/daffodil/japi/ProcessorFactory.html" title="class in org.apache.daffodil.japi"><code>ProcessorFactory</code></a>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="../../../../org/apache/daffodil/japi/ProcessorFactory.html" title="class in org.apache.daffodil.japi"><code>ProcessorFactory</code></a> used to create <a href="../../../../org/apache/daffodil/japi/DataProcessor.html" title="class in org.apache.daffodil.japi"><code>DataProcessor</code></a>(s). Must check <a href="../../../../org/apache/daffodil/japi/WithDiagnostics.html#isError--"><code>WithDiagnostics.isError()</code></a> before using it.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if an I/O error occurs while reading the schemaFile</dd>
</dl>
</li>
</ul>
<a name="compileFile-java.io.File-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>compileFile</h4>
<pre>public&nbsp;<a href="../../../../org/apache/daffodil/japi/ProcessorFactory.html" title="class in org.apache.daffodil.japi">ProcessorFactory</a>&nbsp;compileFile(java.io.File&nbsp;schemaFile,
java.lang.String&nbsp;rootName,
java.lang.String&nbsp;rootNamespace)
throws java.io.IOException</pre>
<div class="block">Compile DFDL schema file into a <a href="../../../../org/apache/daffodil/japi/ProcessorFactory.html" title="class in org.apache.daffodil.japi"><code>ProcessorFactory</code></a>
<p>
To allow jar-file packaging, (where schema files might be part of a jar),
it is recommended to use <a href="../../../../org/apache/daffodil/japi/Compiler.html#compileSource-java.net.URI-"><code>compileSource(java.net.URI)</code></a> instead.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>schemaFile</code> - DFDL schema file used to create a <a href="../../../../org/apache/daffodil/japi/ProcessorFactory.html" title="class in org.apache.daffodil.japi"><code>ProcessorFactory</code></a>.</dd>
<dd><code>rootName</code> - name of root element, or null to choose automatically from first element of schema.</dd>
<dd><code>rootNamespace</code> - String of namespace of the root element, or null to infer automatically when unambiguous. Pass "" (empty string) for No Namespace.*</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="../../../../org/apache/daffodil/japi/ProcessorFactory.html" title="class in org.apache.daffodil.japi"><code>ProcessorFactory</code></a> used to create <a href="../../../../org/apache/daffodil/japi/DataProcessor.html" title="class in org.apache.daffodil.japi"><code>DataProcessor</code></a>(s). Must check <a href="../../../../org/apache/daffodil/japi/WithDiagnostics.html#isError--"><code>WithDiagnostics.isError()</code></a> before using it.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if an I/O error occurs while reading the schemaFile</dd>
</dl>
</li>
</ul>
<a name="compileSource-java.net.URI-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>compileSource</h4>
<pre>public&nbsp;<a href="../../../../org/apache/daffodil/japi/ProcessorFactory.html" title="class in org.apache.daffodil.japi">ProcessorFactory</a>&nbsp;compileSource(java.net.URI&nbsp;uri)
throws java.io.IOException</pre>
<div class="block">Compile DFDL schema source into a <a href="../../../../org/apache/daffodil/japi/ProcessorFactory.html" title="class in org.apache.daffodil.japi"><code>ProcessorFactory</code></a>
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>uri</code> - URI of DFDL schema file used to create a <a href="../../../../org/apache/daffodil/japi/ProcessorFactory.html" title="class in org.apache.daffodil.japi"><code>ProcessorFactory</code></a>.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="../../../../org/apache/daffodil/japi/ProcessorFactory.html" title="class in org.apache.daffodil.japi"><code>ProcessorFactory</code></a> used to create <a href="../../../../org/apache/daffodil/japi/DataProcessor.html" title="class in org.apache.daffodil.japi"><code>DataProcessor</code></a>(s). Must check <a href="../../../../org/apache/daffodil/japi/WithDiagnostics.html#isError--"><code>WithDiagnostics.isError()</code></a> before using it.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if an I/O error occurs while reading the uri</dd>
</dl>
</li>
</ul>
<a name="compileSource-java.net.URI-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>compileSource</h4>
<pre>public&nbsp;<a href="../../../../org/apache/daffodil/japi/ProcessorFactory.html" title="class in org.apache.daffodil.japi">ProcessorFactory</a>&nbsp;compileSource(java.net.URI&nbsp;uri,
java.lang.String&nbsp;rootName,
java.lang.String&nbsp;rootNamespace)
throws java.io.IOException</pre>
<div class="block">Compile DFDL schema source into a <a href="../../../../org/apache/daffodil/japi/ProcessorFactory.html" title="class in org.apache.daffodil.japi"><code>ProcessorFactory</code></a>
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>uri</code> - URI of DFDL schema file used to create a <a href="../../../../org/apache/daffodil/japi/ProcessorFactory.html" title="class in org.apache.daffodil.japi"><code>ProcessorFactory</code></a>.</dd>
<dd><code>rootName</code> - name of root element, or null to choose automatically from first element of schema.</dd>
<dd><code>rootNamespace</code> - String of namespace of the root element, or null to infer automatically when unambiguous. Pass "" (empty string) for No Namespace.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="../../../../org/apache/daffodil/japi/ProcessorFactory.html" title="class in org.apache.daffodil.japi"><code>ProcessorFactory</code></a> used to create <a href="../../../../org/apache/daffodil/japi/DataProcessor.html" title="class in org.apache.daffodil.japi"><code>DataProcessor</code></a>(s). Must check <a href="../../../../org/apache/daffodil/japi/WithDiagnostics.html#isError--"><code>WithDiagnostics.isError()</code></a> before using it.</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code>java.io.IOException</code> - if an I/O error occurs while reading the uri</dd>
</dl>
</li>
</ul>
<a name="reload-java.io.File-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reload</h4>
<pre>public&nbsp;<a href="../../../../org/apache/daffodil/japi/DataProcessor.html" title="class in org.apache.daffodil.japi">DataProcessor</a>&nbsp;reload(java.io.File&nbsp;savedParser)
throws <a href="../../../../org/apache/daffodil/japi/InvalidParserException.html" title="class in org.apache.daffodil.japi">InvalidParserException</a></pre>
<div class="block">Reload a saved parser from a file
<p>
To allow jar-file packaging, (where the savedParser might be part of a jar),
it is recommended to use the other version of <a href="../../../../org/apache/daffodil/japi/Compiler.html#reload-java.nio.channels.ReadableByteChannel-"><code>reload(java.nio.channels.ReadableByteChannel)</code></a> where the argument is
a <code>ReadableByteChannel</code> for a saved parser.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>savedParser</code> - file of a saved parser, created with <a href="../../../../org/apache/daffodil/japi/DataProcessor.html#save-java.nio.channels.WritableByteChannel-"><code>DataProcessor.save(java.nio.channels.WritableByteChannel)</code></a>
<p></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="../../../../org/apache/daffodil/japi/DataProcessor.html" title="class in org.apache.daffodil.japi"><code>DataProcessor</code></a> used to parse data. Must check <a href="../../../../org/apache/daffodil/japi/WithDiagnostics.html#isError--"><code>WithDiagnostics.isError()</code></a> before using it.
<p></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/daffodil/japi/InvalidParserException.html" title="class in org.apache.daffodil.japi">InvalidParserException</a></code> - if the file is not a valid saved parser.</dd>
</dl>
</li>
</ul>
<a name="reload-java.nio.channels.ReadableByteChannel-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>reload</h4>
<pre>public&nbsp;<a href="../../../../org/apache/daffodil/japi/DataProcessor.html" title="class in org.apache.daffodil.japi">DataProcessor</a>&nbsp;reload(java.nio.channels.ReadableByteChannel&nbsp;savedParser)
throws <a href="../../../../org/apache/daffodil/japi/InvalidParserException.html" title="class in org.apache.daffodil.japi">InvalidParserException</a></pre>
<div class="block">Reload a saved parser from a <code>ReadableByteChannel</code>
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>savedParser</code> - <code>ReadableByteChannel</code> of a saved parser, created with <a href="../../../../org/apache/daffodil/japi/DataProcessor.html#save-java.nio.channels.WritableByteChannel-"><code>DataProcessor.save(java.nio.channels.WritableByteChannel)</code></a>
<p></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd><a href="../../../../org/apache/daffodil/japi/DataProcessor.html" title="class in org.apache.daffodil.japi"><code>DataProcessor</code></a> used to parse data. Must check <a href="../../../../org/apache/daffodil/japi/WithDiagnostics.html#isError--"><code>WithDiagnostics.isError()</code></a> before using it.
<p></dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../../org/apache/daffodil/japi/InvalidParserException.html" title="class in org.apache.daffodil.japi">InvalidParserException</a></code> - if the file is not a valid saved parser.</dd>
</dl>
</li>
</ul>
<a name="setDistinguishedRootNode-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setDistinguishedRootNode</h4>
<pre>public&nbsp;void&nbsp;setDistinguishedRootNode(java.lang.String&nbsp;name,
java.lang.String&nbsp;namespace)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">Pass arguments to compileSource, or compileFile. Since 2.6.0.</span></div>
<div class="block">Specify a global element to be the root of DFDL Schema to start parsing
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - name of the root node</dd>
<dd><code>namespace</code> - namespace of the root node. Set to empty string to specify
no namespace. Set to to NULL to figure out the namespace.</dd>
</dl>
</li>
</ul>
<a name="setExternalDFDLVariable-java.lang.String-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setExternalDFDLVariable</h4>
<pre>public&nbsp;void&nbsp;setExternalDFDLVariable(java.lang.String&nbsp;name,
java.lang.String&nbsp;namespace,
java.lang.String&nbsp;value)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">Use DataProcessor.withExternalVariable. Since 2.6.0.</span></div>
<div class="block">Set the value of a DFDL variable
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>name</code> - name of the variable</dd>
<dd><code>namespace</code> - namespace of the variable. Set to empty string to specify
no namespace. Set to to NULL to figure out the namespace.</dd>
<dd><code>value</code> - value to so the variable to</dd>
</dl>
</li>
</ul>
<a name="setExternalDFDLVariables-java.util.AbstractMap-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setExternalDFDLVariables</h4>
<pre>public&nbsp;void&nbsp;setExternalDFDLVariables(java.util.AbstractMap&lt;java.lang.String,java.lang.String&gt;&nbsp;extVarsMap)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">Use DataProcessor.withExternalVariables. Since 2.6.0.</span></div>
<div class="block">Set the value of multiple DFDL variables
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>extVarsMap</code> - a may of key/value pairs, where the key is the variable
name, and the value is the value of the variable. The key
may be preceded by a string of the form "{namespace}" to
define a namespace for the variable. If preceded with "{}",
then no namespace is used. With not preceded by "{namespace}",
then Daffodil will figure out the namespace.</dd>
</dl>
</li>
</ul>
<a name="setExternalDFDLVariables-java.io.File-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setExternalDFDLVariables</h4>
<pre>public&nbsp;void&nbsp;setExternalDFDLVariables(java.io.File&nbsp;extVarsFile)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">Use DataProcessor.withExternalVariables. Since 2.6.0.</span></div>
<div class="block">Read external variables from a Daffodil configuration file
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>extVarsFile</code> - file to read DFDL variables from.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a target="_blank" href='https://daffodil.apache.org/configuration/'>Daffodil Configuration File</a> - Daffodil configuration file format
<p></dd>
</dl>
</li>
</ul>
<a name="setTunable-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTunable</h4>
<pre>public&nbsp;void&nbsp;setTunable(java.lang.String&nbsp;tunable,
java.lang.String&nbsp;value)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">Use withTunable. Since 2.6.0.</span></div>
<div class="block">Set a Daffodil tunable parameter
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>tunable</code> - name of the tunable parameter to set.</dd>
<dd><code>value</code> - value of the tunable parameter to set</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a target="_blank" href='https://daffodil.apache.org/configuration/#tunable-parameters'>Tunable Parameters</a> - list of tunables names of default values
<p></dd>
</dl>
</li>
</ul>
<a name="setTunables-java.util.AbstractMap-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTunables</h4>
<pre>public&nbsp;void&nbsp;setTunables(java.util.AbstractMap&lt;java.lang.String,java.lang.String&gt;&nbsp;tunables)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">Use withTunables. Since 2.6.0.</span></div>
<div class="block">Set the value of multiple tunable parameters
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>tunables</code> - a map of key/value pairs, where the key is the tunable name and the value is the value to set it to</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a target="_blank" href='https://daffodil.apache.org/configuration/#tunable-parameters'>Tunable Parameters</a> - list of tunables names of default values
<p></dd>
</dl>
</li>
</ul>
<a name="setValidateDFDLSchemas-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setValidateDFDLSchemas</h4>
<pre>public&nbsp;void&nbsp;setValidateDFDLSchemas(boolean&nbsp;value)</pre>
<div class="block"><span class="deprecatedLabel">Deprecated.</span>&nbsp;<span class="deprecationComment">Do not use this method. DFDL schema validation should be performed. Since 2.6.0.</span></div>
<div class="block">Enable/disable DFDL validation of resulting infoset with the DFDL schema
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>value</code> - true to enable validation, false to disabled</dd>
</dl>
</li>
</ul>
<a name="withTunable-java.lang.String-java.lang.String-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>withTunable</h4>
<pre>public&nbsp;<a href="../../../../org/apache/daffodil/japi/Compiler.html" title="class in org.apache.daffodil.japi">Compiler</a>&nbsp;withTunable(java.lang.String&nbsp;tunable,
java.lang.String&nbsp;value)</pre>
<div class="block">Create a new Compiler instance having a specific Daffodil tunable parameter value.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>tunable</code> - name of the tunable parameter</dd>
<dd><code>value</code> - value of the tunable parameter</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>(undocumented)</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a target="_blank" href='https://daffodil.apache.org/configuration/#tunable-parameters'>Tunable Parameters</a> - list of tunables names of default values
<p></dd>
</dl>
</li>
</ul>
<a name="withTunables-java.util.AbstractMap-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>withTunables</h4>
<pre>public&nbsp;<a href="../../../../org/apache/daffodil/japi/Compiler.html" title="class in org.apache.daffodil.japi">Compiler</a>&nbsp;withTunables(java.util.AbstractMap&lt;java.lang.String,java.lang.String&gt;&nbsp;tunables)</pre>
<div class="block">Create a new Compiler instance having specific Daffodil tunable parameter values.
<p></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>tunables</code> - a map of key/value pairs, where the key is the tunable name and the value is the value it will get.</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>(undocumented)</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a target="_blank" href='https://daffodil.apache.org/configuration/#tunable-parameters'>Tunable Parameters</a> - list of tunables names of default values
<p></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/Daffodil.html" title="class in org.apache.daffodil.japi"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/daffodil/japi/Compiler.html" target="_top">Frames</a></li>
<li><a href="Compiler.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>