oracle.adf.view.faces.bi.component.pivotTable

Class UIGrid.DefaultClientKeyManager

java.lang.Object

oracle.adf.view.faces.bi.model.ClientKeyManager

oracle.adf.view.faces.bi.component.pivotTable.UIGrid.DefaultClientKeyManager

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

UIGrid

protected static final class UIGrid.DefaultClientKeyManager
extends ClientKeyManager

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DefaultClientKeyManager() Sole constructor.

Method Summary

Modifier and Type	Method and Description
protected static java.lang.String	cellKey2String(CellKey cellKey) Deprecated.
void	clean(java.util.Set clientStringCellKeySet) Prunes the client-side key cache based on which cell keys are still in the client.
void	clear() Clears the client-side key cache.
CellKey	getCellKey(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, java.lang.String clientCellKey) Gets the corresponding server-side cellkey object from the given client-side string key.
java.lang.String	getClientCellKey(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, CellKey cellKey) Gets a string version of a key that identifies the cell with the given cellkey.
protected static CellKey	string2CellKey(java.lang.String strCellKey) Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultClientKeyManager

protected DefaultClientKeyManager()

Sole constructor.

Method Detail

cellKey2String

@Deprecated
protected static java.lang.String cellKey2String(CellKey cellKey)

Deprecated.

string2CellKey

@Deprecated
protected static CellKey string2CellKey(java.lang.String strCellKey)

Deprecated.

clean

public void clean(java.util.Set clientStringCellKeySet)

Description copied from class: ClientKeyManager

Prunes the client-side key cache based on which cell keys are still in the client. This is typically done on the pivot table after some client keys on the client are removed. This is done to prevent a memory leak when we are short scrolling over a large amount of data and accumulating client keys when each new block is brought to the client.

Specified by:

clean in class ClientKeyManager

clear

public void clear()

Description copied from class: ClientKeyManager

Clears the client-side key cache. This is typically done on a re-render of the pivot table or after all references to client keys on the client are removed / client blocks are removed.

Specified by:

clear in class ClientKeyManager

getCellKey

public CellKey getCellKey(javax.faces.context.FacesContext context,
                          javax.faces.component.UIComponent component,
                          java.lang.String clientCellKey)

Gets the corresponding server-side cellkey object from the given client-side string key. If the string key has expired, implementors should return null. However, if any part of a cell is still present on the client-side, its corresponding string-key may not expire.

Specified by:

getCellKey in class ClientKeyManager

Parameters:

context - the Faces context

component - the UI component

clientCellKey - the string key

Returns:

the cell key, or null if the string key has expired or never existed

getClientCellKey

public java.lang.String getClientCellKey(javax.faces.context.FacesContext context,
                                         javax.faces.component.UIComponent component,
                                         CellKey cellKey)

Gets a string version of a key that identifies the cell with the given cellkey. This string key can be used on the client-side to identify the cell. If a string key for the given cellkey does not exist, then a new one is created. The lifespan of this string cellkey is entirely up to each implementation. Implementors must ensure that if a particular cell is still present on the client-side, then its string key must also continue to be valid.

Specified by:

getClientCellKey in class ClientKeyManager

Parameters:

context - the Faces context

component - the UI component

cellKey - the cellkey to convert into a client key. Note that null is special and is not allowed.

Returns: