Package cdc.util.data.xml

Class XmlDataReader

java.lang.Object

cdc.util.data.xml.XmlDataReader

public class XmlDataReader
extends Object

Class used to read an XML source and produce a Document.

It is possible, during loading, to:

• filter (keep or remove) attributes
• convert attributes names
• convert attributes values
• filter (keep or remove) elements at creation time (pre) and when all its children are known (post).
• convert elements names
• ignore (remove) comments
• ignore (remove) spaces

This can be used to create only necessary nodes and attributes in memory and adapt their names or content.

It is possible to attach an IssueHandler to process warnings, recoverable and fatal errors.

Author:

Damien Carbonne

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	XmlDataReader.Feature

Field Summary

Fields

Modifier and Type	Field	Description
protected AttributePredicate	attributeFilter	The filter attributes.
protected AttributeNameConverter	attributeNameConverter	Attribute name converter.
protected AttributeValueConverter	attributeValueConverter	Attribute value converter.
protected ElementNameConverter	elementNameConverter	Element name converter.
protected ElementPredicate	elementPostFilter	The filter to use when all the children of an element are created.
protected ElementPredicate	elementPreFilter	The filter to use when the element is created.
protected EntityResolver	entityResolver	The entity resolver.
protected IssueHandler	issueHandler
protected static org.apache.logging.log4j.Logger	LOGGER
protected TextContentConverter	textContentConverter	Text content converter.

Constructor Summary

Constructors

Constructor	Description
XmlDataReader()
XmlDataReader(XmlDataReader.Feature... features)

Method Summary

Modifier and Type	Method	Description
static XmlDataReader	create(XmlDataReader.Feature... features)
AttributePredicate	getAttributeFilter()
AttributeNameConverter	getAttributeNameConverter()
AttributeValueConverter	getAttributeValueConverter()
ElementNameConverter	getElementNameConverter()
ElementPredicate	getElementPostFilter()
ElementPredicate	getElementPreFilter()
EntityResolver	getEntityResolver()
IssueHandler	getIssueHandler()
TextContentConverter	getTextContentConverter()
boolean	isEnabled(XmlDataReader.Feature feature)	Returns true when a feature is enabled.
static Document	load(File file, Compressor compressor, XmlDataReader.Feature... features)
static Document	load(File file, XmlDataReader.Feature... features)
static Document	load(InputStream is, XmlDataReader.Feature... features)
static Document	load(InputStream is, String systemId, XmlDataReader.Feature... features)
static Document	load(String filename, Compressor compressor, XmlDataReader.Feature... features)
static Document	load(String filename, XmlDataReader.Feature... features)
static Document	load(String s, Charset charset, XmlDataReader.Feature... features)
static Document	load(URL url, Compressor compressor, XmlDataReader.Feature... features)
static Document	load(URL url, XmlDataReader.Feature... features)
static Element	loadRoot(File file, Compressor compressor, XmlDataReader.Feature... features)
static Element	loadRoot(File file, XmlDataReader.Feature... features)
static Element	loadRoot(InputStream is, XmlDataReader.Feature... features)
static Element	loadRoot(InputStream is, String systemId, Compressor compressor, XmlDataReader.Feature... features)
static Element	loadRoot(InputStream is, String systemId, XmlDataReader.Feature... features)
static Element	loadRoot(String filename, Compressor compressor, XmlDataReader.Feature... features)
static Element	loadRoot(String filename, XmlDataReader.Feature... features)
static Element	loadRoot(String s, Charset charset, XmlDataReader.Feature... features)
static Element	loadRoot(URL url, Compressor compressor, XmlDataReader.Feature... features)
static Element	loadRoot(URL url, XmlDataReader.Feature... features)
Document	read(File file)	Reads a file.
Document	read(File file, Compressor compressor)	Reads a file.
Document	read(InputStream is)
Document	read(InputStream is, Compressor compressor)
Document	read(InputStream is, String systemId)	Reads an InputStream.
Document	read(InputStream is, String systemId, Compressor compressor)
Document	read(String filename)	Reads a file.
Document	read(String filename, Compressor compressor)	Reads a file.
Document	read(String s, Charset charset)	Reads a string.
Document	read(URL url)	Reads an URL.
Document	read(URL url, Compressor compressor)	Reads an URL.
Element	readRoot(File file)	Reads a file.
Element	readRoot(File file, Compressor compressor)	Reads a file.
Element	readRoot(InputStream is)
Element	readRoot(InputStream is, Compressor compressor)
Element	readRoot(InputStream is, String systemId)	Reads an InputStream.
Element	readRoot(InputStream is, String systemId, Compressor compressor)
Element	readRoot(String filename)	Reads a file.
Element	readRoot(String filename, Compressor compressor)	Reads a file.
Element	readRoot(String s, Charset charset)	Reads a string.
Element	readRoot(URL url)	Reads an URL.
Element	readRoot(URL url, Compressor compressor)	Reads an URL.
void	setAttributeFilter(AttributePredicate filter)	Sets the attribute filter.
void	setAttributeNameConverter(AttributeNameConverter converter)	Sets the attribute name converter.
void	setAttributeValueConverter(AttributeValueConverter converter)	Sets the attribute value converter.
void	setElementNameConverter(ElementNameConverter converter)	Sets the element name converter.
void	setElementPostFilter(ElementPredicate filter)	Sets the element post filter.
void	setElementPreFilter(ElementPredicate filter)	Sets the element pre filter.
void	setEnabled(XmlDataReader.Feature feature, boolean enabled)	Enables or disables a feature.
void	setEntityResolver(EntityResolver resolver)	Sets the entity resolver.
void	setIssueHandler(IssueHandler handler)
void	setTextContentConverter(TextContentConverter converter)

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

