com.bstek.dorado.data.provider

Interface DataProvider

All Superinterfaces:

DataModelObject, MetaDataSupport

All Known Implementing Classes:

AbstractDataProvider, DirectDataProvider

public interface DataProvider
extends DataModelObject

数据提供者的通用接口。

DataProvider最主要的功能就是为外界提供数据。 DataProvider可以根据其自身的定义和参数自动的完成数据的提取和组装。

DataProvider可以为返回的数据定义数据类型(DataType)。 如果返回的实际数据与定义的数据类型不一致，那么DataProvider还会尽可能的将这些数据转换为需要的类型。 如果转换失败将抛出 DataConvertException异常。

需要注意的是DataProvider应该通过 DataProviderManager 来获得，直接new得到的DataProvider可能不能良好的工作。

Since:

Mar 8, 2007

Author:

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

Method Summary

Methods

Modifier and Type	Method and Description
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() 返回作用范围。
void	setParameter(java.lang.Object parameter) 设置默认参数。
void	setResultDataType(DataType resultDataType) 设置结果的数据类型。

Methods inherited from interface com.bstek.dorado.data.DataModelObject

getId, setId

Methods inherited from interface com.bstek.dorado.common.MetaDataSupport

getMetaData, setMetaData

Method Detail

getName

java.lang.String getName()

返回DataProvider的名称。

Specified by:

getName in interface DataModelObject

getScope

Scope getScope()

返回作用范围。

getResultDataType

DataType getResultDataType()

返回结果的数据类型。

setResultDataType

void setResultDataType(DataType resultDataType)

设置结果的数据类型。

getParameter

java.lang.Object getParameter()

设置默认参数。

setParameter

void setParameter(java.lang.Object parameter)

设置默认参数。

getResult

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

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

Throws:

java.lang.Exception

getResult

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

获得返回给外界的数据。

Parameters:

parameter - 参数

Returns:

要返回给外界的数据

Throws:

java.lang.Exception

getResult

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

获得返回给外界的数据。

Parameters:

parameter - 参数

resultDataType - 结果的数据类型。

Returns:

要返回给外界的数据

Throws:

java.lang.Exception

getPagingResult

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

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

Parameters:

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

Throws:

java.lang.Exception

See Also:

Page

getPagingResult

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

获得返回给外界的数据。

Parameters:

parameter - 参数

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

Throws:

java.lang.Exception

See Also:

Page

getPagingResult

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

获得返回给外界的数据。

Parameters:

parameter - 参数

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

resultDataType - 结果的数据类型。

Throws:

java.lang.Exception

See Also:

Page