org.mdiutil.xml

Class XMLIncluder

java.lang.Object

org.xml.sax.helpers.DefaultHandler

org.mdiutil.xml.XMLIncluder

All Implemented Interfaces:

XMLChildrenIncluder, ContentHandler, DTDHandler, EntityResolver, ErrorHandler

public class XMLIncluder
extends DefaultHandler
implements XMLChildrenIncluder

This class process XML files by including the content of XInclude children.

Constructor Summary

Constructors

Constructor and Description
XMLIncluder() Constructor.
XMLIncluder(File file) Constructor.
XMLIncluder(InputStream stream) Constructor.
XMLIncluder(URL url) Constructor.

Method Summary

Modifier and Type	Method and Description
void	characters(char[] ch, int start, int length)
void	endElement(String uri, String localname, String qname)
void	error(SAXParseException e) Report an XML parsing error.
void	fatalError(SAXParseException e) Report a fatal XML parsing error.
Charset	getCharset() Return the charset to use to write the content.
ClassLoader	getClassLoader() Return the ClassLoader.
String	getContent() Return a String representing the XML content.
ErrorHandler	getErrorHandler() Return the ErrorHandler which will be fired for warnings and errors when parsing the content.
StringReader	getReader() Return a StringReader to the XML content.
boolean	hasFatalError() Return true if the parsing of the file threw a Fatal error.
boolean	isAddingComments() Return true if a comment must be added for each included file.
boolean	isAllowingInternalReaders() Return true if internal readers creation are allowed in this parser instance.
boolean	isEnablingDeepComments() Return true if the comments in deep include declarations must be added.
void	setAddComments(boolean addComments, boolean deep) Set if a comment must be added for each included file.
void	setAllowInternalReaders(boolean allowInternalReaders) Set if internal readers creation are allowed in this parser instance.
void	setCharset(Charset charset) Set the charset to use to write the content.
void	setClassLoader(ClassLoader loader) Set the ClassLoader.
void	setDefaultBaseDirectory(URL baseDir) Set the default base directory for including files.
void	setDocumentLocator(Locator locator) Set the document locator.
void	setErrorHandler(ErrorHandler errorHandler) Set the ErrorHandler which will be fired for warnings and errors when parsing the content.
void	setFile(File file) Set the includer file.
void	setInputStream(InputStream stream) Set the includer InputStream.
void	setURL(URL url) Set the includer URL.
void	startElement(String uri, String localname, String qname, Attributes attr)
void	startPrefixMapping(String prefix, String uri)
void	warning(SAXParseException e) Report an XML parsing warning.
void	write(File file) Write the resulting XML to a File.
void	write(URL url) Write the resulting XML to an URL.

Methods inherited from class org.xml.sax.helpers.DefaultHandler

endDocument, endPrefixMapping, ignorableWhitespace, notationDecl, processingInstruction, resolveEntity, skippedEntity, startDocument, unparsedEntityDecl

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.mdiutil.xml.XMLChildrenIncluder

resetSAXParserFactoryImplementation, setAddComments, setSAXParserFactoryImplementation

Constructor Detail

XMLIncluder

public XMLIncluder()

Constructor.

XMLIncluder

public XMLIncluder(File file)
            throws MalformedURLException

Constructor.

Parameters:

file - the file

Throws:

MalformedURLException

XMLIncluder

public XMLIncluder(URL url)

Constructor.

Parameters:

url - the URL

XMLIncluder

public XMLIncluder(InputStream stream)

Constructor.

Parameters:

stream - the InputStream

Method Detail

setAllowInternalReaders

public void setAllowInternalReaders(boolean allowInternalReaders)

Set if internal readers creation are allowed in this parser instance.

Parameters:

allowInternalReaders - true if internal readers creation are allowed in this parser instance.

isAllowingInternalReaders

public boolean isAllowingInternalReaders()

Return true if internal readers creation are allowed in this parser instance.

Returns:

true if internal readers creation are allowed in this parser instance.

setCharset

public void setCharset(Charset charset)

Set the charset to use to write the content. The default charset is StandardCharsets.UTF_8.

Specified by:

setCharset in interface XMLChildrenIncluder

Parameters:

charset - the charset

getCharset

public Charset getCharset()

Return the charset to use to write the content.

Specified by:

getCharset in interface XMLChildrenIncluder

Returns:

the charset

setFile

public void setFile(File file)
             throws MalformedURLException

Set the includer file.

Specified by:

setFile in interface XMLChildrenIncluder

Parameters:

file - the file

Throws:

MalformedURLException

setURL

public void setURL(URL url)

Set the includer URL.

Specified by:

setURL in interface XMLChildrenIncluder

Parameters:

url - the URL

