oracle.adf.view.faces.bi.model

Class ClientKeyManager

java.lang.Object

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

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

UIGrid.DefaultClientKeyManager

public abstract class ClientKeyManager
extends java.lang.Object
implements java.io.Serializable

This class manages server-side cellkey Objects with client-side string keys. This class must be Serializable as it is state-saved along with the UIComponent state.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ClientKeyManager()

Method Summary

Modifier and Type	Method and Description
abstract void	clean(java.util.Set stringCellKey) Prunes the client-side key cache based on which cell keys are still in the client.
abstract void	clear() Clears the client-side key cache.
abstract 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.
abstract 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

ClientKeyManager

public ClientKeyManager()

Method Detail

clean

public abstract void clean(java.util.Set stringCellKey)

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.

clear

public abstract void clear()

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.

getClientCellKey

public abstract 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.

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:

getCellKey

public abstract 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.

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