com.sencha.gxt.data.shared.loader

Class AbstractAutoBeanReader<M,B,D>

java.lang.Object

com.sencha.gxt.data.shared.loader.AbstractAutoBeanReader<M,B,D>

Type Parameters:

M - Expected model type by the Loader that uses this DataReader

B - Intermediate type before getting to M, allowing createReturnData(Object, Object) to further modify the data

D - Incoming data type from the DataProxy

All Implemented Interfaces:

DataReader<M,D>

Direct Known Subclasses:

JsonReader, JsoReader, XmlReader

public abstract class AbstractAutoBeanReader<M,B,D>
extends Object
implements DataReader<M,D>

Abstract base class for Readers that turn the incoming data into AutoBeans.

Constructor Summary

Constructors

Constructor and Description
AbstractAutoBeanReader(AutoBeanFactory factory, Class<B> rootBeanType) Creates a new loader.

Method Summary

Modifier and Type	Method and Description
protected M	createReturnData(Object loadConfig, B records) Responsible for the object being returned by the reader.
M	read(Object loadConfig, D data) Reads the raw data and returns the typed data.
protected abstract Splittable	readSplittable(Object loadConfig, D data) Implemented by subclasses to provide a Splittable based on the incoming data.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractAutoBeanReader

public AbstractAutoBeanReader(AutoBeanFactory factory,
                              Class<B> rootBeanType)

Creates a new loader.

Parameters:

factory - AutoBeanFactory instance capable of building all of the required classes

rootBeanType - AutoBean based type to represent the base data in the Splittable

Method Detail

read

public M read(Object loadConfig,
              D data)

Description copied from interface: DataReader

Reads the raw data and returns the typed data.

Specified by:

read in interface DataReader<M,D>

Parameters:

loadConfig - the load config information

data - the data to read

Returns:

the processed and / or converted data

createReturnData

protected M createReturnData(Object loadConfig,
                             B records)

Responsible for the object being returned by the reader. Default implementation casts right to the return type, but can be overridden to provide a more specialized implementation.

Parameters:

loadConfig - the load config

records - the list of models

Returns:

the data to be returned by the reader

readSplittable

protected abstract Splittable readSplittable(Object loadConfig,
                                             D data)

Implemented by subclasses to provide a Splittable based on the incoming data.

Parameters:

loadConfig - the load config

data - the data to read

Returns:

the splittable instance