com.webmethods.caf.jcr.faces.data

Class SearchTableContentProvider

java.lang.Object

com.webmethods.caf.faces.bean.PageFlowScopeAdapter

com.webmethods.caf.jcr.faces.data.BaseIteratorTableContentProvider

com.webmethods.caf.jcr.faces.data.SearchTableContentProvider

All Implemented Interfaces:

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

public class SearchTableContentProvider
extends BaseIteratorTableContentProvider

CAF table content provider for exposing the results of a JCR Query for display in a CAF table.

Since:

8.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.webmethods.caf.jcr.faces.data.BaseIteratorTableContentProvider

m_index, m_selectableHelper, m_var

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

fExpireWithPageFlow

Constructor Summary

Constructors

Constructor and Description
SearchTableContentProvider() Default Constructor.
SearchTableContentProvider(javax.jcr.Session jcrSession, String searchQuery, String queryLanguage) Constructor

Method Summary

Modifier and Type	Method and Description
String	getQueryLanguage() Returns the JCR query language
String	getQueryString() Returns the JCR query string
protected Class	getRowType() Returns the row type for the table control
protected boolean	hasValidInputParameters() Checks if the input parameters are valid
protected javax.jcr.RangeIterator	invokeSearch() Performs the work to perform the JCR query and return the results.
boolean	isUseNodeAsRow() If true, the search results will be javax.jcr.Node objects.
void	setQueryLanguage(String queryLanguage) Sets the JCR query language.
void	setQueryString(String queryString) Sets the JCR query string
void	setUseNodeAsRow(boolean useNodeAsRow) Sets whether the search results will be javax.jcr.Node objects or javax.jcr.query.Row objects

Methods inherited from class com.webmethods.caf.jcr.faces.data.BaseIteratorTableContentProvider

getCurrentRow, getJcrSession, getNeedRefresh, getPropertyKeys, getRowCount, getRowId, getRowIndex, getRowSelectedCount, getRowSelectedIds, getRowUnselectedIds, getRowVariable, getSelectedRows, getSort, getType, getUniqueId, getUseUnselectedModel, getValue, hasProperty, isAddressable, isAutoRefresh, isRowAvailable, isRowSelected, refresh, setAutoRefresh, setJcrSession, setNeedRefresh, setRowById, setRowIndex, setRowSelected, setRowSelectedIds, setRowUnselectedIds, setRowVariable, setSort, supportsAutoRefresh

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

getExpireWithPageFlow, setExpireWithPageFlow

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

SearchTableContentProvider

public SearchTableContentProvider()

Default Constructor. Must call BaseIteratorTableContentProvider.setJcrSession(Session), setQueryString(String) and setQueryLanguage(String)} before using this provider.

SearchTableContentProvider

public SearchTableContentProvider(javax.jcr.Session jcrSession,
                                  String searchQuery,
                                  String queryLanguage)

Constructor

Parameters:

jcrSession - the active JCR session

searchQuery - the JCR query string

queryLanguage - the JCR query language to use

Method Detail

getRowType

protected Class getRowType()

Description copied from class: BaseIteratorTableContentProvider

Returns the row type for the table control

Overrides:

getRowType in class BaseIteratorTableContentProvider

Returns:

always returns the Node class

isUseNodeAsRow

public boolean isUseNodeAsRow()

If true, the search results will be javax.jcr.Node objects. Otherwise, they will be javax.jcr.query.Row objects

Returns:

the useNodeAsRow

setUseNodeAsRow

public void setUseNodeAsRow(boolean useNodeAsRow)

Sets whether the search results will be javax.jcr.Node objects or javax.jcr.query.Row objects

Parameters:

useNodeAsRow - the useNodeAsRow to set

getQueryString

public String getQueryString()

Returns the JCR query string

Returns:

the queryString

setQueryString

public void setQueryString(String queryString)

Sets the JCR query string

Parameters:

queryString - the queryString to set

getQueryLanguage

public String getQueryLanguage()

Returns the JCR query language

Returns:

the queryLanguage

setQueryLanguage

public void setQueryLanguage(String queryLanguage)

Sets the JCR query language. The queryLanguage must match one of the available languages for the repository (usually 'xpath' or 'sql')

Parameters:

queryLanguage - the queryLanguage to set

hasValidInputParameters

protected boolean hasValidInputParameters()

Checks if the input parameters are valid

Specified by:

hasValidInputParameters in class BaseIteratorTableContentProvider

See Also:

BaseIteratorTableContentProvider.hasValidInputParameters()

invokeSearch

protected javax.jcr.RangeIterator invokeSearch()

Performs the work to perform the JCR query and return the results.

Specified by:

invokeSearch in class BaseIteratorTableContentProvider

Returns:

node iterator