com.webmethods.caf.faces.data.csp

Class CSPContentSearchProvider

java.lang.Object

com.webmethods.caf.faces.bean.BaseFacesBean

com.webmethods.caf.faces.bean.BaseFacesSessionBean

com.webmethods.caf.faces.data.csp.CSPBaseProvider

com.webmethods.caf.faces.data.csp.CSPContentSearchProvider

All Implemented Interfaces:

IPageFlowScopeAdapter, IAddressableTableContentProvider, IContentProvider, IRefreshable, IRefreshableContentProvider, ISelectableTableContentProvider, ISortableTableContentProvider, ITableContentProvider, Serializable, EventListener, HttpSessionBindingListener

public class CSPContentSearchProvider
extends CSPBaseProvider
implements ITableContentProvider, IRefreshableContentProvider, ISelectableTableContentProvider, ISortableTableContentProvider

This provider is intended to be used for exposing Contents from CSP. However to work properly it should be provided Session instance and a Node Id (the content type). Except these two fields all others are optional and have some default values.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.webmethods.caf.faces.data.csp.CSPBaseProvider

fRetrievalModule, fSession

Fields inherited from class com.webmethods.caf.faces.bean.BaseFacesSessionBean

fExpireWithPageFlow

Fields inherited from class com.webmethods.caf.faces.bean.BaseFacesBean

DATA_BINDING_CLIENTS, OUTCOME_ERROR, OUTCOME_OK, resourcesProviders

Constructor Summary

Constructors

Constructor and Description
CSPContentSearchProvider()

Method Summary

Methods

Modifier and Type	Method and Description
protected List<CSPContent>	getCSPContents()
Object	getCurrentRow() Returns wrapped current row object.
CSPIndexDefinitionProvider	getIndexDefinitionProvider()
boolean	getNeedRefresh() Returns true when IRefreshable.isAutoRefresh() is on and the result properties need to be refreshed from the data source by executing IRefreshable.refresh() method.
boolean	getPermanentDelete()
Object[]	getPropertyKeys() Returns list of properties supported by this content provider.
int	getResultCount()
int	getRowCount() Return the number of rows of data objects represented by this DataModel.
String	getRowId() Returns unique identifier for the current row.
int	getRowIndex() Return the zero-relative index of the currently selected row.
int	getRowSelectedCount() Returns number of selected rows.
Collection	getRowSelectedIds() Returns collection of String ids of the selected rows.
protected Class<CSPContent>	getRowType()
Collection	getRowUnselectedIds() Returns collection of String ids of the un-selected rows (all other rows are selected implicitly) May be empty or contain non-existent ids; never null, never contains null.
String	getRowVariable() Returns row variable name.
CSPSearchQuery	getSearchQuery()
List<Object>	getSelectedRows()
ISortInfo	getSort() Returns current sort info.
Class<String>	getType(Object propertyKey) Returns java type of the given property
boolean	getUseUnselectedModel() Returns true if it's more effecient to use unselected model (ie ISelectableTableContentProvider.getRowUnselectedIds() rather than ISelectableTableContentProvider.getRowSelectedIds()).
Object	getValue(Object propertyKey) Returns value of the given property
boolean	hasProperty(Object propertyKey) Checks if the given property is supported by this content provider
boolean	isAddressable() Checks if this content provider truly is addressable.
boolean	isAutoRefresh() Returns true if the provider is currenlty in auto-refresh mode
boolean	isRowAvailable() Return a flag indicating whether there is rowData available at the current rowIndex.
boolean	isRowSelected() Returns true if current row is selected.
boolean	isSubNodesIncluded()
void	refresh() Make the search and sort the results.
void	setAutoRefresh(boolean autorefresh) Sets auto refresh mode on.
void	setIncludeSubNode(Boolean includeSubNodes)
void	setIndexDefinitionProvider(CSPIndexDefinitionProvider indexDefinitionProvider)
void	setNeedRefresh(boolean needRefresh) Tells the provider that the input parameters have changed and the output results need to be refreshed the next time any output property is requested via IContentProvider.getValue(Object).
void	setPermanentDelete(boolean permanentDelete) Deleting content in CSP is not really removing, it's deactivating.
void	setResultCount(int count) Sets how many results will return #listAttachments().
void	setRowById(String id) Selects current row by its id.
void	setRowIndex(int rowIndex) Set the zero-relative index of the currently selected row, or -1 to indicate that we are not positioned on a row.
void	setRowSelected(boolean selected) Sets the selection status for the current row.
void	setRowSelectedIds(Collection ids) Sets new selection using a collection of String ids of the rows to select.
void	setRowUnselectedIds(Collection ids) Unselects rows using a collection of String ids of the un-selected rows (all other rows are selected implicitly).
void	setRowVariable(String var) Sets row variable name to use for accessing row specific data.
void	setSearchQuery(CSPSearchQuery searchQuery)
void	setSort(ISortInfo sortInfo) Sets new sort info, re-sorting the table (if necessary).
protected void	sort()
boolean	supportsAutoRefresh() Returns true if this content provider supports auto refresh feature.

Methods inherited from class com.webmethods.caf.faces.data.csp.CSPBaseProvider

checkState, getSession, release, setSession

Methods inherited from class com.webmethods.caf.faces.bean.BaseFacesSessionBean

getExpireWithPageFlow, setExpireWithPageFlow, valueBound, valueUnbound

Methods inherited from class com.webmethods.caf.faces.bean.BaseFacesBean

createMethodBinding, createMethodExpression, createValueBinding, createValueExpression, createValueExpression, error, error, error, error, error, getBean, getFacesContext, getLocale, getResourceInputStream, getResources, getResourcesProvider, getRootCause, getStackTrace, getTreeAttribute, isUserInRole, log, log, log, putTreeAttribute, resetDataBindingClients, resolveDataBinding, resolveDataBinding, resolveExpression, setValue

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.webmethods.caf.faces.data.IContentProvider

toString

Constructor Detail

CSPContentSearchProvider

public CSPContentSearchProvider()

Method Detail

setIncludeSubNode

public void setIncludeSubNode(Boolean includeSubNodes)

isSubNodesIncluded

public boolean isSubNodesIncluded()

setResultCount

public void setResultCount(int count)

Sets how many results will return #listAttachments(). Default is 100.

Parameters:

count - How many result will return #listAttachments().

getResultCount

public int getResultCount()

setPermanentDelete

public void setPermanentDelete(boolean permanentDelete)

Deleting content in CSP is not really removing, it's deactivating. If you want to really delete content set permanentDelete to true. Deactivated content behaves like removed - it's not visible, included in searches etc.

Parameters:

permanentDelete - Defines whether content to physically delete the content. Default is false.

getPermanentDelete

public boolean getPermanentDelete()

getNeedRefresh

public boolean getNeedRefresh()

Description copied from interface: IRefreshable

Returns true when IRefreshable.isAutoRefresh() is on and the result properties need to be refreshed from the data source by executing IRefreshable.refresh() method.

Implementations may return an accurate value from this method if they can track the changes to the input parameter properties or they may require the clients to call IRefreshable.setNeedRefresh(boolean) explicitely.

Specified by:

getNeedRefresh in interface IRefreshable

Returns:

true when the output properties are not up-to-date with the current input parameters, i.e. IRefreshable.refresh() needs to be executed manually or automatically.

isAutoRefresh

public boolean isAutoRefresh()

Description copied from interface: IRefreshable

Returns true if the provider is currenlty in auto-refresh mode

Specified by:

isAutoRefresh in interface IRefreshable

Returns:

false if auto-refresh mode is off or not supported

refresh

public void refresh()
             throws ContentProviderException

Make the search and sort the results. The search actually searches for CSPContents based on the provided node ids and CSPContent index key/value pairs. The expression used for the search is not limited to absolute values. It is also possible to use asterisks to broaden the search.

Specified by:

refresh in interface IRefreshable

Throws:

ContentProviderException - if error loading data from the data source

sort

protected void sort()

getCSPContents

protected List<CSPContent> getCSPContents()

setAutoRefresh

public void setAutoRefresh(boolean autorefresh)
                    throws ContentProviderException

Description copied from interface: IRefreshable

Sets auto refresh mode on. When auto refresh mode is on, the provider calls IRefreshable.getNeedRefresh() to determine whether the refresh needs to be done before returning any result properties. If it returns true, the provider calls IRefreshable.refresh() method to updated the result properties.

Specified by:

setAutoRefresh in interface IRefreshable

Parameters:

autorefresh - true to turn it on

Throws:

ContentProviderException - if auto refresh mode is not supported

See Also:

IRefreshable.supportsAutoRefresh(), IRefreshable.getNeedRefresh(), IRefreshable.setNeedRefresh(boolean)

