hu.akarnokd.xml

Class XElement

java.lang.Object

hu.akarnokd.xml.XElementBase

hu.akarnokd.xml.XElement

public class XElement
extends XElementBase

A simplified XML element model.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,java.lang.String>	attributes The attribute map.
protected java.util.List<XElement>	children The child elements.
XElement	parent The parent element.

Fields inherited from class hu.akarnokd.xml.XElementBase

content, name, userObject, XSD, XSI

Constructor Summary

Constructors

Constructor and Description
XElement(java.lang.String name) Constructor.
XElement(java.lang.String name, java.lang.Object value) Creates a new XElement and sets its content according to the supplied value.

Method Summary

Modifier and Type	Method and Description
void	add(java.lang.Iterable<XElement> elements) Add the iterable of elements as children.
XElement	add(java.lang.String name) Add a new child element with the given name.
XElement	add(java.lang.String name, java.lang.Object value) Add an element with the supplied content text.
void	add(XElement... elements) Add the array of elements as children.
void	add(XElement element) Add the array of elements as children.
java.util.Map<java.lang.String,java.lang.String>	attributes()
XElement	childElement(java.lang.String name) Returns the first child element with the given name.
java.util.List<XElement>	children()
java.lang.Iterable<XElement>	childrenWithName(java.lang.String name) Returns an iterator which enumerates all children with the given name.
java.lang.String	childValue(java.lang.String name) Returns the content of the first child which has the given name.
void	clear() Remove attributes and children.
XElement	copy()
void	copyFrom(XElement other) Copy the attributes, content and child elements from the other element in a deep-copy fashion.
void	detach() Detach this element from its parent.
java.lang.String	get(java.lang.String attributeName)
java.lang.String	get(java.lang.String attributeName, java.lang.String def)
boolean	getBoolean(java.lang.String name)
boolean	getBoolean(java.lang.String name, boolean defaultValue)
byte	getByte(java.lang.String key)
byte	getByte(java.lang.String key, byte defaultValue)
char	getChar(java.lang.String key)
char	getChar(java.lang.String key, char defaultValue)
double	getDouble(java.lang.String name)
double	getDouble(java.lang.String name, double defaultValue)
java.lang.Double	getDoubleObject(java.lang.String attributeName) Get a double attribute as object or null if not present.
<E extends java.lang.Enum<E>> E	getEnum(java.lang.String name, java.lang.Class<E> clazz)
<E extends java.lang.Enum<E>> E	getEnum(java.lang.String name, java.lang.Class<E> clazz, E defaultValue)
<E extends java.lang.Enum<E>> E	getEnum(java.lang.String key, E[] universe)
<E extends java.lang.Enum<E>> E	getEnum(java.lang.String key, E[] universe, E defaultValue)
float	getFloat(java.lang.String attributeName)
float	getFloat(java.lang.String key, float defaultValue)
int	getInt(java.lang.String attributeName)
int	getInt(java.lang.String attributeName, int def)
java.lang.Integer	getIntObject(java.lang.String attributeName) Get an integer attribute as object or null if not present.
long	getLong(java.lang.String attributeName)
long	getLong(java.lang.String attributeName, long def)
short	getShort(java.lang.String key)
short	getShort(java.lang.String key, short defaultValue)
boolean	has(java.lang.String attributeName)
boolean	hasChildren()
boolean	hasDouble(java.lang.String attributeName) Check if there is a valid integer attribute.
boolean	hasFloat(java.lang.String attributeName) Check if there is a valid integer attribute.
boolean	hasInt(java.lang.String attributeName) Check if there is a valid integer attribute.
boolean	hasLong(java.lang.String attributeName) Check if there is a valid integer attribute.
boolean	hasPositiveInt(java.lang.String attributeName) Check if there is a valid positive integer attribute.
boolean	isNullOrEmpty(java.lang.String attributeName) Check if the given attribute is present an is not empty.
static XElement	parseXML(byte[] data) Parse an XML from the binary data.
static XElement	parseXML(java.io.File file) Parse an XML from the given local file.
static XElement	parseXML(java.io.InputStream in) Parse an XML document from the given input stream.
static XElement	parseXML(java.io.Reader in) Parse an XML document from the given reader.
static XElement	parseXML(java.sql.ResultSet rs, int index) Reads the contents of a indexed column as an XML.
static XElement	parseXML(java.sql.ResultSet rs, java.lang.String column) Reads the contents of a named column as an XML.
static XElement	parseXML(java.lang.String fileName) Parse an XML from the given local filename.
static XElement	parseXML(java.net.URL u) Parses an XML from the given URL.
static XElement	parseXML(javax.xml.stream.XMLStreamReader in) Parse an XML from an XML stream reader.
static XElement	parseXMLFragment(javax.xml.stream.XMLStreamReader in) Parse an XML from an XML stream reader.
static XElement	parseXMLGZ(java.io.File file) Parse an XML file compressed by GZIP.
static XElement	parseXMLGZ(java.lang.String fileName) Parse an XML file compressed by GZIP.
void	remove(XElement element) Remove the given element from the children.
void	removeChildrenWithName(java.lang.String name) Removes all children with the given element name.
void	replace(XElement oldChild, XElement newChild) Replaces the specified child node with the new node.
void	save(java.io.File file) Save this XML into the given file.
void	save(java.io.OutputStream stream) Save this XML into the supplied output stream.
void	save(java.lang.String fileName) Save this XML into the given file.
void	save(java.io.Writer writer) Save this XML into the supplied output writer.
void	set(java.lang.String name, java.lang.Object value) Set an attribute value.
java.lang.String	toString()
void	visit(boolean depthFirst, java.util.function.Consumer<? super XElement> action) Iterate through the elements of this XElement and invoke the action for each.

