com.xmlmind.xml.load

Class XIncluder

java.lang.Object

com.xmlmind.xml.load.XIncluder

All Implemented Interfaces:

XInclusionContext

public final class XIncluder
extends Object
implements XInclusionContext

Utility class, parametrized using a set of XInclusionSchemes, allowing to process or update inclusions.

Process inclusions

Replace an inclusion by the nodes specified by this inclusion.

Update inclusions

Replace included nodes by possibly more up-to-date nodes. This is needed when the document from which the included nodes come from has been modified.

Field Summary

Fields

Modifier and Type	Field and Description
XInclusionScheme[]	xInclusionSchemes Schemes of the XInclusions to be processed.

Constructor Summary

Constructors

Constructor and Description
XIncluder(XInclusionScheme[] xInclusionSchemes) Constructs an XIncluder allowing to process inclusions belonging to the specified schemes.

Method Summary

Modifier and Type	Method and Description
Element	findElementById(Document document, String id) Searches specified document for an element having specified ID.
Document	getDocument(URL url) Opens and returns the document corresponding to specified URL.
boolean	process(Tree tree, List<Node[]> replacements, Console console, List<LoadError> loadErrors, List<LoadError> loadWarnings) Process inclusions found in specified document subtree.
boolean	update(Document[] documents, Console console, List<LoadError> loadErrors, List<LoadError> loadWarnings) Update marked inclusions found in specified documents.

Methods inherited from class java.lang.Object

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

Field Detail

xInclusionSchemes

public final XInclusionScheme[] xInclusionSchemes

Schemes of the XInclusions to be processed. Inclusions belonging to schemes not listed here are ignored by this XIncluder.

Constructor Detail

XIncluder

public XIncluder(XInclusionScheme[] xInclusionSchemes)

Constructs an XIncluder allowing to process inclusions belonging to the specified schemes.

Parameters:

xInclusionSchemes - schemes of the XInclusions to be processed. Inclusions belonging to schemes not listed here are ignored by this XIncluder.

Method Detail

process

public boolean process(Tree tree,
                       List<Node[]> replacements,
                       Console console,
                       List<LoadError> loadErrors,
                       List<LoadError> loadWarnings)

Process inclusions found in specified document subtree.

Parameters:

tree - Document subtree possibly containing inclusions.

replacements - The replacements which have been performed are appended to this list. May be null.

This list will contain pairs of arrays of Nodes. First array contains the Nodes which specify the inclusion directive. Second array contains the replacement, that is included, Nodes.

console - Console used to report verbose and debug messages. May be null.

loadErrors - Inclusion errors are appended to this list. May be null.

loadWarnings - Inclusion warnings are appended to this list. May be null.

Returns:

true if inclusions have been found and processed in specified document subtree; false otherwise.

See Also:

update(com.xmlmind.xml.doc.Document[], com.xmlmind.util.Console, java.util.List<com.xmlmind.xml.load.LoadError>, java.util.List<com.xmlmind.xml.load.LoadError>)

update

public boolean update(Document[] documents,
                      Console console,
                      List<LoadError> loadErrors,
                      List<LoadError> loadWarnings)

Update marked inclusions found in specified documents.

All inclusions marked for update are automatically unmarked at the end of this update process.

This method generates InclusionUpdatedEvent events.

Parameters:

documents - An array of documents possibly containing inclusions marked for update.

console - Console used to report verbose and debug messages. May be null.

loadErrors - Inclusion errors are appended to this list. May be null.

loadWarnings - Inclusion warnings are appended to this list. May be null.

See Also:

XInclusion.setMarkedForUpdate(boolean), process(com.xmlmind.xml.doc.Tree, java.util.List<com.xmlmind.xml.doc.Node[]>, com.xmlmind.util.Console, java.util.List<com.xmlmind.xml.load.LoadError>, java.util.List<com.xmlmind.xml.load.LoadError>)

getDocument

public Document getDocument(URL url)
                     throws InclusionException

Description copied from interface: XInclusionContext

Opens and returns the document corresponding to specified URL.

Specified by:

getDocument in interface XInclusionContext

Parameters:

url - URL of the document

Returns:

the document having specified URL

Throws:

InclusionException - if, for any reason, specified document cannot be opened

findElementById

public Element findElementById(Document document,
                               String id)

Description copied from interface: XInclusionContext

Searches specified document for an element having specified ID.

Specified by:

findElementById in interface XInclusionContext

Parameters:

document - document to be searched

id - searched ID

Returns:

the element having this ID; null if such element is not found