setNeedRefresh

public void setNeedRefresh(boolean needRefresh)

Description copied from interface: IRefreshable

Tells the provider that the input parameters have changed and the output results need to be refreshed the next time any output property is requested via IContentProvider.getValue(Object).

Specified by:

setNeedRefresh in interface IRefreshable

Parameters:

needRefresh - true if the input parameters have changed

supportsAutoRefresh

public boolean supportsAutoRefresh()

Description copied from interface: IRefreshable

Returns true if this content provider supports auto refresh feature.

Specified by:

supportsAutoRefresh in interface IRefreshable

Returns:

true when auto refresh is supported

See Also:

IRefreshable.setAutoRefresh(boolean)

getSearchQuery

public CSPSearchQuery getSearchQuery()

setSearchQuery

public void setSearchQuery(CSPSearchQuery searchQuery)

getPropertyKeys

public Object[] getPropertyKeys()

Description copied from interface: IContentProvider

Returns list of properties supported by this content provider. Can return Object[0], never null.

Specified by:

getPropertyKeys in interface IContentProvider

Returns:

array of property keys which is typically of type String or Integer

getValue

public Object getValue(Object propertyKey)
                throws EvaluationException,
                       PropertyNotFoundException

Description copied from interface: IContentProvider

Returns value of the given property

Specified by:

getValue in interface IContentProvider

Parameters:

propertyKey - the property key of type String or Integer

Returns:

value of the property, can be null

Throws:

EvaluationException - if error during property evaluation

PropertyNotFoundException - if property is not supported

getRowType

protected Class<CSPContent> getRowType()

hasProperty

public boolean hasProperty(Object propertyKey)

Description copied from interface: IContentProvider

Checks if the given property is supported by this content provider

Specified by:

hasProperty in interface IContentProvider

Parameters:

propertyKey - property key of type String or Integer

Returns:

true if property is supported

getRowSelectedCount

public int getRowSelectedCount()

Description copied from interface: ISelectableTableContentProvider

Returns number of selected rows.

Specified by:

getRowSelectedCount in interface ISelectableTableContentProvider

Returns:

number of currently selection rows

getRowSelectedIds

public Collection getRowSelectedIds()

Description copied from interface: ISelectableTableContentProvider

Returns collection of String ids of the selected rows. May be empty or contain non-existent ids; never null, never contains null.

Specified by:

getRowSelectedIds in interface ISelectableTableContentProvider

Returns:

collection of ids of selected rows

getSelectedRows

public List<Object> getSelectedRows()

getRowUnselectedIds

public Collection getRowUnselectedIds()

Description copied from interface: ISelectableTableContentProvider

Returns collection of String ids of the un-selected rows (all other rows are selected implicitly) May be empty or contain non-existent ids; never null, never contains null.

Specified by:

getRowUnselectedIds in interface ISelectableTableContentProvider

Returns:

collection of ids of the un-selection rows

getUseUnselectedModel

public boolean getUseUnselectedModel()

Description copied from interface: ISelectableTableContentProvider

Returns true if it's more effecient to use unselected model (ie ISelectableTableContentProvider.getRowUnselectedIds() rather than ISelectableTableContentProvider.getRowSelectedIds()).

Specified by:

getUseUnselectedModel in interface ISelectableTableContentProvider

Returns:

true if it's more effecient to use unselected model

isRowSelected

public boolean isRowSelected()

Description copied from interface: ISelectableTableContentProvider

Returns true if current row is selected.

Specified by:

isRowSelected in interface ISelectableTableContentProvider

Returns:

true if current row is selection

setRowSelected

public void setRowSelected(boolean selected)

Description copied from interface: ISelectableTableContentProvider

Sets the selection status for the current row.

Specified by:

setRowSelected in interface ISelectableTableContentProvider

Parameters:

selected - true to select current row; false to unselect.

setRowSelectedIds

public void setRowSelectedIds(Collection ids)

Description copied from interface: ISelectableTableContentProvider

Sets new selection using a collection of String ids of the rows to select. May be empty or contain non-existent ids; never null, never contains null.

Specified by:

setRowSelectedIds in interface ISelectableTableContentProvider

Parameters:

ids - the collection of String row ids

setRowUnselectedIds

public void setRowUnselectedIds(Collection ids)

Description copied from interface: ISelectableTableContentProvider