Methods inherited from class hu.akarnokd.xml.XElementBase

doubleValue, doubleValue, formatDateTime, formatDateTime, intValue, intValue, longValue, longValue, parseDateTime, sanitize, setValue

Methods inherited from class java.lang.Object

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

Field Detail

attributes

protected final java.util.Map<java.lang.String,java.lang.String> attributes

The attribute map.

children

protected final java.util.List<XElement> children

The child elements.

parent

public XElement parent

The parent element.

Constructor Detail

XElement

public XElement(java.lang.String name)

Constructor. Sets the name.

Parameters:

name - the element name

XElement

public XElement(java.lang.String name,
                java.lang.Object value)

Creates a new XElement and sets its content according to the supplied value.

Parameters:

name - the element name

value - the content value

Method Detail

parseXML

public static XElement parseXML(byte[] data)
                         throws javax.xml.stream.XMLStreamException

Parse an XML from the binary data.

Parameters:

data - the XML data

Returns:

the parsed xml

Throws:

javax.xml.stream.XMLStreamException - on error

parseXML

public static XElement parseXML(java.io.File file)
                         throws javax.xml.stream.XMLStreamException

Parse an XML from the given local file.

Parameters:

file - the file object

Returns:

az XElement object

Throws:

javax.xml.stream.XMLStreamException - on error

parseXML

public static XElement parseXML(java.io.InputStream in)
                         throws javax.xml.stream.XMLStreamException

Parse an XML document from the given input stream. Does not close the stream.

Parameters:

in - the input stream

Returns:

az XElement object

Throws:

javax.xml.stream.XMLStreamException - on error

parseXML

public static XElement parseXML(java.io.Reader in)
                         throws javax.xml.stream.XMLStreamException

Parse an XML document from the given reader. Does not close the stream.

Parameters:

in - the InputStream object

Returns:

az XElement object

Throws:

javax.xml.stream.XMLStreamException - on error

parseXML

public static XElement parseXML(java.sql.ResultSet rs,
                                int index)
                         throws java.sql.SQLException,
                                java.io.IOException,
                                javax.xml.stream.XMLStreamException

Reads the contents of a indexed column as an XML.

Parameters:

rs - the result set to read from

index - the column index

Returns:

the parsed XNElement or null if the column contained null

Throws:

java.sql.SQLException - on SQL error

java.io.IOException - on IO error

javax.xml.stream.XMLStreamException - on parsing error

parseXML

public static XElement parseXML(java.sql.ResultSet rs,
                                java.lang.String column)
                         throws java.sql.SQLException,
                                java.io.IOException,
                                javax.xml.stream.XMLStreamException

Reads the contents of a named column as an XML.

Parameters:

rs - the result set to read from

column - the column name

Returns:

the parsed XNElement or null if the column contained null

Throws:

java.sql.SQLException - on SQL error

java.io.IOException - on IO error

javax.xml.stream.XMLStreamException - on parsing error

