|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
ObjectDataGridStateFactory
public final class DataGridStateFactory
Factory class used to construct instances of DataGridState
objects. This
class is used by the data grid and other clients to obtain the state for a data grid
with a given name.
Data grid state information is scoped by a unique data grid String name. This name
should be unique for a particular scope in a request. For all factory methods that
take a data grid name as a parameter, the value of the name
attribute
should match the value of the
DataGrid.setName(String)
attribute for the data grid whose state to lookup.
Method Summary | |
---|---|
void |
attachDataGridState(String name,
DataGridState state)
Convenience method that allows a DataGridState object from a client to
be attached to the factory. |
DataGridState |
getDataGridState(String name)
Lookup a DataGridState object given a data grid identifier. |
DataGridState |
getDataGridState(String name,
DataGridConfig config)
Lookup a DataGridState object given a data grid identifier and a specific
DataGridConfig object. |
DataGridURLBuilder |
getDataGridURLBuilder(String name)
Lookup a DataGridURLBuilder object given a data grid identifier. |
DataGridURLBuilder |
getDataGridURLBuilder(String name,
DataGridConfig config)
Lookup a DataGridURLBuilder object given a data grid identifier and a specific
DataGridConfig object. |
static DataGridStateFactory |
getInstance(JspContext jspContext)
Get an instance of a DataGridStateFactory given a JspContext . |
static DataGridStateFactory |
getInstance(ServletRequest request)
Get an instance of a DataGridStateFactory given a ServletRequest . |
Methods inherited from class Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Method Detail |
---|
public static final DataGridStateFactory getInstance(JspContext jspContext)
JspContext
.
jspContext
- the current JspContext
public static final DataGridStateFactory getInstance(ServletRequest request)
ServletRequest
.
request
- the current ServletRequest
public final DataGridState getDataGridState(String name)
Lookup a DataGridState
object given a data grid identifier.
This method will use the default DataGridConfig
object when returning a data grid specific
implementation of the DataGridState
object. In order to specify a DataGridConfig
,
the getDataGridState(String, DataGridConfig)
can be supplied
with a specific data grid configuration.
name
- the name of a data grid.
DataGridState
for the data grid with the given namepublic final DataGridState getDataGridState(String name, DataGridConfig config)
Lookup a DataGridState
object given a data grid identifier and a specific
DataGridConfig
object.
name
- the name of the data gridconfig
- the DataGridConfig
object to use when creating the
grid's DataGridState
object.
public final DataGridURLBuilder getDataGridURLBuilder(String name)
Lookup a DataGridURLBuilder
object given a data grid identifier.
This method will use the default DataGridConfig
object when returning a data grid specific
implementation of the DataGridURLBuilder
object. In order to specify a DataGridConfig
,
the getDataGridURLBuilder(String, DataGridConfig)
can be supplied
with a specific data grid configuration.
name
- the name of the data grid
DataGridURLBuilder
for the data grid with the given namepublic final DataGridURLBuilder getDataGridURLBuilder(String name, DataGridConfig config)
Lookup a DataGridURLBuilder
object given a data grid identifier and a specific
DataGridConfig
object.
name
- the name of the data gridconfig
- the DataGridConfig
object to use when creating the
grid's DataGridURLBuilder
object.
public final void attachDataGridState(String name, DataGridState state)
Convenience method that allows a DataGridState
object from a client to
be attached to the factory. This allows subsequent calls to retrieve this same DataGridState
instance.
name
- the name of the data gridstate
- the DataGridState
object to attach
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |