name.pehl.piriti.xml.client

Class AbstractXmlReader<T>

java.lang.Object

name.pehl.piriti.commons.client.ReaderWriterBase<T>

name.pehl.piriti.commons.client.AbstractReader<T,name.pehl.totoe.xml.client.Element>

name.pehl.piriti.xml.client.AbstractXmlReader<T>

Type Parameters:

T - The type

All Implemented Interfaces:

com.google.gwt.event.shared.HasHandlers, HasModelReadHandler<T,name.pehl.totoe.xml.client.Element>, Reader<T>, XmlReader<T>

public abstract class AbstractXmlReader<T>
extends AbstractReader<T,name.pehl.totoe.xml.client.Element>
implements XmlReader<T>

Base class for generated XmlReaders. Contains common code and methods.

Version:

$LastChangedRevision:$

Author:

$LastChangedBy:$

Field Summary

Fields

Modifier and Type	Field and Description
protected XmlRegistry	xmlRegistry

Fields inherited from class name.pehl.piriti.commons.client.ReaderWriterBase

handlerManager, idMap, logger

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractXmlReader()

Method Summary

Methods

Modifier and Type	Method and Description
protected List<name.pehl.totoe.xml.client.Element>	filterElements(List<name.pehl.totoe.xml.client.Node> nodes)
protected List<T>	internalReadList(List<name.pehl.totoe.xml.client.Element> elements)
T	read(name.pehl.totoe.xml.client.Document document) Convert the data in the specified document to an instance of T according to the annotated properties in T.
T	read(name.pehl.totoe.xml.client.Element element) Convert the data in the specified element to an instance of T according to the annotated properties in T.
T	read(String xml) Convert the data in the specified document to an instance of T according to the annotated properties in T.
List<T>	readList(name.pehl.totoe.xml.client.Document document) Convert the direct children of the documents root element to a list of Ts according to the annotated properties in T.
List<T>	readList(name.pehl.totoe.xml.client.Document document, String xpath) Convert the data in the specified document to a list of Ts according to the annotated properties in T.
List<T>	readList(name.pehl.totoe.xml.client.Element element) Convert the direct children of the specified element to a list of Ts according to the annotated properties in T.
List<T>	readList(name.pehl.totoe.xml.client.Element element, String xpath) Convert the data in the specified element to a list of Ts according to the annotated properties in T.
List<T>	readList(String xml) Convert the direct children of the root element from the specified XML to a list of Ts according to the annotated properties in T.

Methods inherited from class name.pehl.piriti.commons.client.AbstractReader

addModelReadHandler, fireEvent, idRef, newModel, readId, readIdRefs, readProperties

Methods inherited from class java.lang.Object

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

Methods inherited from interface name.pehl.piriti.commons.client.Reader

idRef

Methods inherited from interface name.pehl.piriti.commons.client.HasModelReadHandler

addModelReadHandler

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Field Detail

xmlRegistry

protected final XmlRegistry xmlRegistry

Constructor Detail

AbstractXmlReader

protected AbstractXmlReader()

Method Detail

readList

public List<T> readList(String xml)
                 throws name.pehl.totoe.xml.client.XmlParseException

Description copied from interface: XmlReader

Convert the direct children of the root element from the specified XML to a list of Ts according to the annotated properties in T.

Please note: Use this method only if your XML does not contain namespaces. Othherwise you have to parse the xml yourself and call XmlReader.readList(Document):

 String xmlWithNamespaces = "...";
 Document document = new XmlParser().parse(xmlWithNamespaces, "...");
 List<T> models = reader.readList(document);
 

Specified by:

readList in interface XmlReader<T>

Parameters:

xml - The XML used as input. May be null.

Returns:

A list of T instances with the mapped XML data or null if the xml is null or empty.

Throws:

name.pehl.totoe.xml.client.XmlParseException - if there's an error parsing the xml

readList

public List<T> readList(name.pehl.totoe.xml.client.Document document)

Description copied from interface: XmlReader

Convert the direct children of the documents root element to a list of Ts according to the annotated properties in T.

Specified by:

readList in interface XmlReader<T>

Parameters:

document - The XML document used as input. May be null.

Returns:

A list of T instances with the mapped XML data or null if the document is null or the document has no root element.

readList

public List<T> readList(name.pehl.totoe.xml.client.Document document,
               String xpath)

Description copied from interface: XmlReader

Convert the data in the specified document to a list of Ts according to the annotated properties in T.

Specified by:

readList in interface XmlReader<T>

Parameters:

document - The XML document used as input. May be null.

xpath - An xpath expression which should result in a list of elements which in turn is used to generate the instances of T

Returns:

A list of T instances with the mapped XML data or null if the document is null.

readList

public List<T> readList(name.pehl.totoe.xml.client.Element element)

Description copied from interface: XmlReader

Convert the direct children of the specified element to a list of Ts according to the annotated properties in T.

Specified by:

readList in interface XmlReader<T>

Returns:

A list of T instances with the mapped XML data or null if the element is null.

readList

public List<T> readList(name.pehl.totoe.xml.client.Element element,
               String xpath)

Description copied from interface: XmlReader

Convert the data in the specified element to a list of Ts according to the annotated properties in T.

Specified by:

readList in interface XmlReader<T>

xpath - An xpath expression which should result in a list of elements which in turn are used to generate the instances of T

Returns:

A list of T instances with the mapped XML data or null if the element is null.

internalReadList

protected List<T> internalReadList(List<name.pehl.totoe.xml.client.Element> elements)

read

public T read(String xml)
       throws name.pehl.totoe.xml.client.XmlParseException

Description copied from interface: XmlReader

Convert the data in the specified document to an instance of T according to the annotated properties in T.

Please note: Use this method only if your XML does not contain namespaces. Othherwise you have to parse the xml yourself and call XmlReader.read(Document):

 String xmlWithNamespaces = "...";
 Document document = new XmlParser().parse(xmlWithNamespaces, "...");
 T model = reader.read(document);
 

Specified by:

read in interface XmlReader<T>

Parameters:

xml - The XML used as input. May be null.

Returns:

An instance of T with the mapped XML data or null if the xml is null or empty.

Throws:

name.pehl.totoe.xml.client.XmlParseException - if there's an error parsing the xml

read

public T read(name.pehl.totoe.xml.client.Document document)

Description copied from interface: XmlReader

Convert the data in the specified document to an instance of T according to the annotated properties in T.

Specified by:

read in interface XmlReader<T>

Parameters:

document - The XML document used as input. May be null.

Returns:

An instance of T with the mapped XML data or null if the document is null or the document has no root element.

read

public T read(name.pehl.totoe.xml.client.Element element)

Description copied from interface: XmlReader

Convert the data in the specified element to an instance of T according to the annotated properties in T.

Specified by:

read in interface XmlReader<T>

Parameters:

element - The XML element used as input. May be null.

Returns:

An instance of T with the mapped XML data or null if the element is null.

filterElements

protected List<name.pehl.totoe.xml.client.Element> filterElements(List<name.pehl.totoe.xml.client.Node> nodes)