Unselects rows using a collection of String ids of the un-selected rows (all other rows are selected implicitly). May be empty or contain non-existent ids; never null, never contains null.

Specified by:

setRowUnselectedIds in interface ISelectableTableContentProvider

Parameters:

ids - collection of String row ids

isAddressable

public boolean isAddressable()

Description copied from interface: IAddressableTableContentProvider

Checks if this content provider truly is addressable.

Specified by:

isAddressable in interface IAddressableTableContentProvider

Returns:

true if addressable.

setRowById

public void setRowById(String id)

Description copied from interface: IAddressableTableContentProvider

Selects current row by its id. If id doesn't identify a row, makes no row current (equivalent to setRowIndex(-1)).

Specified by:

setRowById in interface IAddressableTableContentProvider

Parameters:

id - row id to find and make current

getCurrentRow

public Object getCurrentRow()

Description copied from interface: ITableContentProvider

Returns wrapped current row object. Can be null if not data is available

Specified by:

getCurrentRow in interface ITableContentProvider

Returns:

current row object

See Also:

ITableContentProvider.isRowAvailable()

getRowCount

public int getRowCount()

Description copied from interface: ITableContentProvider

Return the number of rows of data objects represented by this DataModel.

Return -1, if the number of rows is unknown, or no wrappedData is available.

Specified by:

getRowCount in interface ITableContentProvider

See Also:

DataModel.getRowCount()

getRowIndex

public int getRowIndex()

Description copied from interface: ITableContentProvider

Return the zero-relative index of the currently selected row.

If we are not currently positioned on a row, or no wrappedData is available, return -1.

Specified by:

getRowIndex in interface ITableContentProvider

See Also:

DataModel.getRowIndex()

getRowVariable

public String getRowVariable()

Description copied from interface: ITableContentProvider

Returns row variable name.

If specified row variable can be used to access current row data for the provider internal needs, like sorting or addressing.

Specified by:

getRowVariable in interface ITableContentProvider

Returns:

row variable name or null if not specified

See Also:

ITableContentProvider.setRowVariable(String)

isRowAvailable

public boolean isRowAvailable()

Description copied from interface: ITableContentProvider

Return a flag indicating whether there is rowData available at the current rowIndex. If no wrappedData is available, return false.

Specified by:

isRowAvailable in interface ITableContentProvider

See Also:

DataModel.isRowAvailable()

setRowIndex

public void setRowIndex(int rowIndex)

Description copied from interface: ITableContentProvider

Set the zero-relative index of the currently selected row, or -1 to indicate that we are not positioned on a row.

Specified by:

setRowIndex in interface ITableContentProvider

See Also:

DataModel.getRowIndex()

setRowVariable

public void setRowVariable(String var)

Description copied from interface: ITableContentProvider

Sets row variable name to use for accessing row specific data. For example, if the provider wrapps an array of a data objects with id property and the variable name is item, then the provider implementation can access id property of each record as item.id.

This property should set only once at the provider initialization time

Specified by:

setRowVariable in interface ITableContentProvider

getType

public Class<String> getType(Object propertyKey)
                      throws PropertyNotFoundException

Description copied from interface: IContentProvider

Returns java type of the given property

Specified by:

getType in interface IContentProvider

Parameters:

propertyKey - the property key of type String or Integer

Returns:

property java Class

Throws:

PropertyNotFoundException - if property is not supported

getRowId

public String getRowId()

Description copied from interface: IAddressableTableContentProvider

Returns unique identifier for the current row. If no current row is avaiable, returns null.

Specified by:

getRowId in interface IAddressableTableContentProvider

Returns:

current row id or null

getSort

public ISortInfo getSort()

Description copied from interface: ISortableTableContentProvider

Returns current sort info. Never null.

Specified by:

getSort in interface ISortableTableContentProvider

Returns:

currenly set sort info

setSort

public void setSort(ISortInfo sortInfo)

Description copied from interface: ISortableTableContentProvider

Sets new sort info, re-sorting the table (if necessary). This does not change the model's rowIndex property, even though it will probably now point to a different row.

Specified by:

setSort in interface ISortableTableContentProvider

Parameters:

sortInfo - Sort info, must not be null.

getIndexDefinitionProvider

public CSPIndexDefinitionProvider getIndexDefinitionProvider()

setIndexDefinitionProvider

public void setIndexDefinitionProvider(CSPIndexDefinitionProvider indexDefinitionProvider)