com.extjs.gxt.ui.client.data
Class XmlReader<D>

java.lang.Object
  extended by com.extjs.gxt.ui.client.data.XmlReader<D>
Type Parameters:
D - the type of data being returned by the reader
All Implemented Interfaces:
DataReader<D>
Direct Known Subclasses:
XmlLoadResultReader

public class XmlReader<D>
extends java.lang.Object
implements DataReader<D>

A DataReader implementation that reads XML data using a ModelType definition and produces a set of ModelData instances.

Subclasses can override createReturnData(Object, List, int) to control what object is returned by the reader. Subclass may override newModelInstance() to return any model data subclass.

  // defines the xml structure
  ModelType type = new ModelType();
  type.setRecordName("record"); // The repeated element which contains row information
  type.setRoot("records"); // the optional root element that contains the total attribute (optional)
  type.setTotalName("total"); // The element which contains the total dataset size (optional)
 


Constructor Summary
XmlReader(ModelType modelType)
          Creates a new xml reader instance.
 
Method Summary
protected  java.lang.Object createReturnData(java.lang.Object loadConfig, java.util.List<ModelData> records, int totalCount)
          Responsible for the object being returned by the reader.
protected  com.google.gwt.core.client.JavaScriptObject getJsObject(com.google.gwt.xml.client.Element elem)
           
protected  java.lang.String getValue(com.google.gwt.xml.client.Element elem, java.lang.String name)
           
protected  ModelData newModelInstance()
          Returns the new model instances.
 D read(java.lang.Object loadConfig, java.lang.Object data)
          Reads the raw data and returns the typed data.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

XmlReader

public XmlReader(ModelType modelType)
Creates a new xml reader instance.

Parameters:
modelType - the model type
Method Detail

read

public D read(java.lang.Object loadConfig,
              java.lang.Object data)
Description copied from interface: DataReader
Reads the raw data and returns the typed data.

Specified by:
read in interface DataReader<D>
data - the data to read
Returns:
the data

createReturnData

protected java.lang.Object createReturnData(java.lang.Object loadConfig,
                                            java.util.List<ModelData> records,
                                            int totalCount)
Responsible for the object being returned by the reader.

Parameters:
loadConfig - the load config
records - the list of models
totalCount - the total count
Returns:
the data to be returned by the reader

getJsObject

protected com.google.gwt.core.client.JavaScriptObject getJsObject(com.google.gwt.xml.client.Element elem)

getValue

protected java.lang.String getValue(com.google.gwt.xml.client.Element elem,
                                    java.lang.String name)

newModelInstance

protected ModelData newModelInstance()
Returns the new model instances. Subclasses may override to provide a model data subclass.

Returns:
the new model data instance