de.hybris.platform.print.util.table

Interface AxisDataProvider

All Known Implementing Classes:

CategoryProductDataProvider, ClassAttrDataProvider, ItemListDataProvider, PagePlacementsProvider, PageProductsProvider, SingleItemDataProvider, VariantAttributesDataProvider, VariantProductsDataProvider

public interface AxisDataProvider

An AxisDataProvider delivers row/column objects that represent the same amount of row/column entries in the related table. It may process none, one or more parameters and generates its resulting amount of row/column objects from this input.

Method Summary

Modifier and Type	Method and Description
Object	getDataAt(int index) Returns the row/column object at the specified row/column position
Class	getDataType() Specifies the Class/type of objects that this AxisDataProvider returns
String	getDisplayName() Returns the String that is displayed as name for this AxisDataProvider (could be a localized name depending on the session language)
List<ParameterDescriptor>	getParameters() Returns a list of parameters that are expected/required by this AxisDataProvider
int	getSize() Returns the amount of rows/columns that this AxisDataProvider results in
void	init(TableBlock table, AxisEntry axis, Map<String,Object> params) Initializes this AxisDataProvider

Method Detail

getDataAt

Object getDataAt(int index)

Returns the row/column object at the specified row/column position

Parameters:

index - The number of the row/column for which to get the row/column object

Returns:

The object that represents the specified row/column (e.g. a self defined POJO as data holder object)

getSize

int getSize()

Returns the amount of rows/columns that this AxisDataProvider results in

Returns:

The amount of rows/columns that this AxisDataProvider results in

getDataType

Class getDataType()

Specifies the Class/type of objects that this AxisDataProvider returns

Returns:

The Class/type of objects that this AxisDataProvider returns

getDisplayName

String getDisplayName()

Returns the String that is displayed as name for this AxisDataProvider (could be a localized name depending on the session language)

Returns:

The String that is displayed as name for this AxisDataProvider (could be a localized name depending on the session language)

getParameters

List<ParameterDescriptor> getParameters()

Returns a list of parameters that are expected/required by this AxisDataProvider

Returns:

A list of parameters that are expected/required by this AxisDataProvider

init

void init(TableBlock table,
          AxisEntry axis,
          Map<String,Object> params)

Initializes this AxisDataProvider

Parameters:

table - The table this AxisDataProvider is used within

axis - The AxisEntry this AxisDataProvider is related to

params - The parameters this AxisDataProvider expects (see also: AxisDataProvider.getParameters())