org.etourdot.xincproc.xinclude.sax

Class XIncludeContext

java.lang.Object

org.etourdot.xincproc.xinclude.sax.XIncludeContext

public class XIncludeContext
extends java.lang.Object

This class represents the context in which the XIncProcXIncludeFilter is executed. It stores some informations abouts base uri, language, stack of xinclude or fallback elements ...

Constructor Summary

Constructors

Constructor and Description
XIncludeContext(XIncProcConfiguration configuration) Instantiates a new XIncludeContext.

Method Summary

Methods

Modifier and Type	Method and Description
void	addBaseURIPath(java.net.URI basePath) Add base uRI path.
void	addInInclusionChain(java.net.URI path, java.lang.String pointer) Add in inclusion chain.
java.util.List<java.net.URI>	getBaseURIPaths() Gets base uRI paths.
XIncProcConfiguration	getConfiguration() Gets configuration.
java.net.URI	getCurrentBaseURI() Gets current base uRI.
java.lang.Exception	getCurrentException() Gets current exception.
java.net.URI	getHrefURI() Gets href uRI.
java.net.URI	getInitialBaseURI() Gets initial base uRI.
java.lang.String	getLanguage() Gets language.
java.net.URI	getSourceURI() Gets source uRI.
boolean	isBaseFixup() Is base fixup.
boolean	isLanguageFixup() Is language fixup.
static XIncludeContext	newContext(XIncludeContext contextToCopy) Create a new context by deep copy of an existant one.
void	removeFromInclusionChain() Remove from inclusion chain.
void	setCurrentException(java.lang.Exception currentException) Sets current exception.
void	setHrefURI(java.net.URI hrefURI) Sets href uRI.
void	setInitialBaseURI(java.net.URI initialBaseURI) Sets initial base uRI.
void	setLanguage(java.lang.String language) Sets language.
void	setSourceURI(java.net.URI sourceURI) Sets source uRI.
java.lang.String	toString()
void	updateContextWhenEndElement() Update context when end element.
void	updateContextWithElementAttributes(org.xml.sax.Attributes attributes) Update context with element attributes.

Methods inherited from class java.lang.Object

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

Constructor Detail

XIncludeContext

public XIncludeContext(XIncProcConfiguration configuration)

Instantiates a new XIncludeContext.

Parameters:

configuration - the configuration to which context is attached

Method Detail

newContext

public static XIncludeContext newContext(XIncludeContext contextToCopy)

Create a new context by deep copy of an existant one.

Parameters:

contextToCopy - the context to copy

Returns:

the XIncludeContext

getConfiguration

public XIncProcConfiguration getConfiguration()

Gets configuration.

Returns:

the configuration to which context is attached

updateContextWithElementAttributes

public void updateContextWithElementAttributes(org.xml.sax.Attributes attributes)
                                        throws XIncludeFatalException

Update context with element attributes.

Parameters:

attributes - the attributes

Throws:

XIncludeFatalException - if attribute xml:base is invalid

updateContextWhenEndElement

public void updateContextWhenEndElement()

Update context when end element.

isLanguageFixup

public boolean isLanguageFixup()

Is language fixup.

Returns:

the boolean

isBaseFixup

public boolean isBaseFixup()

Is base fixup.

Returns:

the boolean

getSourceURI

public java.net.URI getSourceURI()

Gets source uRI.

Returns:

the source uRI

setSourceURI

public void setSourceURI(java.net.URI sourceURI)

Sets source uRI.

Parameters:

sourceURI - the source uRI

getCurrentException

public java.lang.Exception getCurrentException()

Gets current exception.

Returns:

the current exception

setCurrentException

public void setCurrentException(java.lang.Exception currentException)

Sets current exception.

Parameters:

currentException - the current exception

addInInclusionChain

public void addInInclusionChain(java.net.URI path,
                       java.lang.String pointer)
                         throws XIncludeFatalException

Add in inclusion chain.

Parameters:

path - the path

pointer - the pointer

Throws:

XIncludeFatalException - the x include fatal exception

removeFromInclusionChain

public void removeFromInclusionChain()

Remove from inclusion chain.

getInitialBaseURI

public java.net.URI getInitialBaseURI()

Gets initial base uRI.

Returns:

the initial base uRI

setInitialBaseURI

public void setInitialBaseURI(java.net.URI initialBaseURI)

Sets initial base uRI.

Parameters:

initialBaseURI - the initial base uRI

addBaseURIPath

public void addBaseURIPath(java.net.URI basePath)

Add base uRI path.

Parameters:

basePath - the base path

getBaseURIPaths

public java.util.List<java.net.URI> getBaseURIPaths()

Gets base uRI paths.

Returns:

the base uRI paths

getCurrentBaseURI

public java.net.URI getCurrentBaseURI()

Gets current base uRI.

Returns:

the current base uRI

getHrefURI

public java.net.URI getHrefURI()

Gets href uRI.

Returns:

the href uRI

setHrefURI

public void setHrefURI(java.net.URI hrefURI)

Sets href uRI.

Parameters:

hrefURI - the href uRI

getLanguage

public java.lang.String getLanguage()

Gets language.

Returns:

the language

setLanguage

public void setLanguage(java.lang.String language)

Sets language.

Parameters:

language - the language

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object