name.pehl.piriti.xml.client

Interface XmlReader<T>

Type Parameters:

T - The type

All Superinterfaces:

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

All Known Implementing Classes:

AbstractXmlReader

public interface XmlReader<T>
extends Reader<T>, HasModelReadHandler<T,name.pehl.totoe.xml.client.Element>

Interface for converting XML document / element to an instance of T or a list of Ts. All properties of T and superclasses of T are handled by the generated XmlReader implementation. If there's data for the property it is assigned with the converted value, otherwise the property remains unchanged.

The setup of the XmlReader is inspired by the UiBinder and is typically specified as an inner class:

 pubilc SmartYakizakanaState
 {
     interface Reader extends XmlReader<SmartYakizakanaState> {}
     public static final Reader XML = GWT.create(Reader.class);
     
     // The properties of this POJO annotated with XmlField.
 }
 

An XML document can then be converted to an instance of SmartYakizakanaState by calling

 Document document = ...;
 SmartYakizakanaState sys = SmartYakizakanaState.XML.read(document);
 

Version:

$LastChangedRevision: 46 $

Author:

$LastChangedBy: harald.pehl $

Method Summary

Methods

Modifier and Type	Method and Description
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 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

Method Detail

readList

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

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 readList(Document):

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

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

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.

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

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.

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

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.

Parameters:

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

Returns:

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

readList

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.

Parameters:

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

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.

read

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

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 read(Document):

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

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

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.

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

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.

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.