com.bstek.dorado.data.provider

Class AbstractDataProvider

java.lang.Object

com.bstek.dorado.data.provider.AbstractDataProvider

All Implemented Interfaces:

MetaDataSupport, Namable, Scopable, DataModelObject, DataProvider

Direct Known Subclasses:

DirectDataProvider

public abstract class AbstractDataProvider
extends java.lang.Object
implements DataProvider, Namable, Scopable

数据提供者的抽象实现类。

Since:

Mar 3, 2007

Author:

Benny Bao (mailto:benny.bao@bstek.com)

Constructor Summary

Constructors

Constructor and Description
AbstractDataProvider()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getId()
java.util.Map<java.lang.String,java.lang.Object>	getMetaData()
java.lang.String	getName() 返回DataProvider的名称。
void	getPagingResult(java.lang.Object parameter, Page<?> page) 获得返回给外界的数据。
void	getPagingResult(java.lang.Object parameter, Page<?> page, DataType resultDataType) 获得返回给外界的数据。
void	getPagingResult(Page<?> page) 使用默认参数调用DataProvider，并获得返回给外界的数据。
java.lang.Object	getParameter() 设置默认参数。
java.lang.Object	getResult() 使用默认参数调用DataProvider，并获得返回给外界的数据。
java.lang.Object	getResult(java.lang.Object parameter) 获得返回给外界的数据。
java.lang.Object	getResult(java.lang.Object parameter, DataType resultDataType) 获得返回给外界的数据。
DataType	getResultDataType() 返回结果的数据类型。
Scope	getScope() 返回作用范围。
protected abstract void	internalGetPagingResult(java.lang.Object parameter, Page<?> page, DataType resultDataType) 内部的获得返回给外界的数据的方法。
protected abstract java.lang.Object	internalGetResult(java.lang.Object parameter, DataType resultDataType) 内部的获得返回给外界的数据的方法。
void	setId(java.lang.String id)
void	setMetaData(java.util.Map<java.lang.String,java.lang.Object> metaData)
void	setName(java.lang.String name) 设置DataProvider的名称。
void	setParameter(java.lang.Object parameter) 设置默认参数。
void	setResultDataType(DataType resultDataType) 设置结果的数据类型。
void	setScope(Scope scope) 设置作用范围。
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractDataProvider

public AbstractDataProvider()

Method Detail

getName

public java.lang.String getName()

Description copied from interface: DataProvider

返回DataProvider的名称。

Specified by:

getName in interface Namable

Specified by:

getName in interface DataModelObject

Specified by:

getName in interface DataProvider

setName

public void setName(java.lang.String name)

设置DataProvider的名称。

Specified by:

setName in interface Namable

getId

public java.lang.String getId()

Specified by:

getId in interface DataModelObject

setId

public void setId(java.lang.String id)

Specified by:

setId in interface DataModelObject

getScope

public Scope getScope()

Description copied from interface: DataProvider

返回作用范围。

Specified by:

getScope in interface DataProvider

setScope

public void setScope(Scope scope)

Description copied from interface: Scopable

设置作用范围。

Specified by:

setScope in interface Scopable

getResultDataType

public DataType getResultDataType()

Description copied from interface: DataProvider

返回结果的数据类型。

Specified by:

getResultDataType in interface DataProvider

setResultDataType

public void setResultDataType(DataType resultDataType)

Description copied from interface: DataProvider

设置结果的数据类型。

Specified by:

setResultDataType in interface DataProvider

getParameter

public java.lang.Object getParameter()

Description copied from interface: DataProvider

设置默认参数。

Specified by:

getParameter in interface DataProvider

setParameter

public void setParameter(java.lang.Object parameter)

Description copied from interface: DataProvider

设置默认参数。

Specified by:

setParameter in interface DataProvider

internalGetResult

protected abstract java.lang.Object internalGetResult(java.lang.Object parameter,
                                 DataType resultDataType)
                                               throws java.lang.Exception

内部的获得返回给外界的数据的方法。

Parameters:

parameter - 参数

resultDataType - 结果的数据类型。

Returns:

要返回给外界的数据

Throws:

java.lang.Exception

internalGetPagingResult

protected abstract void internalGetPagingResult(java.lang.Object parameter,
                           Page<?> page,
                           DataType resultDataType)
                                         throws java.lang.Exception

内部的获得返回给外界的数据的方法。

Parameters:

parameter - 参数

page - 用于封装分页结果的对象。

resultDataType - 结果的数据类型。

Throws:

java.lang.Exception

See Also:

Page

getResult

public java.lang.Object getResult()
                           throws java.lang.Exception

Description copied from interface: DataProvider

使用默认参数调用DataProvider，并获得返回给外界的数据。

Specified by:

getResult in interface DataProvider

Throws:

java.lang.Exception

getResult

public java.lang.Object getResult(java.lang.Object parameter)
                           throws java.lang.Exception

Description copied from interface: DataProvider

获得返回给外界的数据。

Specified by:

getResult in interface DataProvider

Parameters:

parameter - 参数

Returns:

要返回给外界的数据

Throws:

java.lang.Exception

getResult

public java.lang.Object getResult(java.lang.Object parameter,
                         DataType resultDataType)
                           throws java.lang.Exception

Description copied from interface: DataProvider

获得返回给外界的数据。

Specified by:

getResult in interface DataProvider

Parameters:

parameter - 参数

resultDataType - 结果的数据类型。

Returns:

要返回给外界的数据

Throws:

java.lang.Exception

getPagingResult

public void getPagingResult(Page<?> page)
                     throws java.lang.Exception

Description copied from interface: DataProvider

使用默认参数调用DataProvider，并获得返回给外界的数据。

Specified by:

getPagingResult in interface DataProvider

Parameters:

page - 用于封装分页结果的对象。

Throws:

java.lang.Exception

See Also:

Page

getPagingResult

public void getPagingResult(java.lang.Object parameter,
                   Page<?> page)
                     throws java.lang.Exception

Description copied from interface: DataProvider

获得返回给外界的数据。

Specified by:

getPagingResult in interface DataProvider

Parameters:

parameter - 参数

page - 用于封装分页结果的对象。

Throws:

java.lang.Exception

See Also:

Page

getPagingResult

public void getPagingResult(java.lang.Object parameter,
                   Page<?> page,
                   DataType resultDataType)
                     throws java.lang.Exception

Description copied from interface: DataProvider

获得返回给外界的数据。

Specified by:

getPagingResult in interface DataProvider

Parameters:

parameter - 参数

page - 用于封装分页结果的对象。

resultDataType - 结果的数据类型。

Throws:

java.lang.Exception

See Also:

Page

getMetaData

public java.util.Map<java.lang.String,java.lang.Object> getMetaData()

Specified by:

getMetaData in interface MetaDataSupport

setMetaData

public void setMetaData(java.util.Map<java.lang.String,java.lang.Object> metaData)

Specified by:

setMetaData in interface MetaDataSupport

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object