org.etourdot.xincproc.xinclude

Class XIncProcEngine

java.lang.Object

org.etourdot.xincproc.xinclude.XIncProcEngine

public final class XIncProcEngine
extends java.lang.Object

This class contains useful methods to manage a XMLFilter for xinclusions and to parse content with xinclude tags.

Static usage of this class only use Saxon He processor. If you want to use another version of the Saxon processor you should instanciate XIncProcEngine with XIncProcConfiguration.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	XIncProcEngine(XIncProcConfiguration configuration)

Method Summary

Methods

Modifier and Type	Method and Description
XIncProcConfiguration	getConfiguration() Return current configuration of the XIncProcEngine
static XIncProcConfiguration	getUnderlyingConfiguration() Get the internal XIncProcConfiguration for static usage
static org.xml.sax.XMLFilter	newXIncludeFilter(java.net.URI baseURI) Create statically a new XIncProcXIncludeFilter from a base fixed URI
static org.xml.sax.XMLFilter	newXIncludeFilter(XIncludeContext context) Create statically a new XIncProcXIncludeFilter from a XIncludeContext
static void	parse(java.io.InputStream input, java.lang.String systemId, java.io.OutputStream output) Statically parse an InputStream
static void	parse(java.net.URI baseURI, java.io.OutputStream output) Statically parse an URI

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XIncProcEngine

protected XIncProcEngine(XIncProcConfiguration configuration)

Method Detail

newXIncludeFilter

public static org.xml.sax.XMLFilter newXIncludeFilter(java.net.URI baseURI)

Create statically a new XIncProcXIncludeFilter from a base fixed URI

Parameters:

baseURI - initial base URI for the filter

Returns:

an XIncProcXIncludeFilter

newXIncludeFilter

public static org.xml.sax.XMLFilter newXIncludeFilter(XIncludeContext context)

Create statically a new XIncProcXIncludeFilter from a XIncludeContext

Parameters:

context - intial context for the filter

Returns:

an XIncProcXIncludeFilter

parse

public static void parse(java.net.URI baseURI,
         java.io.OutputStream output)
                  throws XIncludeFatalException

Statically parse an URI

Parameters:

baseURI - URI to be parsed

output - OutputStream will store result

Throws:

XIncludeFatalException

parse

public static void parse(java.io.InputStream input,
         java.lang.String systemId,
         java.io.OutputStream output)
                  throws XIncludeFatalException,
                         java.io.IOException

Statically parse an InputStream

Parameters:

input - InputStream to parse

systemId - of the input. If this is null or not an URI, method exits with XIncludeFatalException.

output - OutputStream will store result

Throws:

XIncludeFatalException

java.io.IOException

getConfiguration

public XIncProcConfiguration getConfiguration()

Return current configuration of the XIncProcEngine

Returns:

the XIncProcConfiguration

getUnderlyingConfiguration

public static XIncProcConfiguration getUnderlyingConfiguration()

Get the internal XIncProcConfiguration for static usage

Returns:

a static configuration