parseXML

public static XElement parseXML(java.lang.String fileName)
                         throws javax.xml.stream.XMLStreamException

Parse an XML from the given local filename.

Parameters:

fileName - the file name

Returns:

az XElement object

Throws:

javax.xml.stream.XMLStreamException - on error

parseXML

public static XElement parseXML(java.net.URL u)
                         throws javax.xml.stream.XMLStreamException,
                                java.io.IOException

Parses an XML from the given URL.

Parameters:

u - the url

Returns:

the parsed XML

Throws:

javax.xml.stream.XMLStreamException - on error

java.io.IOException - on error

parseXML

public static XElement parseXML(javax.xml.stream.XMLStreamReader in)
                         throws javax.xml.stream.XMLStreamException

Parse an XML from an XML stream reader. Does not close the stream

Parameters:

in - the XMLStreamReader object

Returns:

az XElement object

Throws:

javax.xml.stream.XMLStreamException - on error

parseXMLFragment

public static XElement parseXMLFragment(javax.xml.stream.XMLStreamReader in)
                                 throws javax.xml.stream.XMLStreamException

Parse an XML from an XML stream reader. Does not close the stream

Parameters:

in - the XMLStreamReader object

Returns:

az XElement object

Throws:

javax.xml.stream.XMLStreamException - on error

parseXMLGZ

public static XElement parseXMLGZ(java.io.File file)
                           throws javax.xml.stream.XMLStreamException

Parse an XML file compressed by GZIP.

Parameters:

file - the file

Returns:

the parsed XML

Throws:

javax.xml.stream.XMLStreamException - on error

parseXMLGZ

public static XElement parseXMLGZ(java.lang.String fileName)
                           throws javax.xml.stream.XMLStreamException

Parse an XML file compressed by GZIP.

Parameters:

fileName - the filename

Returns:

the parsed XML

Throws:

javax.xml.stream.XMLStreamException - on error

add

public void add(java.lang.Iterable<XElement> elements)

Add the iterable of elements as children.

Parameters:

elements - the elements to add

add

public XElement add(java.lang.String name)

Add a new child element with the given name.

Parameters:

name - the element name

Returns:

the created XElement

add

public XElement add(java.lang.String name,
                    java.lang.Object value)

Add an element with the supplied content text.

Parameters:

name - the name

value - the content

Returns:

the new element

add

public void add(XElement... elements)

Add the array of elements as children.

Parameters:

elements - the elements to add

add

public void add(XElement element)

Add the array of elements as children.

Parameters:

element - the element to add

attributes

public java.util.Map<java.lang.String,java.lang.String> attributes()

Returns:

the attribute map.

childElement

public XElement childElement(java.lang.String name)

Returns the first child element with the given name.

Parameters:

name - the child name

Returns:

the XElement or null if not present

children

public java.util.List<XElement> children()

Returns:

The child elements.

childrenWithName

public java.lang.Iterable<XElement> childrenWithName(java.lang.String name)

Returns an iterator which enumerates all children with the given name.

Parameters:

name - the name of the children to select

Returns:

the iterator

clear

public void clear()

Remove attributes and children.

copy

public XElement copy()

Specified by:

copy in class XElementBase

Returns:

Creates a deep copy of this element.

copyFrom

public void copyFrom(XElement other)

Copy the attributes, content and child elements from the other element in a deep-copy fashion.

Parameters:

other - the other element

detach

public void detach()

Detach this element from its parent.

get

public java.lang.String get(java.lang.String attributeName)

get

public java.lang.String get(java.lang.String attributeName,
                            java.lang.String def)

getBoolean

public boolean getBoolean(java.lang.String name)

getBoolean

public boolean getBoolean(java.lang.String name,
                          boolean defaultValue)

getByte

public byte getByte(java.lang.String key)

getByte

public byte getByte(java.lang.String key,
                    byte defaultValue)

getChar

public char getChar(java.lang.String key)

getChar

public char getChar(java.lang.String key,
                    char defaultValue)

getDouble

public double getDouble(java.lang.String name)

getDouble

public double getDouble(java.lang.String name,
                        double defaultValue)

getDoubleObject

public java.lang.Double getDoubleObject(java.lang.String attributeName)

Get a double attribute as object or null if not present.

Parameters:

attributeName - the attribute name

Returns:

the integer value

getEnum

