Package cdc.util.data.xml

Class XmlDataReader

java.lang.Object

cdc.util.data.xml.XmlDataReader

public class XmlDataReader
extends java.lang.Object

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

It is possible, during loading, to:

• filter attributes
• convert attributes names
• convert attributes values
• filter elements
• convert elements names
• ignore comments
• ignore spaces

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

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
protected AttributeNameConverter	attributeNameConverter
protected AttributeValueConverter	attributeValueConverter
static cdc.util.lang.Cache<java.lang.String>	CACHE	The cache of strings used to share attributes and elements names.
protected ElementPredicate	elementFilter
protected ElementNameConverter	elementNameConverter
protected static org.apache.logging.log4j.Logger	LOGGER

Constructor Summary

Constructors

Constructor	Description
XmlDataReader()

Method Summary

Modifier and Type	Method	Description
static XmlDataReader	create(XmlDataReader.Feature... features)
AttributePredicate	getAttributeFilter()
AttributeNameConverter	getAttributeNameConverter()
AttributeValueConverter	getAttributeValueConverter()
ElementPredicate	getElementFilter()
ElementNameConverter	getElementNameConverter()
boolean	isEnabled(XmlDataReader.Feature feature)
static Document	load(java.io.File file, XmlDataReader.Feature... features)
static Document	load(java.io.InputStream is, XmlDataReader.Feature... features)
static Document	load(java.io.InputStream is, java.lang.String systemId, XmlDataReader.Feature... features)
static Document	load(java.lang.String filename, XmlDataReader.Feature... features)
static Document	load(java.net.URL url, XmlDataReader.Feature... features)
static Element	loadRoot(java.io.File file, XmlDataReader.Feature... features)
static Element	loadRoot(java.io.InputStream is, XmlDataReader.Feature... features)
static Element	loadRoot(java.io.InputStream is, java.lang.String systemId, XmlDataReader.Feature... features)
static Element	loadRoot(java.lang.String filename, XmlDataReader.Feature... features)
static Element	loadRoot(java.net.URL url, XmlDataReader.Feature... features)
Document	read(java.io.File file)	Reads a file.
Document	read(java.io.InputStream is)
Document	read(java.io.InputStream is, java.lang.String systemId)	Reads an InputStream.
Document	read(java.lang.String filename)	Reads a file.
Document	read(java.net.URL url)	Reads an URL.
Element	readRoot(java.io.File file)	Reads a file.
Element	readRoot(java.io.InputStream is)
Element	readRoot(java.io.InputStream is, java.lang.String systemId)	Reads an InputStream.
Element	readRoot(java.lang.String filename)	Reads a file.
Element	readRoot(java.net.URL url)	Reads an URL.
void	setAttributeFilter(AttributePredicate filter)
void	setAttributeNameConverter(AttributeNameConverter converter)
void	setAttributeValueConverter(AttributeValueConverter converter)
void	setElementFilter(ElementPredicate filter)
void	setElementNameConverter(ElementNameConverter converter)
void	setEnabled(XmlDataReader.Feature feature, boolean enabled)

Methods inherited from class java.lang.Object

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

Field Detail

CACHE

public static final cdc.util.lang.Cache<java.lang.String> CACHE

The cache of strings used to share attributes and elements names.

LOGGER

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

attributeFilter

protected AttributePredicate attributeFilter

attributeNameConverter

protected AttributeNameConverter attributeNameConverter

attributeValueConverter

protected AttributeValueConverter attributeValueConverter

elementFilter

protected ElementPredicate elementFilter

elementNameConverter

protected ElementNameConverter elementNameConverter

Constructor Detail

XmlDataReader

public XmlDataReader()

Method Detail

isEnabled

public boolean isEnabled(XmlDataReader.Feature feature)

setEnabled

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

getAttributeFilter

public AttributePredicate getAttributeFilter()

Returns:

The attribute filter.

setAttributeFilter

public void setAttributeFilter(AttributePredicate filter)

getAttributeNameConverter

public AttributeNameConverter getAttributeNameConverter()

setAttributeNameConverter

public void setAttributeNameConverter(AttributeNameConverter converter)

getAttributeValueConverter

public AttributeValueConverter getAttributeValueConverter()

setAttributeValueConverter

public void setAttributeValueConverter(AttributeValueConverter converter)

getElementFilter

public ElementPredicate getElementFilter()

setElementFilter

public void setElementFilter(ElementPredicate filter)

getElementNameConverter

public ElementNameConverter getElementNameConverter()

setElementNameConverter

public void setElementNameConverter(ElementNameConverter converter)

read

public Document read(java.io.InputStream is)
              throws java.io.IOException

Throws:

java.io.IOException

readRoot

public Element readRoot(java.io.InputStream is)
                 throws java.io.IOException

Throws:

java.io.IOException

read

public Document read(java.io.InputStream is,
                     java.lang.String systemId)
              throws java.io.IOException

Reads an InputStream.

Parameters:

is - The InputStream.

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

Returns:

The corresponding Document.

Throws:

java.io.IOException - When an IO error occurs.

readRoot

public Element readRoot(java.io.InputStream is,
                        java.lang.String systemId)
                 throws java.io.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:

java.io.IOException - When an IO error occurs.

read

public Document read(java.net.URL url)
              throws java.io.IOException

Reads an URL.

Parameters:

url - The URL.

Returns:

The corresponding Document.

Throws:

java.io.IOException - When an IO error occurs.

readRoot

public Element readRoot(java.net.URL url)
                 throws java.io.IOException

Reads an URL.

Parameters:

url - The URL.

Returns:

The root element of the corresponding Document.

Throws:

java.io.IOException - When an IO error occurs.

read

public Document read(java.lang.String filename)
              throws java.io.IOException

Reads a file.

Parameters:

filename - The file name.

Returns:

The corresponding Document.

Throws:

java.io.IOException - When an IO error occurs.

readRoot

public Element readRoot(java.lang.String filename)
                 throws java.io.IOException

Reads a file.

Parameters:

filename - The file name.

Returns:

The root element of the corresponding Document.

Throws:

java.io.IOException - When an IO error occurs.

read

public Document read(java.io.File file)
              throws java.io.IOException

Reads a file.

Parameters:

file - The file.

Returns:

The corresponding Document.

Throws:

java.io.IOException - When an IO error occurs.

readRoot

public Element readRoot(java.io.File file)
                 throws java.io.IOException

Reads a file.

Parameters:

file - The file.

Returns:

The root element of the corresponding Document.

Throws:

java.io.IOException - When an IO error occurs.

create

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

load

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

Throws:

java.io.IOException

loadRoot

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

Throws:

java.io.IOException

load

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

Throws:

java.io.IOException

loadRoot

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

Throws:

java.io.IOException

load

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

Throws:

java.io.IOException

loadRoot

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

Throws:

java.io.IOException

load

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

Throws:

java.io.IOException

loadRoot

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

Throws:

java.io.IOException

load

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

Throws:

java.io.IOException

loadRoot

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

Throws:

java.io.IOException