org.etourdot.xincproc.xinclude

Class XIncProcConfiguration

java.lang.Object

org.etourdot.xincproc.xinclude.XIncProcConfiguration

public final class XIncProcConfiguration
extends Object

XIncProcConfiguration class holds configuration options for XIncProcEngine.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALLOW_FIXUP_BASE_URIS The constant ALLOW_FIXUP_BASE_URIS.
static String	ALLOW_FIXUP_LANGUAGE The constant ALLOW_FIXUP_LANGUAGE.
static String	SUPPORTED_XINCLUDE_VERSION The XInclude version supported by the XIncProcEngine

Method Summary

Methods

Modifier and Type	Method and Description
net.sf.saxon.s9api.Processor	getProcessor() Gets Saxon Processor.
String	getSupportedVersion() Gets supported XInclude version by the engine
boolean	isBaseUrisFixup() Is base uris fixup sets in configuration ?
boolean	isLanguageFixup() Is language fixupsets in configuration ?
static XIncProcConfiguration	newXIncProcConfiguration() New XIncProcConfiguration.
XIncProcEngine	newXIncProcEngine() new XIncProcEngine.
XPointerEngine	newXPointerEngine() New XPointerEngine.
void	setConfigurationProperty(String name, Object value) Sets configuration property.
void	setErrorListener(ErrorListener errorListener) Sets an ErrorListener.
void	setProcessor(net.sf.saxon.s9api.Processor processor) Set Saxon Processor.

Methods inherited from class java.lang.Object

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

Field Detail

ALLOW_FIXUP_BASE_URIS

public static final String ALLOW_FIXUP_BASE_URIS

The constant ALLOW_FIXUP_BASE_URIS.

See Also:

Constant Field Values

ALLOW_FIXUP_LANGUAGE

public static final String ALLOW_FIXUP_LANGUAGE

The constant ALLOW_FIXUP_LANGUAGE.

See Also:

Constant Field Values

SUPPORTED_XINCLUDE_VERSION

public static final String SUPPORTED_XINCLUDE_VERSION

The XInclude version supported by the XIncProcEngine

See Also:

Constant Field Values

Method Detail

newXIncProcConfiguration

public static XIncProcConfiguration newXIncProcConfiguration()

New XIncProcConfiguration.

Returns:

a new XIncProcConfiguration

newXPointerEngine

public XPointerEngine newXPointerEngine()

New XPointerEngine.

The best way to get a new xpointer engine. Usage of this method should be prefered to direct instanciation

Returns:

the new XPointer engine

newXIncProcEngine

public XIncProcEngine newXIncProcEngine()

new XIncProcEngine.

This is the only way to get instance of XIncProcEngine to use custom Saxon Processor via the XIncProcConfiguration

Returns:

a new XIncProcEngine

setConfigurationProperty

public void setConfigurationProperty(String name,
                            Object value)

Sets configuration property.

Parameters:

name - the name

value - the value

setErrorListener

public void setErrorListener(ErrorListener errorListener)

Sets an ErrorListener.

The ErrorListener set in the configuration will be used by the XIncProcEngine

Parameters:

errorListener - the error listener

isBaseUrisFixup

public boolean isBaseUrisFixup()

Is base uris fixup sets in configuration ?

Defaut value is true

Returns:

the boolean

isLanguageFixup

public boolean isLanguageFixup()

Is language fixupsets in configuration ?

Defaut value is true

Returns:

the boolean

getProcessor

public net.sf.saxon.s9api.Processor getProcessor()

Gets Saxon Processor.

A simple Saxon HE processor is created by default for the treatment.

Another Saxon processor could be set to replace the default one.

Returns:

the Saxon processor

setProcessor

public void setProcessor(net.sf.saxon.s9api.Processor processor)

Set Saxon Processor.

The default Saxon HE processor could be replace here.

Parameters:

processor - a Saxon Processor

getSupportedVersion

public String getSupportedVersion()

Gets supported XInclude version by the engine

Returns:

version supported (currently only 1.0)