protected static final org.apache.logging.log4j.Logger LOGGER

issueHandler

protected IssueHandler issueHandler

entityResolver

protected EntityResolver entityResolver

The entity resolver.

attributeFilter

protected AttributePredicate attributeFilter

The filter attributes.

Only accepted attributes are kept and transformed.

attributeNameConverter

protected AttributeNameConverter attributeNameConverter

Attribute name converter.

Applied on accepted attributes.

attributeValueConverter

protected AttributeValueConverter attributeValueConverter

Attribute value converter.

Applied on accepted attributes.

elementPreFilter

protected ElementPredicate elementPreFilter

The filter to use when the element is created.

elementPostFilter

protected ElementPredicate elementPostFilter

The filter to use when all the children of an element are created.

elementNameConverter

protected ElementNameConverter elementNameConverter

Element name converter.

Applied on elements that are pre accepted.

textContentConverter

protected TextContentConverter textContentConverter

Text content converter.

Constructor Detail

XmlDataReader

public XmlDataReader()

XmlDataReader

public XmlDataReader(XmlDataReader.Feature... features)

Method Detail

setIssueHandler

public void setIssueHandler(IssueHandler handler)

getIssueHandler

public final IssueHandler getIssueHandler()

isEnabled

public final boolean isEnabled(XmlDataReader.Feature feature)

Returns true when a feature is enabled.

Parameters:

feature - The feature.

Returns:

true if feature is enabled.

setEnabled

public final void setEnabled(XmlDataReader.Feature feature,
                             boolean enabled)

Enables or disables a feature.

Parameters:

feature - The feature.

enabled - If true, the feature is enabled. It is disabled orthewise.

getEntityResolver

public EntityResolver getEntityResolver()

Returns:

The entity resolver.

setEntityResolver

public void setEntityResolver(EntityResolver resolver)

Sets the entity resolver.

WARNING: This has interactions with XmlDataReader.Feature.DUMMY_ENTITY_RESOLVER.

Parameters:

resolver - The entity resolver.

getAttributeFilter

public AttributePredicate getAttributeFilter()

Returns:

The attribute filter.

setAttributeFilter

public void setAttributeFilter(AttributePredicate filter)

Sets the attribute filter.

The name and value that are passed to the filter are the original name and value, before any name or value conversion happens.

Parameters:

filter - The filter.

Throws:

IllegalArgumentException - When filter is null.

getAttributeNameConverter

public AttributeNameConverter getAttributeNameConverter()

Returns:

The attribute name converter.

setAttributeNameConverter

public void setAttributeNameConverter(AttributeNameConverter converter)

Sets the attribute name converter.

The conversion is applied after attribute filtering.

Parameters:

converter - The converter.

Throws:

IllegalArgumentException - When converter is null.

getAttributeValueConverter

public AttributeValueConverter getAttributeValueConverter()

Returns:

The attribute value converter.

setAttributeValueConverter

public void setAttributeValueConverter(AttributeValueConverter converter)

Sets the attribute value converter.

