oracle.cabo.ui.data
Class FlattenedDataSet

java.lang.Object
  |
  +--oracle.cabo.ui.data.FlattenedDataSet

All Implemented Interfaces:

DataObject, DataObjectList, DataSet

Direct Known Subclasses:

PageEventFlattenedDataSet, ServletRequestDataSet

public abstract class FlattenedDataSet

extends java.lang.Object

implements DataSet

Abstract implementation of a DataSet for data flattened into a simple key-value structure. This class also includes utility methods that perform the name flattening. Subclasses must override getParameter to bind the data set to a specific type of request.

Constructor Summary

FlattenedDataSet(java.lang.String dataSetName)
Creates a FlattenedDataSet object for a particular data set name.

Method Summary

protected abstract DataSet	createChildren(java.lang.String childName) Hook for creating child data lists.
protected static int	getDataSetLength(java.lang.String lengthParam) Parses the length parameter into an integer value.
static java.lang.String	getFlattenedName(java.lang.String dataSetName, int dataSetIndex, java.lang.String dataObjectKey) Merge a data set name, an index into the data set, and an object key into a single name.
static java.lang.String	getFlattenedName(java.lang.String dataSetName, java.lang.String dataObjectKey) Merge a data set name and an object key into a single name.
DataObject	getItem(int index) Returns the DataObject at the index.
int	getLength() Returns the number of items in the data set.
static java.lang.String	getLengthKey(java.lang.String dataSetName) Returns the key that will be used to get the length of the data set.
protected abstract java.lang.String	getParameter(java.lang.String key) Hook for returning the parameter for a given key.
java.lang.Object	selectValue(RenderingContext context, java.lang.Object select) Given a select string, returns the value matching that selection.

Methods inherited from class java.lang.Object

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

Constructor Detail

FlattenedDataSet

public FlattenedDataSet(java.lang.String dataSetName)

Creates a FlattenedDataSet object for a particular data set name.

Method Detail

getFlattenedName

public static java.lang.String getFlattenedName(java.lang.String dataSetName,
                                                java.lang.String dataObjectKey)

Merge a data set name and an object key into a single name.

getFlattenedName

public static java.lang.String getFlattenedName(java.lang.String dataSetName,
                                                int dataSetIndex,
                                                java.lang.String dataObjectKey)

Merge a data set name, an index into the data set, and an object key into a single name. Used by the table renderer to implement RendererContext.transformName().

getLengthKey

public static java.lang.String getLengthKey(java.lang.String dataSetName)

Returns the key that will be used to get the length of the data set.

selectValue

public java.lang.Object selectValue(RenderingContext context,
                                    java.lang.Object select)

Given a select string, returns the value matching that selection. It is legal to return null if the select string doesn't match anything.

Specified by:

selectValue in interface DataObject

Parameters:

select - a select criterion, syntax as defined by the implementation of this interface.

getLength

public int getLength()

Returns the number of items in the data set.

Specified by:

getLength in interface DataObjectList

getItem

public DataObject getItem(int index)

Returns the DataObject at the index.

Specified by:

getItem in interface DataObjectList

getParameter

protected abstract java.lang.String getParameter(java.lang.String key)

Hook for returning the parameter for a given key.

createChildren

protected abstract DataSet createChildren(java.lang.String childName)

Hook for creating child data lists.

getDataSetLength

protected static int getDataSetLength(java.lang.String lengthParam)

Parses the length parameter into an integer value.