| <html><body><p><font size="+1"><strong>Package org.eclipse.wst.xsl.invoker.config</strong></font></p><hr><h2><font size="-1"><strong>org.eclipse.wst.xsl.invoker.config</strong></font><br> |
| Class PipelineDefinition</h2><br><hr><pre>public class <strong>PipelineDefinition</strong> |
| extends java.lang.Object</pre>The definition of the transformation pipeline. |
| <p> |
| This class is loaded on both the Eclipse classpath and the transformation process's classpath. |
| The whole definition is serialized to an XML document by the Eclipse launcher, and is then |
| read by the transformation process when launched. |
| </p><p></p><hr><table width="100%" border="1"><tr bgcolor="#CCCCFF"><td width="100%"><h2>Constructor Summary</h2></td></tr><tr><td><code><strong><a href="#con_PipelineDefinition">PipelineDefinition</a></strong>()</code></td></tr><tr><td><code><strong><a href="#con_PipelineDefinition">PipelineDefinition</a></strong>(java.io.File launchFile)</code></td></tr><tr><td><code><strong><a href="#con_PipelineDefinition">PipelineDefinition</a></strong>(org.w3c.dom.Document doc)</code></td></tr></table><br><table width="100%" border="1"><tr cols="2" bgcolor="#CCCCFF"><td colspan="2" width="100%"><h2>Method Summary</h2></td></tr><tr valign="top"><td width="20%" align="right"><code>public void</code></td><td width="" align="left"><code><a href="#method_addFeature">addFeature</a>(org.eclipse.wst.xsl.invoker.config.TypedValue feature)</code><br> |
| |
| Add a feature to this configuration</td></tr><tr valign="top"><td width="20%" align="right"><code>public void</code></td><td width="" align="left"><code><a href="#method_addTransformDef">addTransformDef</a>(org.eclipse.wst.xsl.invoker.config.TransformDefinition tdef)</code><br> |
| |
| Add a transform definition to this.</td></tr><tr valign="top"><td width="20%" align="right"><code>public void</code></td><td width="" align="left"><code><a href="#method_configure">configure</a>(org.eclipse.wst.xsl.invoker.IProcessorInvoker invoker)</code><br> |
| |
| Configure the invoker from this.</td></tr><tr valign="top"><td width="20%" align="right"><code>public java.util.Set</code></td><td width="" align="left"><code><a href="#method_getFeatures">getFeatures</a>()</code><br> |
| |
| Get the set of features defined.</td></tr><tr valign="top"><td width="20%" align="right"><code>public java.util.List</code></td><td width="" align="left"><code><a href="#method_getTransformDefs">getTransformDefs</a>()</code><br> |
| |
| Get the list of <code>TransformDefinition</code>'s.</td></tr><tr valign="top"><td width="20%" align="right"><code>public void</code></td><td width="" align="left"><code><a href="#method_removeFeature">removeFeature</a>(org.eclipse.wst.xsl.invoker.config.TypedValue feature)</code><br> |
| |
| Remove a feature from the set of features</td></tr><tr valign="top"><td width="20%" align="right"><code>public void</code></td><td width="" align="left"><code><a href="#method_removeTransformDef">removeTransformDef</a>(org.eclipse.wst.xsl.invoker.config.TransformDefinition tdef)</code><br> |
| |
| Remove a transform definition from this.</td></tr><tr valign="top"><td width="20%" align="right"><code>public void</code></td><td width="" align="left"><code><a href="#method_setUseEmbedded">setUseEmbedded</a>(boolean embedded)</code><br> |
| |
| Set whether to use an XSL declaration embedded in the XML file</td></tr><tr valign="top"><td width="20%" align="right"><code>public org.w3c.dom.Document</code></td><td width="" align="left"><code><a href="#method_toXML">toXML</a>()</code><br> |
| |
| Serialize this to a DOM Document.</td></tr><tr valign="top"><td width="20%" align="right"><code>public boolean</code></td><td width="" align="left"><code><a href="#method_useEmbedded">useEmbedded</a>()</code><br> |
| |
| Get whether to use an XSL declaration embedded in the XML file</td></tr></table><hr><table cols="2" width="100%" border="1"><tr colspan="2" width="100%" bgcolor="#CCCCFF" align="left"><td><h2> |
| Constructor Detail |
| </h2></td></tr></table><h2><a name="con_PipelineDefinition">PipelineDefinition</a></h2><p><code>public <strong>PipelineDefinition</strong>()</code></p><p>Create a new empty instance of this.</p><hr><h2><a name="con_PipelineDefinition">PipelineDefinition</a></h2><p><code>public <strong>PipelineDefinition</strong>(java.io.File launchFile)</code></p><p>Create a new instance of this by reading the specified XML file.</p><hr><h2><a name="con_PipelineDefinition">PipelineDefinition</a></h2><p><code>public <strong>PipelineDefinition</strong>(org.w3c.dom.Document doc)</code></p><p>Create a new instance of this from the specified document</p><hr><table cols="2" width="100%" border="1"><tr colspan="2" width="100%" bgcolor="#CCCCFF" align="left"><td><h2> |
| Methods Detail |
| </h2></td></tr></table><h2><a name="method_addFeature">addFeature</a></h2><p><code>public void <strong>addFeature</strong>(org.eclipse.wst.xsl.invoker.config.TypedValue feature)</code></p><p>Add a feature to this configuration</p><h3>Parameters</h3><p><code>feature</code> - the feature to add</p><hr><h2><a name="method_addTransformDef">addTransformDef</a></h2><p><code>public void <strong>addTransformDef</strong>(org.eclipse.wst.xsl.invoker.config.TransformDefinition tdef)</code></p><p>Add a transform definition to this.</p><h3>Parameters</h3><p><code>tdef</code> - the transform definition to add</p><hr><h2><a name="method_configure">configure</a></h2><p><code>public void <strong>configure</strong>(org.eclipse.wst.xsl.invoker.IProcessorInvoker invoker)</code></p><p>Configure the invoker from this.</p><h3>Parameters</h3><p><code>invoker</code> - the invoker to configure</p><h3>Throws:</h3><p><code>org.eclipse.wst.xsl.invoker.ConfigurationException - if an exception occurs during configuration</code></p><hr><h2><a name="method_getFeatures">getFeatures</a></h2><p><code>public java.util.Set <strong>getFeatures</strong>()</code></p><p>Get the set of features defined.</p><h3>Returns</h3><p><code>java.util.Set</code> - the set of features</p><hr><h2><a name="method_getTransformDefs">getTransformDefs</a></h2><p><code>public java.util.List <strong>getTransformDefs</strong>()</code></p><p>Get the list of <code>TransformDefinition</code>'s.</p><h3>Returns</h3><p><code>java.util.List</code> - the list of transform definitions</p><hr><h2><a name="method_removeFeature">removeFeature</a></h2><p><code>public void <strong>removeFeature</strong>(org.eclipse.wst.xsl.invoker.config.TypedValue feature)</code></p><p>Remove a feature from the set of features</p><h3>Parameters</h3><p><code>feature</code> - the feature to remove</p><hr><h2><a name="method_removeTransformDef">removeTransformDef</a></h2><p><code>public void <strong>removeTransformDef</strong>(org.eclipse.wst.xsl.invoker.config.TransformDefinition tdef)</code></p><p>Remove a transform definition from this.</p><h3>Parameters</h3><p><code>tdef</code> - the transform definition to remove</p><hr><h2><a name="method_setUseEmbedded">setUseEmbedded</a></h2><p><code>public void <strong>setUseEmbedded</strong>(boolean embedded)</code></p><p>Set whether to use an XSL declaration embedded in the XML file</p><h3>Parameters</h3><p><code>embedded</code> - true to use embedded</p><hr><h2><a name="method_toXML">toXML</a></h2><p><code>public org.w3c.dom.Document <strong>toXML</strong>()</code></p><p>Serialize this to a DOM Document.</p><h3>Returns</h3><p><code>org.w3c.dom.Document</code> - the serialized document</p><h3>Throws:</h3><p><code>javax.xml.parsers.ParserConfigurationException - if a problem occurs during serialization</code></p><hr><h2><a name="method_useEmbedded">useEmbedded</a></h2><p><code>public boolean <strong>useEmbedded</strong>()</code></p><p>Get whether to use an XSL declaration embedded in the XML file</p><h3>Returns</h3><p><code>boolean</code> - true if embedded</p><hr></body></html> |