public <E extends java.lang.Enum<E>> E getEnum(java.lang.String name,
                                               java.lang.Class<E> clazz)

getEnum

public <E extends java.lang.Enum<E>> E getEnum(java.lang.String name,
                                               java.lang.Class<E> clazz,
                                               E defaultValue)

getEnum

public <E extends java.lang.Enum<E>> E getEnum(java.lang.String key,
                                               E[] universe)

getEnum

public <E extends java.lang.Enum<E>> E getEnum(java.lang.String key,
                                               E[] universe,
                                               E defaultValue)

getFloat

public float getFloat(java.lang.String attributeName)

getFloat

public float getFloat(java.lang.String key,
                      float defaultValue)

getInt

public int getInt(java.lang.String attributeName)

getInt

public int getInt(java.lang.String attributeName,
                  int def)

getIntObject

public java.lang.Integer getIntObject(java.lang.String attributeName)

Get an integer attribute as object or null if not present.

Parameters:

attributeName - the attribute name

Returns:

the integer value

getLong

public long getLong(java.lang.String attributeName)

getLong

public long getLong(java.lang.String attributeName,
                    long def)

getShort

public short getShort(java.lang.String key)

getShort

public short getShort(java.lang.String key,
                      short defaultValue)

has

public boolean has(java.lang.String attributeName)

hasChildren

public boolean hasChildren()

Returns:

are there any children?

hasDouble

public boolean hasDouble(java.lang.String attributeName)

Check if there is a valid integer attribute.

Parameters:

attributeName - the attribute name

Returns:

true if the attribute is a valid int

hasFloat

public boolean hasFloat(java.lang.String attributeName)

Check if there is a valid integer attribute.

Parameters:

attributeName - the attribute name

Returns:

true if the attribute is a valid int

hasInt

public boolean hasInt(java.lang.String attributeName)

Check if there is a valid integer attribute.

Parameters:

attributeName - the attribute name

Returns:

true if the attribute is a valid int

hasLong

public boolean hasLong(java.lang.String attributeName)

Check if there is a valid integer attribute.

Parameters:

attributeName - the attribute name

Returns:

true if the attribute is a valid int

hasPositiveInt

public boolean hasPositiveInt(java.lang.String attributeName)

Check if there is a valid positive integer attribute.

Parameters:

attributeName - the attribute name

Returns:

true if the attribute is a valid positive int

isNullOrEmpty

public boolean isNullOrEmpty(java.lang.String attributeName)

Check if the given attribute is present an is not empty.

Parameters:

attributeName - the attribute name

Returns:

true if null or empty

remove

public void remove(XElement element)

Remove the given element from the children.

Parameters:

element - the element

removeChildrenWithName

public void removeChildrenWithName(java.lang.String name)

Removes all children with the given element name.

Parameters:

name - the element name

replace

public void replace(XElement oldChild,
                    XElement newChild)

Replaces the specified child node with the new node. If the old node is not present the method does nothing.

Parameters:

oldChild - the old child

newChild - the new child

save

public void save(java.io.File file)
          throws java.io.IOException

Save this XML into the given file.

Parameters:

file - the file

Throws:

java.io.IOException - on error

save

public void save(java.io.OutputStream stream)
          throws java.io.IOException

Save this XML into the supplied output stream.

Parameters:

stream - the output stream

Throws:

java.io.IOException - on error

save

public void save(java.lang.String fileName)
          throws java.io.IOException

Save this XML into the given file.

Parameters:

fileName - the file name

Throws:

java.io.IOException - on error

save

public void save(java.io.Writer writer)
          throws java.io.IOException

Save this XML into the supplied output writer.

Parameters:

writer - the output writer

Throws:

java.io.IOException - on error

set

public void set(java.lang.String name,
                java.lang.Object value)

Set an attribute value.

Parameters:

name - the attribute name

value - the content value, null will remove any existing

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

visit

public void visit(boolean depthFirst,
                  java.util.function.Consumer<? super XElement> action)

Iterate through the elements of this XElement and invoke the action for each.

Parameters:

depthFirst - do a depth first search?

action - the action to invoke, non-null

childValue

public java.lang.String childValue(java.lang.String name)

Description copied from class: XElementBase

Returns the content of the first child which has the given name.

Specified by:

childValue in class XElementBase

Parameters:

name - the child name

Returns:

the content or null if no such child