The conversion is applied after attribute filtering.

Parameters:

converter - The converter.

Throws:

IllegalArgumentException - When converter is null.

getElementPreFilter

public ElementPredicate getElementPreFilter()

Returns:

the element pre filter.

setElementPreFilter

public void setElementPreFilter(ElementPredicate filter)

Sets the element pre filter.

WARNING:

• The element name is the original one (before any conversion happens).
• The attributes names and values are the converted ones (after all conversions have happened).
• Only remaining attributes are available.

Parameters:

filter - The filter.

Throws:

IllegalArgumentException - When filter is null.

getElementPostFilter

public ElementPredicate getElementPostFilter()

Returns:

the element post filter.

setElementPostFilter

public void setElementPostFilter(ElementPredicate filter)

Sets the element post filter.

WARNING:

• The element name is the converted one (after conversion has happened).
• The attributes names and values are the converted ones (after all conversions have happened).
• Only remaining attributes are available.

Parameters:

filter - The filter.

Throws:

IllegalArgumentException - When filter is null.

getElementNameConverter

public ElementNameConverter getElementNameConverter()

Returns:

The element name converter.

setElementNameConverter

public void setElementNameConverter(ElementNameConverter converter)

Sets the element name converter.

Parameters:

converter - The converter.

Throws:

IllegalArgumentException - When converter is null.

getTextContentConverter

public TextContentConverter getTextContentConverter()

setTextContentConverter

public void setTextContentConverter(TextContentConverter converter)

read

public Document read(InputStream is,
                     Compressor compressor)
              throws IOException

Throws:

IOException

read

public Document read(InputStream is)
              throws IOException

Throws:

IOException

readRoot

public Element readRoot(InputStream is,
                        Compressor compressor)
                 throws IOException

Throws:

IOException

readRoot

public Element readRoot(InputStream is)
                 throws IOException

Throws:

IOException

read

public Document read(InputStream is,
                     String systemId,
                     Compressor compressor)
              throws IOException

Throws:

IOException

read

public Document read(InputStream is,
                     String systemId)
              throws IOException

Reads an InputStream.

Parameters:

is - The InputStream.

systemId - The systemId which is needed for resolving relative URIs.

Returns:

The corresponding Document.

Throws:

IOException - When an IO error occurs.

readRoot

public Element readRoot(InputStream is,
                        String systemId,
                        Compressor compressor)
                 throws IOException

Throws:

IOException

readRoot

public Element readRoot(InputStream is,
                        String systemId)
                 throws IOException

Reads an InputStream.

Parameters:

is - The InputStream.

systemId - The systemId which is needed for resolving relative URIs.

Returns:

The root element of the corresponding Document.

Throws:

IOException - When an IO error occurs.

read

public Document read(String s,
                     Charset charset)
              throws IOException

Reads a string.

Parameters:

s - The string.

charset - The charset. Must be compliant with string content.

Returns:

The corresponding Document.

Throws:

IOException - When an IO error occurs.

readRoot

public Element readRoot(String s,
                        Charset charset)
                 throws IOException

Reads a string.

Parameters:

s - The string.

charset - The charset. Must be compliant with string content.

Returns:

The root element of the corresponding Document.

Throws:

IOException - When an IO error occurs.

read

public Document read(URL url,
                     Compressor compressor)
              throws IOException

Reads an URL.

Parameters:

url - The URL.

compressor - The compressor used to compress file.

Returns:

The corresponding Document.

Throws:

IOException - When an IO error occurs.

read

public Document read(URL url)
              throws IOException

Reads an URL.

Parameters:

url - The URL.

Returns:

The corresponding Document.

Throws:

IOException - When an IO error occurs.

readRoot

public Element readRoot(URL url,
                        Compressor compressor)
                 throws IOException

Reads an URL.

Parameters:

url - The URL.

compressor - The compressor used to compress file.

Returns:

The root element of the corresponding Document.

Throws:

IOException - When an IO error occurs.

readRoot

public Element readRoot(URL url)
                 throws IOException

Reads an URL.

Parameters:

url - The URL.

Returns:

The root element of the corresponding Document.

Throws:

IOException - When an IO error occurs.

read

public Document read(String filename,
                     Compressor compressor)
              throws IOException

Reads a file.

Parameters:

filename - The file name.

compressor - The compressor used to compress file.

Returns:

The corresponding Document.

Throws:

IOException - When an IO error occurs.

