name.pehl.piriti.xml.client

Class AbstractXmlWriter<T>

java.lang.Object

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

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

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

Type Parameters:

T - The type

All Implemented Interfaces:

com.google.gwt.event.shared.HasHandlers, HasModelWriteHandler<T>, XmlWriter<T>

public abstract class AbstractXmlWriter<T>
extends AbstractWriter<T>
implements XmlWriter<T>

Base class for generated XmlWriters. 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	AbstractXmlWriter()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	appendModel(XmlBuilder xmlBuilder, T model)
protected abstract String	modelName()
protected String	modelsName()
String	toXml(List<T> models) Serializes the specified models to XML.
String	toXml(List<T> models, String rootElement) Serializes the specified models to XML using the specified name for the root element.
String	toXml(List<T> models, String rootElement, String nestedRootElement) Serializes the specified models to XML using the specified names for the root and nested elements.
String	toXml(T model) Serializes the specified model to XML.
String	toXml(T model, String rootElement) Serializes the specified model to XML using the specified name for the root element.

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

addModelWriteHandler, fireEvent

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.HasModelWriteHandler

addModelWriteHandler

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

fireEvent

Field Detail

xmlRegistry

protected final XmlRegistry xmlRegistry

Constructor Detail

AbstractXmlWriter

protected AbstractXmlWriter()

Method Detail

toXml

public String toXml(List<T> models)

Description copied from interface: XmlWriter

Serializes the specified models to XML. For the root element and the nested elements the following default values are used:

1. Root element: The classname of T with the first letter converted to lowercase and a trailing 's'
2. Nested elements: The classname of T with the first letter converted to lowercase

Given you want to serialize a list of books:

 List<Book> books = ...;
 XmlWriter<Book> xmlWriter = ...;
 String xml = xmlWriter.toXml(books);
 

Then the xml will have the following structure:

 <books>
     <book>
         ...
     </book>
     ...
 </books>
 

Specified by:

toXml in interface XmlWriter<T>

Parameters:

models - the models to serialize

Returns:

the relevant XML or null if models is null

toXml

public String toXml(List<T> models,
           String rootElement)

Description copied from interface: XmlWriter

Serializes the specified models to XML using the specified name for the root element. For the nested elements the classname of T with the first letter converted to lowercase is used.

Specified by:

toXml in interface XmlWriter<T>

Parameters:

models - the models to serialize

rootElement - the name for the root element

Returns:

the relevant XML or null if models and/or rootElement is null

toXml

public String toXml(List<T> models,
           String rootElement,
           String nestedRootElement)

Description copied from interface: XmlWriter

Serializes the specified models to XML using the specified names for the root and nested elements.

Specified by:

toXml in interface XmlWriter<T>

Parameters:

models - the models to serialize

rootElement - the name for the root element

nestedRootElement - the name of the nested elements

Returns:

the relevant XML or null if models, rootElement and/or nestedRootElement is null

toXml

public String toXml(T model)

Description copied from interface: XmlWriter

Serializes the specified model to XML. For the root element the classname of T with the first letter converted to lowercase is used.

Given you want to serialize a book:

 Book book = ...;
 XmlWriter<Book> xmlWriter = ...;
 String xml = xmlWriter.toXml(book);
 

Then the xml will have the following structure:

 <book>
     ...
 </book>
 

Specified by:

toXml in interface XmlWriter<T>

Parameters:

model - the model to serialize

Returns:

the relevant XML or null if model is null

toXml

public String toXml(T model,
           String rootElement)

Description copied from interface: XmlWriter

Serializes the specified model to XML using the specified name for the root element.

Specified by:

toXml in interface XmlWriter<T>

Parameters:

model - the model to serialize

rootElement - the name for the root element

Returns:

the relevant XML or null if model and/or rootElement is null

appendModel

public abstract void appendModel(XmlBuilder xmlBuilder,
               T model)

modelName

protected abstract String modelName()

modelsName

protected String modelsName()