setInputStream

public void setInputStream(InputStream stream)

Set the includer InputStream.

Specified by:

setInputStream in interface XMLChildrenIncluder

Parameters:

stream - the InputStream

setAddComments

public void setAddComments(boolean addComments,
                           boolean deep)

Set if a comment must be added for each included file.

Specified by:

setAddComments in interface XMLChildrenIncluder

Parameters:

addComments - true if a comment must be added for each included file

deep - true if the comments in deep include declarations must be added

isAddingComments

public boolean isAddingComments()

Return true if a comment must be added for each included file.

Specified by:

isAddingComments in interface XMLChildrenIncluder

Returns:

true if a comment must be added for each included file

isEnablingDeepComments

public boolean isEnablingDeepComments()

Return true if the comments in deep include declarations must be added.

Specified by:

isEnablingDeepComments in interface XMLChildrenIncluder

Returns:

true if the comments in deep include declarations must be added

setClassLoader

public void setClassLoader(ClassLoader loader)

Set the ClassLoader. It will only be used if XMLSAXParser.isRevertingOldReaderBehavior() is false.

Parameters:

loader - the ClassLoader

getClassLoader

public ClassLoader getClassLoader()

Return the ClassLoader. It will only be used if XMLSAXParser.isRevertingOldReaderBehavior() is false.

Returns:

the ClassLoader

setErrorHandler

public void setErrorHandler(ErrorHandler errorHandler)

Set the ErrorHandler which will be fired for warnings and errors when parsing the content.

Specified by:

setErrorHandler in interface XMLChildrenIncluder

Parameters:

errorHandler - the ErrorHandler

getErrorHandler

public ErrorHandler getErrorHandler()

Return the ErrorHandler which will be fired for warnings and errors when parsing the content.

Specified by:

getErrorHandler in interface XMLChildrenIncluder

Returns:

the ErrorHandler

hasFatalError

public boolean hasFatalError()

Return true if the parsing of the file threw a Fatal error.

Returns:

true if the parsing of the file threw a Fatal error

setDefaultBaseDirectory

public void setDefaultBaseDirectory(URL baseDir)

Set the default base directory for including files. This is useful to detect relative XML files when applying the xinclude declarations if the input is an InputStream.

Specified by:

setDefaultBaseDirectory in interface XMLChildrenIncluder

Parameters:

baseDir - the default base directory

startPrefixMapping

public void startPrefixMapping(String prefix,
                               String uri)
                        throws SAXException

Specified by:

startPrefixMapping in interface ContentHandler

Overrides:

startPrefixMapping in class DefaultHandler

Throws:

SAXException

fatalError

public void fatalError(SAXParseException e)

Report a fatal XML parsing error.

Specified by:

fatalError in interface ErrorHandler

Overrides:

fatalError in class DefaultHandler

error

public void error(SAXParseException e)

Report an XML parsing error.

Specified by:

error in interface ErrorHandler

Overrides:

error in class DefaultHandler

warning

public void warning(SAXParseException e)

Report an XML parsing warning.

Specified by:

warning in interface ErrorHandler

Overrides:

warning in class DefaultHandler

characters

public void characters(char[] ch,
                       int start,
                       int length)
                throws SAXException

Specified by:

characters in interface ContentHandler

Overrides:

characters in class DefaultHandler

Throws:

SAXException

startElement

public void startElement(String uri,
                         String localname,
                         String qname,
                         Attributes attr)
                  throws SAXException

Specified by:

startElement in interface ContentHandler

Overrides:

startElement in class DefaultHandler

Throws:

SAXException

setDocumentLocator

public void setDocumentLocator(Locator locator)

Set the document locator.

Specified by:

setDocumentLocator in interface ContentHandler

Overrides:

setDocumentLocator in class DefaultHandler

Parameters:

locator - the locator

endElement

public void endElement(String uri,
                       String localname,
                       String qname)
                throws SAXException

Specified by:

endElement in interface ContentHandler

Overrides:

endElement in class DefaultHandler

Throws:

SAXException

getContent

public String getContent()

Return a String representing the XML content.

Specified by:

getContent in interface XMLChildrenIncluder

Returns:

the StringReader

write

public void write(URL url)
           throws IOException

Write the resulting XML to an URL.

Specified by:

write in interface XMLChildrenIncluder

Parameters:

url - the URL

Throws:

IOException

write

public void write(File file)
           throws IOException

Write the resulting XML to a File.

Specified by:

write in interface XMLChildrenIncluder

Parameters:

file - the File

Throws:

IOException

getReader

public StringReader getReader()

Return a StringReader to the XML content.

Specified by:

getReader in interface XMLChildrenIncluder

Returns:

the StringReader