read

public Document read(String filename)
              throws IOException

Reads a file.

Parameters:

filename - The file name.

Returns:

The corresponding Document.

Throws:

IOException - When an IO error occurs.

readRoot

public Element readRoot(String filename,
                        Compressor compressor)
                 throws IOException

Reads a file.

Parameters:

filename - The file name.

compressor - The compressor used to compress file.

Returns:

The root element of the corresponding Document.

Throws:

IOException - When an IO error occurs.

readRoot

public Element readRoot(String filename)
                 throws IOException

Reads a file.

Parameters:

filename - The file name.

Returns:

The root element of the corresponding Document.

Throws:

IOException - When an IO error occurs.

read

public Document read(File file,
                     Compressor compressor)
              throws IOException

Reads a file.

Parameters:

file - The file.

compressor - The compressor used to compress file.

Returns:

The corresponding Document.

Throws:

IOException - When an IO error occurs.

read

public Document read(File file)
              throws IOException

Reads a file.

Parameters:

file - The file.

Returns:

The corresponding Document.

Throws:

IOException - When an IO error occurs.

readRoot

public Element readRoot(File file,
                        Compressor compressor)
                 throws IOException

Reads a file.

Parameters:

file - The file.

compressor - The compressor used to compress file.

Returns:

The root element of the corresponding Document.

Throws:

IOException - When an IO error occurs.

readRoot

public Element readRoot(File file)
                 throws IOException

Reads a file.

Parameters:

file - The file.

Returns:

The root element of the corresponding Document.

Throws:

IOException - When an IO error occurs.

create

public static XmlDataReader create(XmlDataReader.Feature... features)

load

public static Document load(InputStream is,
                            XmlDataReader.Feature... features)
                     throws IOException

Throws:

IOException

loadRoot

public static Element loadRoot(InputStream is,
                               XmlDataReader.Feature... features)
                        throws IOException

Throws:

IOException

load

public static Document load(InputStream is,
                            String systemId,
                            XmlDataReader.Feature... features)
                     throws IOException

Throws:

IOException

loadRoot

public static Element loadRoot(InputStream is,
                               String systemId,
                               Compressor compressor,
                               XmlDataReader.Feature... features)
                        throws IOException

Throws:

IOException

loadRoot

public static Element loadRoot(InputStream is,
                               String systemId,
                               XmlDataReader.Feature... features)
                        throws IOException

Throws:

IOException

load

public static Document load(String s,
                            Charset charset,
                            XmlDataReader.Feature... features)
                     throws IOException

Throws:

IOException

loadRoot

public static Element loadRoot(String s,
                               Charset charset,
                               XmlDataReader.Feature... features)
                        throws IOException

Throws:

IOException

load

public static Document load(URL url,
                            Compressor compressor,
                            XmlDataReader.Feature... features)
                     throws IOException

Throws:

IOException

load

public static Document load(URL url,
                            XmlDataReader.Feature... features)
                     throws IOException

Throws:

IOException

loadRoot

public static Element loadRoot(URL url,
                               Compressor compressor,
                               XmlDataReader.Feature... features)
                        throws IOException

Throws:

IOException

loadRoot

public static Element loadRoot(URL url,
                               XmlDataReader.Feature... features)
                        throws IOException

Throws:

IOException

load

public static Document load(String filename,
                            Compressor compressor,
                            XmlDataReader.Feature... features)
                     throws IOException

Throws:

IOException

load

public static Document load(String filename,
                            XmlDataReader.Feature... features)
                     throws IOException

Throws:

IOException

loadRoot

public static Element loadRoot(String filename,
                               Compressor compressor,
                               XmlDataReader.Feature... features)
                        throws IOException

Throws:

IOException

loadRoot

public static Element loadRoot(String filename,
                               XmlDataReader.Feature... features)
                        throws IOException

Throws:

IOException

load

public static Document load(File file,
                            Compressor compressor,
                            XmlDataReader.Feature... features)
                     throws IOException

Throws:

IOException

load

public static Document load(File file,
                            XmlDataReader.Feature... features)
                     throws IOException

Throws:

IOException

loadRoot

public static Element loadRoot(File file,
                               Compressor compressor,
                               XmlDataReader.Feature... features)
                        throws IOException

Throws:

IOException

loadRoot

public static Element loadRoot(File file,
                               XmlDataReader.Feature... features)
                        throws IOException

Throws:

IOException