|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.endeca.portal.data.AbstractMDEXStateManager
public abstract class AbstractMDEXStateManager
An abstract base class for MDEX State Managers. Contains utility methods that implementing classes may find useful.
Field Summary | |
---|---|
protected static org.apache.log4j.Logger |
logger
|
Constructor Summary | |
---|---|
AbstractMDEXStateManager()
|
Method Summary | |
---|---|
protected void |
addEventTrigger(javax.portlet.PortletRequest request,
MDEXState ds)
Use this method to make sure an appropriate change event will be triggered for an altered MDEXState. |
abstract QueryState |
handleStateInitial(javax.portlet.PortletRequest request,
MDEXState mdexState)
Handles retrieval of the initial query state from a data source; used for query-time determination of the query a portlet should fire during portlet execution. |
abstract QueryState |
handleStateMerge(javax.portlet.PortletRequest request,
MDEXState mdexState)
Handles retrieval of a query state from a data source; used for query-time determination of the query a portlet should fire during portlet execution. |
abstract void |
handleStateReset(javax.portlet.PortletRequest request,
MDEXState mdexState)
Handle resetting of the query state to its initial state; used for initialization of a data source or user-visible controls to remove all filters. |
abstract void |
handleStateUpdate(javax.portlet.PortletRequest request,
MDEXState mdexState,
QueryState newQueryState)
Handles updating a data source with a new query state. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected static org.apache.log4j.Logger logger
Constructor Detail |
---|
public AbstractMDEXStateManager()
Method Detail |
---|
public abstract void handleStateUpdate(javax.portlet.PortletRequest request, MDEXState mdexState, QueryState newQueryState) throws QueryStateException
MDEXStateManager
DataSource.setQueryState(QueryState newState)
handleStateUpdate
in interface MDEXStateManager
request
- the current PortletRequestmdexState
- the MDEXState representing the current data sourcenewQueryState
- the query state to be set onto the data source
QueryStateException
public abstract QueryState handleStateMerge(javax.portlet.PortletRequest request, MDEXState mdexState) throws QueryStateException
MDEXStateManager
DataSource.getQueryState()
handleStateMerge
in interface MDEXStateManager
request
- the current PortletRequestmdexState
- the MDEXState representing the current data source
QueryStateException
public abstract void handleStateReset(javax.portlet.PortletRequest request, MDEXState mdexState) throws QueryStateException
MDEXStateManager
DataSource.resetQueryState()
handleStateReset
in interface MDEXStateManager
request
- the current PortletRequestmdexState
- the MDEXState representing the current data source
QueryStateException
public abstract QueryState handleStateInitial(javax.portlet.PortletRequest request, MDEXState mdexState) throws QueryStateException
MDEXStateManager
DataSource.getInitialQueryState()
handleStateInitial
in interface MDEXStateManager
request
- the current PortletRequestmdexState
- the MDEXState representing the current data source
QueryStateException
protected void addEventTrigger(javax.portlet.PortletRequest request, MDEXState ds)
handleStateReset(PortletRequest, MDEXState)
and from handleStateUpdate(PortletRequest, MDEXState, QueryState)
to ensure
all portlets are aware of the change.
request
- the current PortletRequestds
- The MDEXState representing the data source that has changed and needs an event triggered
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |