com.ibm.xsp.model
Class AbstractViewDataSource

java.lang.Object
  com.ibm.xsp.complex.ValueBindingObjectImpl
      com.ibm.xsp.model.AbstractDataSource
          com.ibm.xsp.model.AbstractViewDataSource

All Implemented Interfaces:

ComponentBindingObject, ValueBindingObject, DataPublishingObject, DataSource, ModelDataSource, ViewDataSource, javax.faces.component.StateHolder

Direct Known Subclasses:

DominoViewData

public abstract class AbstractViewDataSource
extends AbstractDataSource
implements ViewDataSource

This is published because it is in the inheritence heirarchy of a public data source, but it not intended to be subclassed, and the API may change. Not intended to be subclassed.

Nested Class Summary

Nested classes/interfaces inherited from class com.ibm.xsp.model.AbstractDataSource

AbstractDataSource.RuntimeProperties

Field Summary

Fields inherited from class com.ibm.xsp.model.AbstractDataSource

NO_VARS

Constructor Summary

AbstractViewDataSource()

Method Summary

protected abstract ViewDataContainer	doOpenView(javax.faces.context.FacesContext context) Open the view
javax.faces.el.MethodBinding	getPostOpenView() Triggered after opening the view.
javax.faces.el.MethodBinding	getQueryOpenView() Triggered before opening the view.
protected java.lang.Object	invoke(javax.faces.context.FacesContext context, javax.faces.el.MethodBinding methodBinding, java.lang.Object[] params, java.lang.Object view)
boolean	isReadonly() Return true if this is a read only data object
protected abstract boolean	isReadOnly(java.lang.Object view) Is the specified view read only
DataContainer	load(javax.faces.context.FacesContext context) Load the associated data container
DataContainer	openView(javax.faces.context.FacesContext context) Open the specified view
protected java.util.List<DataPublisher.ShadowedObject>	pushData(javax.faces.context.FacesContext context, java.lang.Object document, boolean isReadOnly)
void	restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
boolean	save(javax.faces.context.FacesContext context, DataContainer data) Save the current state of the data object
java.lang.Object	saveState(javax.faces.context.FacesContext context)
void	setPostOpenView(javax.faces.el.MethodBinding binding) Triggered after opening the view.
void	setQueryOpenView(javax.faces.el.MethodBinding binding) Triggered before opening the view.

Methods inherited from class com.ibm.xsp.model.AbstractDataSource

beginRuntimeProperties, composeUniqueId, computeUniqueBeanId, createRuntimeProperties, endRuntimeProperties, getBeanId, getDataContainer, getDataContainer, getDataObject, getEffectiveScope, getRequestParamPrefix, getRuntimeProperties, getScope, getUniqueId, getVar, getVars, getViewRoot, hasRuntimeProperties, initializeRuntimeProperties, isDataShared, isIgnoreRequestParams, isNestedInUIIterator, popData, prefixRequestParam, pushData, putDataContainer, readRequestParams, refresh, removeBean, removeBean, save, setIgnoreRequestParams, setRequestParamPrefix, setScope, setVar

Methods inherited from class com.ibm.xsp.complex.ValueBindingObjectImpl

getComponent, getFacesContext, getValueBinding, isTransient, setComponent, setTransient, setValueBinding

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.ibm.xsp.model.ViewDataSource

isView

Methods inherited from interface com.ibm.xsp.model.ModelDataSource

getDataModel

Methods inherited from interface com.ibm.xsp.model.DataSource

getBeanId, getDataContainer, getRequestParamPrefix, getScope, getUniqueId, getVar, getVars, isIgnoreRequestParams, refresh, save, setIgnoreRequestParams, setRequestParamPrefix, setScope, setVar

Methods inherited from interface com.ibm.xsp.model.DataPublishingObject

popData, pushData

Constructor Detail

AbstractViewDataSource

public AbstractViewDataSource()

Method Detail

load

public DataContainer load(javax.faces.context.FacesContext context)
                   throws java.io.IOException

Description copied from class: AbstractDataSource

Load the associated data container

Specified by:

load in class AbstractDataSource

Throws:

java.io.IOException

isReadonly

public boolean isReadonly()

Description copied from class: AbstractDataSource

Return true if this is a read only data object

Specified by:

isReadonly in interface DataSource

Specified by:

isReadonly in class AbstractDataSource

save

public boolean save(javax.faces.context.FacesContext context,
                    DataContainer data)
             throws FacesExceptionEx

Description copied from class: AbstractDataSource

Save the current state of the data object

Specified by:

save in class AbstractDataSource

Throws:

FacesExceptionEx

getPostOpenView

public javax.faces.el.MethodBinding getPostOpenView()

Description copied from interface: ViewDataSource

Triggered after opening the view.

Specified by:

getPostOpenView in interface ViewDataSource

Returns:

binding

getQueryOpenView

public javax.faces.el.MethodBinding getQueryOpenView()

Description copied from interface: ViewDataSource

Triggered before opening the view.

Specified by:

getQueryOpenView in interface ViewDataSource

Returns:

binding

setPostOpenView

public void setPostOpenView(javax.faces.el.MethodBinding binding)

Description copied from interface: ViewDataSource

Triggered after opening the view.

Specified by:

setPostOpenView in interface ViewDataSource

setQueryOpenView

public void setQueryOpenView(javax.faces.el.MethodBinding binding)

Description copied from interface: ViewDataSource

Triggered before opening the view.

Specified by:

setQueryOpenView in interface ViewDataSource

openView

public DataContainer openView(javax.faces.context.FacesContext context)
                       throws java.io.IOException

Description copied from interface: ViewDataSource

Open the specified view

Specified by:

openView in interface ViewDataSource

Throws:

java.io.IOException

invoke

protected java.lang.Object invoke(javax.faces.context.FacesContext context,
                                  javax.faces.el.MethodBinding methodBinding,
                                  java.lang.Object[] params,
                                  java.lang.Object view)

pushData

protected java.util.List<DataPublisher.ShadowedObject> pushData(javax.faces.context.FacesContext context,
                                                                java.lang.Object document,
                                                                boolean isReadOnly)

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext context)

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class AbstractDataSource

restoreState

public void restoreState(javax.faces.context.FacesContext context,
                         java.lang.Object state)

Specified by:

restoreState in interface javax.faces.component.StateHolder

Overrides:

restoreState in class AbstractDataSource

doOpenView

protected abstract ViewDataContainer doOpenView(javax.faces.context.FacesContext context)

Open the view

Parameters:

context -

Returns:

isReadOnly

protected abstract boolean isReadOnly(java.lang.Object view)

Is the specified view read only

Parameters:

document -

Returns: