org.mdiutil.xml.tree

Class XMLNodeIncluder

java.lang.Object

org.mdiutil.xml.tree.XMLNodeIncluder

All Implemented Interfaces:

XMLChildrenIncluder

public class XMLNodeIncluder
extends Object
implements XMLChildrenIncluder

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

Constructor Summary

Constructors

Constructor and Description
XMLNodeIncluder() Constructor.
XMLNodeIncluder(boolean keepAttributesOrder) Constructor.
XMLNodeIncluder(File file) Constructor.
XMLNodeIncluder(File file, boolean keepAttributesOrder) Constructor.
XMLNodeIncluder(InputStream stream) Constructor.
XMLNodeIncluder(InputStream stream, boolean keepAttributesOrder) Constructor.
XMLNodeIncluder(URL url) Constructor.
XMLNodeIncluder(URL url, boolean keepAttributesOrder) Constructor.

Method Summary

Modifier and Type	Method and Description
Charset	getCharset() Return the charset to use to write the content.
String	getContent() Return a String representing the XML content.
EntityListResolver	getEntityListResolver() Return the EntityListResolver which can manage entity resolution in XML files.
ErrorHandler	getErrorHandler() Return the ErrorHandler which will be fired for warnings and errors when parsing the content.
int	getIndentation() Return the indentation.
Reader	getReader() Return a Reader to the XML content.
boolean	isAddingComments() Return true if a comment must be added for each included file.
boolean	isEnablingDeepComments() Return true if the comments in deep include declarations must be added.
boolean	isKeepingAttributesOrder() Return true if the order of attributes is kept in the output.
boolean	isKeepingPrefixes() Return true if the underlying parser must keep the prefixes.
void	keepAttributesOrder(boolean keepAttributesOrder) Set if the order of attributes is kept in the output.
void	setAddComments(boolean addComments, boolean deep) Set if a comment must be added for each included file.
void	setCharset(Charset charset) Set the charset to use to write the content.
void	setDefaultBaseDirectory(URL baseDir) Set the default base directory for including files.
void	setEntityListResolver(EntityListResolver resolver) Set the EntityListResolver which can manage entity resolution in XML files.
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	setIndentation(int indentation) Set the indentation.
void	setInputStream(InputStream stream) Set the includer InputStream.
void	setKeepPrefixes(boolean keepPrefixes) Set if the underlying parser must keep the prefixes.
void	setURL(URL url) Set the includer URL.
void	skipAllPrefixes(boolean skip) Set true if all the prefixes in the included children must be skipped.
void	skipPrefixes(Set<String> prefixes) Set a list of prefixes to skip.
void	skipPrefixes(String... prefixes) Set a list of prefixes to skip.
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 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

XMLNodeIncluder

public XMLNodeIncluder()

Constructor.

XMLNodeIncluder

public XMLNodeIncluder(boolean keepAttributesOrder)

Constructor.

Parameters:

keepAttributesOrder - true if the order of the attributes is kept in the output

XMLNodeIncluder

public XMLNodeIncluder(File file,
                       boolean keepAttributesOrder)
                throws MalformedURLException

Constructor.

Parameters:

file - the file

keepAttributesOrder - true if the order of the attributes is kept in the output

Throws:

MalformedURLException

XMLNodeIncluder

public XMLNodeIncluder(URL url,
                       boolean keepAttributesOrder)

Constructor.

Parameters:

url - the URL

keepAttributesOrder - true if the order of the attributes is kept in the output

XMLNodeIncluder

public XMLNodeIncluder(InputStream stream,
                       boolean keepAttributesOrder)

Constructor.

Parameters:

stream - the InputStream

keepAttributesOrder - true if the order of the attributes is kept in the output

XMLNodeIncluder

public XMLNodeIncluder(File file)
                throws MalformedURLException

Constructor.

Parameters:

file - the file

Throws:

MalformedURLException

XMLNodeIncluder

public XMLNodeIncluder(URL url)

Constructor.

Parameters:

url - the URL

XMLNodeIncluder

public XMLNodeIncluder(InputStream stream)

Constructor.

Parameters:

stream - the InputStream

Method Detail

keepAttributesOrder

public void keepAttributesOrder(boolean keepAttributesOrder)

Set if the order of attributes is kept in the output.

Parameters:

keepAttributesOrder - true if the order of attributes is kept in the output

isKeepingAttributesOrder

public boolean isKeepingAttributesOrder()

Return true if the order of attributes is kept in the output.

Returns:

true if the order of attributes is kept in the output

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

skipAllPrefixes

public void skipAllPrefixes(boolean skip)

Set true if all the prefixes in the included children must be skipped.

Parameters:

skip - true if all the prefixes in the included children must be skipped

skipPrefixes

public void skipPrefixes(String... prefixes)

Set a list of prefixes to skip.

Parameters:

prefixes - the prefixes

skipPrefixes

public void skipPrefixes(Set<String> prefixes)

Set a list of prefixes to skip.

Parameters:

prefixes - the prefixes

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

setKeepPrefixes

public void setKeepPrefixes(boolean keepPrefixes)

Set if the underlying parser must keep the prefixes. It will ot contain attributes used as Namespace declarations (xmlns*) unless the http://xml.org/sax/features/namespace-prefixes feature is set to true (it is false by default).

Parameters:

keepPrefixes - true if the parser must keep the prefixes

isKeepingPrefixes

public boolean isKeepingPrefixes()

Return true if the underlying parser must keep the prefixes.

Returns:

true if the parser must keep the prefixes

setEntityListResolver

public void setEntityListResolver(EntityListResolver resolver)

Set the EntityListResolver which can manage entity resolution in XML files.

Parameters:

resolver - the resolver

getEntityListResolver

public EntityListResolver getEntityListResolver()

Return the EntityListResolver which can manage entity resolution in XML files.

Returns:

the resolver

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

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

setIndentation

public void setIndentation(int indentation)

Set the indentation.

Parameters:

indentation - the indentation

getIndentation

public int getIndentation()

Return the indentation.

Returns:

the indentation

getContent

public String getContent()

Return a String representing the XML content.

Specified by:

getContent in interface XMLChildrenIncluder

Returns:

the StringReader

getReader

public Reader getReader()

Description copied from interface: XMLChildrenIncluder

Return a Reader to the XML content.

Specified by:

getReader in interface XMLChildrenIncluder

Returns:

the StringReader

write

public void write(File file)
           throws IOException

Description copied from interface: XMLChildrenIncluder

Write the resulting XML to a File.

Specified by:

write in interface XMLChildrenIncluder

Parameters:

file - the File

Throws:

IOException

write

public void write(URL url)
           throws IOException

Description copied from interface: XMLChildrenIncluder

Write the resulting XML to an URL.

Specified by:

write in interface XMLChildrenIncluder

Parameters:

url - the URL

Throws:

IOException