oracle.adfmf.bindings.iterator

Interface BasicIterator

public interface BasicIterator

A generic interface that exposes a data provider in a DataControl hierarchy. Developers can use this to get values from providers, navigate the collection of providers, and create or delete providers in the DataControl hierarchy. This interface maintains the aspect of currency, manipulated by the First, Last, Previous, and Next operations. Operations directed at a provider object effect only the current object pointed to by the iterator. Changing the currency, provider attributes, and creating or deleting the provider pointed to by the iterator will source DataChangeEvents to the view so that any view elements bound to the current provider associated with this iterator will update.

Method Summary

Modifier and Type	Method and Description
Object	createInsertRow()
Object	createRow()
Object	createRowWithData(Object provider, boolean insertFlag)
Object[]	currentSet()
Object	first()
Class	getAttributeType(String attributeName)
Object	getAttributeValue(String attributeName)
Object	getAttributeValueAtIndex(int index, String attributeName)
BindingContainer	getBindingContainer()
int	getCurrentIndex()
Object	getCurrentRow()
Object	getCurrentRowKey()
Object[]	getCurrentValues()
DataControl	getDataControl()
Object	getDataProvider() Returns the data provider object which corresponds to the current item in the collection represented at this iterator's level in the control tree.
Object	getDataProvider(oracle.adfmf.util.XmlAnyDefinition metadataDef) Returns a named object contained in the object wrapped by this iterator binding.
Object	getExtendedAttributeInfo(Object infoKey, String attributeName)
String	getId()
int	getIndexFromKey(Object key)
Object[]	getKeys()
oracle.adfmf.util.XmlAnyDefinition	getMetadataDefinition()
Object	getProviderKey(Object provider, int fallbackIndex)
java.util.Map	getProviderMap()
int	getRangeSize()
Object[]	getSetAt(Object key, boolean previous)
int	getTotalRowCount()
boolean	hasNext()
boolean	hasPrevious()
boolean	isUpdateable(String attributeName)
Object	last()
Object	next()
Object[]	nextSet()
Object	previous()
Object[]	previousSet()
void	refresh()
void	refresh(boolean force)
Object	removeCurrentRow()
Object	removeRowWithKey(String key)
void	setAttributeValue(String attributeName, Object value)
void	setCurrentIndex(int index)
void	setCurrentIndexWithKey(Object key)
void	setCurrentRowWithKey(String key) This method sets the current row of iterator based on the key passed.
void	setCurrentRowWithKeyValue(String value) This method sets the current row of iterator based on the key passed.
void	setDataProvider(Object dataProvider) Sets the data provider object wrapped by this iterator binding.
void	setMetadataDefinition(oracle.adfmf.util.XmlAnyDefinition def)
void	setRangeSize(int rangeSize)

Method Detail

getMetadataDefinition

oracle.adfmf.util.XmlAnyDefinition getMetadataDefinition()

Returns:

The metadata definition object for this iterator binding

setMetadataDefinition

void setMetadataDefinition(oracle.adfmf.util.XmlAnyDefinition def)

Parameters:

def - The metadata definition object for this iterator binding

getDataControl

DataControl getDataControl()

getDataProvider

Object getDataProvider()

Returns the data provider object which corresponds to the current item in the collection represented at this iterator's level in the control tree.

If the iterator is part of a WebServiceDataControl, the object will be an instance of oracle.adfmf.util.GenericType.

If the iterator is part of a BeanDataControl, the object will be an instance of the element type of the collection defined for this level in the control tree.

Returns:

The current data provider object

See Also:

GenericType

getProviderMap

java.util.Map getProviderMap()

Returns:

a map containing the actual provider instances

setDataProvider

void setDataProvider(Object dataProvider)

Sets the data provider object wrapped by this iterator binding.

getDataProvider

Object getDataProvider(oracle.adfmf.util.XmlAnyDefinition metadataDef)

Returns a named object contained in the object wrapped by this iterator binding.

Parameters:

metadataDef - The metadata definition for the accessor iterator that binds to the named object contained in the object wrapped by this iterator binding.

Returns:

named object contained in the object wrapped by this iterator binding

getBindingContainer

BindingContainer getBindingContainer()

refresh

void refresh()

refresh

void refresh(boolean force)

hasNext

boolean hasNext()

hasPrevious

boolean hasPrevious()

first

Object first()

previous

Object previous()

previousSet

Object[] previousSet()

next

Object next()

nextSet

Object[] nextSet()

last

Object last()

currentSet

Object[] currentSet()

getSetAt

Object[] getSetAt(Object key,
                  boolean previous)

getCurrentIndex

int getCurrentIndex()

setCurrentIndex

void setCurrentIndex(int index)

setCurrentIndexWithKey

void setCurrentIndexWithKey(Object key)

setCurrentRowWithKey

void setCurrentRowWithKey(String key)

This method sets the current row of iterator based on the key passed.

Parameters:

key -

setCurrentRowWithKeyValue

void setCurrentRowWithKeyValue(String value)

This method sets the current row of iterator based on the key passed. In Big ADF, parameter "value" represents the internal value of a Key object and parameter "key" in setCurrentRowWithKey(String) represents the stringified Key object. MAF does not have a concept of a Key object. Therefore this method does the exact same thing as setCurrentRowWithKey(String). Essentially Key in MAF is String itself.

Parameters:

value -

getTotalRowCount

int getTotalRowCount()

getRangeSize

int getRangeSize()

setRangeSize

void setRangeSize(int rangeSize)

getCurrentRow

Object getCurrentRow()

getCurrentRowKey

Object getCurrentRowKey()

getProviderKey

Object getProviderKey(Object provider,
                      int fallbackIndex)

getIndexFromKey

int getIndexFromKey(Object key)

getKeys

Object[] getKeys()

createInsertRow

Object createInsertRow()

createRow

Object createRow()

createRowWithData

Object createRowWithData(Object provider,
                         boolean insertFlag)

removeCurrentRow

Object removeCurrentRow()

removeRowWithKey

Object removeRowWithKey(String key)

getAttributeType

Class getAttributeType(String attributeName)

isUpdateable

boolean isUpdateable(String attributeName)

getExtendedAttributeInfo

Object getExtendedAttributeInfo(Object infoKey,
                                String attributeName)

getAttributeValue

Object getAttributeValue(String attributeName)

setAttributeValue

void setAttributeValue(String attributeName,
                       Object value)

getAttributeValueAtIndex

Object getAttributeValueAtIndex(int index,
                                String attributeName)

getCurrentValues

Object[] getCurrentValues()

getId

String getId()