com.ibm.xsp.model.domino
Class DominoViewData

java.lang.Object
  extended by com.ibm.xsp.complex.ValueBindingObjectImpl
      extended by com.ibm.xsp.model.AbstractDataSource
          extended by com.ibm.xsp.model.AbstractViewDataSource
              extended by com.ibm.xsp.model.domino.DominoViewData
All Implemented Interfaces:
ComponentBindingObject, ValueBindingObject, DataPublishingObject, DataSource, ModelDataSource, TabularDataSource, ViewDataSource, javax.faces.component.StateHolder

public class DominoViewData
extends AbstractViewDataSource
implements TabularDataSource

DominoViewData represents a Domino View Data Source


Nested Class Summary
protected static class DominoViewData.ViewProperties
          Runtime Preperties for the View Data Soruce
 
Nested classes/interfaces inherited from class com.ibm.xsp.model.AbstractDataSource
AbstractDataSource.RuntimeProperties
 
Field Summary
static java.lang.String COLLAPSE_ALL
           
static java.lang.String EXPAND_ALL
           
 
Fields inherited from class com.ibm.xsp.model.AbstractDataSource
NO_VARS
 
Constructor Summary
DominoViewData()
          Default Constructor
 
Method Summary
protected  java.lang.String composeUniqueId()
          Compute a unique ID for shared documents.
protected  AbstractDataSource.RuntimeProperties createRuntimeProperties()
          Create a new AbstractDataSource.RuntimeProperties instance
protected  ViewDataContainer doOpenView(javax.faces.context.FacesContext context)
          Open the view
 java.lang.String getCategoryFilter()
          Get the Category Filter used to restrict the contents of the View to descendants of this category
 java.lang.String getDatabaseName()
          Get the name of the database containing the view data source.
 java.lang.String getDataCache()
          Return how data is cached between requests (full, id, nodata)
 javax.faces.model.DataModel getDataModel()
          Return the data model associated with this data source.
 java.lang.Object getDataObject()
          Return the default data object
 int getExpandLevel()
          Return the level of expansion for entries in a hierarchical View
 java.lang.Object getKeys()
          Return the key used to filter the content of a view based on column values
 java.lang.String getParentId()
          Get the document id of the parent whose descendants will populate the view
protected  DominoViewData.ViewProperties getRuntimeProperties()
          Return the current Runtime Properties
 java.lang.String getSearch()
          Return the string that will filter the view results If it is not set in the Runtime Properties, try the value set with setSearch(), else try the value of the search property, else return null.
 java.lang.Object getSearchList()
          Return the object containing the terms used to full text search the content of an indexed view
 int getSearchMaxDocs()
          Return the maximum number of documents to include in a search result.
 java.lang.String getSortColumn()
          Return a column that can be used to sort the View Data
 java.lang.String getSortOrder()
          Return the order by which data in the sort column is collated (ascending, descending, toggle)
 java.lang.Object getStartKeys()
          Return the key used to define the first row for a view
 lotus.domino.View getView()
          Return the View the Domino View Data Source is based on
 java.lang.String getViewName()
          Return the name of the Domino View that this Data Source opens
protected  void initializeRuntimeProperties(AbstractDataSource.RuntimeProperties rtProps)
          Initialize Runtime Properties.
 boolean isKeysExactMatch()
          Return whether exact matching is applied to the filter keys
 boolean isReadonly()
          Returns true - Views are read only.
 boolean isReadOnly(java.lang.Object view)
          Returns true - Views are read only.
 boolean isSearchExactMatch()
          Return whether exact matching is applied to the filter keys
 boolean isSearchFuzzy()
          Return whether fuzzy searching is allowed e.g.
 boolean isSearchVariants()
          Return whether word variations are included in the full text query result
 boolean isView(java.lang.Object view)
          Return true if this is the view associated with this data source
 void readRequestParams(javax.faces.context.FacesContext context, java.util.Map<java.lang.String,java.lang.Object> requestMap)
          Read the request parameters for this data source
 void restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
           
 boolean save(javax.faces.context.FacesContext context, DataContainer data)
          Returns false - Views are read only.
 java.lang.Object saveState(javax.faces.context.FacesContext context)
           
 void setCategoryFilter(java.lang.String categoryFilter)
          Set the Category Filter used to restrict the contents of the View to descendants of this category
 void setDatabaseName(java.lang.String databaseName)
          Set the name of the database containing the view data source.
 void setDataCache(java.lang.String dataCache)
          Set how data is cached between requests (full, id, nodata)
 void setExpandLevel(int expandLevel)
          Set the level of expansion for entries in a hierarchical View
 void setKeys(java.lang.Object keys)
          Set the key used to filter the content of a view based on column values
 void setKeysExactMatch(boolean keysExactMatch)
          Set whether exact matching is applied to the filter keys
 void setParentId(java.lang.String parentId)
          Set the document id of the parent whose descendants will populate the view
 void setSearch(java.lang.String search)
          Set the search string to be performed on the view
 void setSearchExactMatch(boolean searchExactMatch)
          Set whether exact matching is applied to the full text search operation
 void setSearchFuzzy(boolean searchFuzzy)
          Set whether fuzzy searching is allowed e.g.
 void setSearchList(java.lang.Object searchList)
          Set an object containing a lists of search terms used to build a multi-word full text query
 void setSearchMaxDocs(int searchMaxDocs)
          Set the maximum number of documents to include in a search result.
 void setSearchVariants(boolean searchVariants)
          Set whether word variations are to be includes in the result set
 void setSortColumn(java.lang.String sortColumn)
          Set a column that can be used to sort the View Data
 void setSortOrder(java.lang.String sortOrder)
          Set the order by which data in the sort colunm is collated (ascending, descending, toggle)
 void setStartKeys(java.lang.Object startKeys)
          Set the key used to define the first row for a view
 void setViewName(java.lang.String viewName)
          Set the name of the Domino View that this Data Source opens
 
Methods inherited from class com.ibm.xsp.model.AbstractViewDataSource
getPostOpenView, getQueryOpenView, invoke, load, openView, pushData, setPostOpenView, setQueryOpenView
 
Methods inherited from class com.ibm.xsp.model.AbstractDataSource
beginRuntimeProperties, computeUniqueBeanId, endRuntimeProperties, getBeanId, getDataContainer, getDataContainer, getEffectiveScope, getRequestParamPrefix, getScope, getUniqueId, getVar, getVars, getViewRoot, hasRuntimeProperties, isDataShared, isIgnoreRequestParams, isNestedInUIIterator, popData, prefixRequestParam, pushData, putDataContainer, 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.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
 

Field Detail

EXPAND_ALL

public static final java.lang.String EXPAND_ALL
See Also:
Constant Field Values

COLLAPSE_ALL

public static final java.lang.String COLLAPSE_ALL
See Also:
Constant Field Values
Constructor Detail

DominoViewData

public DominoViewData()
Default Constructor

Method Detail

getRuntimeProperties

protected DominoViewData.ViewProperties getRuntimeProperties()
Description copied from class: AbstractDataSource
Return the current Runtime Properties

Overrides:
getRuntimeProperties in class AbstractDataSource
Returns:
the current RuntimeProperties

createRuntimeProperties

protected AbstractDataSource.RuntimeProperties createRuntimeProperties()
Description copied from class: AbstractDataSource
Create a new AbstractDataSource.RuntimeProperties instance

Overrides:
createRuntimeProperties in class AbstractDataSource
Returns:
new RuntimeProperties

initializeRuntimeProperties

protected void initializeRuntimeProperties(AbstractDataSource.RuntimeProperties rtProps)
Description copied from class: AbstractDataSource
Initialize Runtime Properties. Empty method, does nothing.

Overrides:
initializeRuntimeProperties in class AbstractDataSource
Parameters:
rtProps - Runtime Properties

readRequestParams

public void readRequestParams(javax.faces.context.FacesContext context,
                              java.util.Map<java.lang.String,java.lang.Object> requestMap)
Description copied from class: AbstractDataSource
Read the request parameters for this data source

Specified by:
readRequestParams in class AbstractDataSource

isReadOnly

public boolean isReadOnly(java.lang.Object view)
Returns true - Views are read only. (non-Javadoc)

Specified by:
isReadOnly in class AbstractViewDataSource
Returns:
See Also:
AbstractViewDataSource.isReadOnly(java.lang.Object)

isReadonly

public boolean isReadonly()
Returns true - Views are read only. (non-Javadoc)

Specified by:
isReadonly in interface DataSource
Overrides:
isReadonly in class AbstractViewDataSource
See Also:
AbstractViewDataSource.isReadonly()

save

public boolean save(javax.faces.context.FacesContext context,
                    DataContainer data)
             throws FacesExceptionEx
Returns false - Views are read only. (non-Javadoc)

Overrides:
save in class AbstractViewDataSource
Throws:
FacesExceptionEx
See Also:
AbstractViewDataSource.save(javax.faces.context.FacesContext, com.ibm.xsp.model.DataContainer)

getDataObject

public java.lang.Object getDataObject()
Description copied from class: AbstractDataSource
Return the default data object

Specified by:
getDataObject in class AbstractDataSource
Returns:

composeUniqueId

protected java.lang.String composeUniqueId()
Description copied from class: AbstractDataSource
Compute a unique ID for shared documents.

Specified by:
composeUniqueId in class AbstractDataSource
Returns:

isView

public boolean isView(java.lang.Object view)
Description copied from interface: ViewDataSource
Return true if this is the view associated with this data source

Specified by:
isView in interface ViewDataSource

doOpenView

protected ViewDataContainer doOpenView(javax.faces.context.FacesContext context)
Description copied from class: AbstractViewDataSource
Open the view

Specified by:
doOpenView in class AbstractViewDataSource
Returns:

getDataModel

public javax.faces.model.DataModel getDataModel()
Description copied from interface: ModelDataSource
Return the data model associated with this data source.

Specified by:
getDataModel in interface ModelDataSource
Returns:
The data model associated with this data source.

getView

public lotus.domino.View getView()
Return the View the Domino View Data Source is based on

Returns:

getSearch

public java.lang.String getSearch()
Return the string that will filter the view results If it is not set in the Runtime Properties, try the value set with setSearch(), else try the value of the search property, else return null.

Returns:
_searchStr the string that will filter the view results

setSearch

public void setSearch(java.lang.String search)
Set the search string to be performed on the view

Parameters:
_searchStr - the search string to be performed on the view

getSearchMaxDocs

public int getSearchMaxDocs()
Return the maximum number of documents to include in a search result. If not set, default is return Integer.MAX_VALUE

Returns:
maximum number of documents to include in a search result

setSearchMaxDocs

public void setSearchMaxDocs(int searchMaxDocs)
Set the maximum number of documents to include in a search result.

Parameters:
searchMaxDocs - the maximum number of documents to include in a search result

getDatabaseName

public java.lang.String getDatabaseName()
Get the name of the database containing the view data source. If it is not set, default is the current Database

Returns:
the databaseName

setDatabaseName

public void setDatabaseName(java.lang.String databaseName)
Set the name of the database containing the view data source.

Parameters:
databaseName - the databaseName to set

getViewName

public java.lang.String getViewName()
Return the name of the Domino View that this Data Source opens

Returns:
the name of the Domino View that this Data Source opens

setViewName

public void setViewName(java.lang.String viewName)
Set the name of the Domino View that this Data Source opens

Parameters:
viewName -

setCategoryFilter

public void setCategoryFilter(java.lang.String categoryFilter)
Set the Category Filter used to restrict the contents of the View to descendants of this category

Parameters:
categoryFilter - Category Filter used to restrict the contents of the View

getCategoryFilter

public java.lang.String getCategoryFilter()
Get the Category Filter used to restrict the contents of the View to descendants of this category

Returns:
the Category Filter used to restrict the contents of the View

setParentId

public void setParentId(java.lang.String parentId)
Set the document id of the parent whose descendants will populate the view

Parameters:
parentId - the document id of the parent whose descendants will populate the view

getParentId

public java.lang.String getParentId()
Get the document id of the parent whose descendants will populate the view

Returns:
the document id of the parent whose descendants will populate the view

setSortColumn

public void setSortColumn(java.lang.String sortColumn)
Set a column that can be used to sort the View Data

Parameters:
sortColumn - a column that can be used to sort the View Data

getSortColumn

public java.lang.String getSortColumn()
Return a column that can be used to sort the View Data

Returns:
a column that can be used to sort the View Data

setSortOrder

public void setSortOrder(java.lang.String sortOrder)
Set the order by which data in the sort colunm is collated (ascending, descending, toggle)

Parameters:
sortOrder - the order by which data in the sort colunm is collated (ascending, descending, toggle)

getSortOrder

public java.lang.String getSortOrder()
Return the order by which data in the sort column is collated (ascending, descending, toggle)

Returns:
the order by which data in the sort column is collated (ascending, descending, toggle)

setKeys

public void setKeys(java.lang.Object keys)
Set the key used to filter the content of a view based on column values

Parameters:
keys - the key used to filter the content of a view based on column values

getKeys

public java.lang.Object getKeys()
Return the key used to filter the content of a view based on column values

Returns:
the key used to filter the content of a view based on column values

setKeysExactMatch

public void setKeysExactMatch(boolean keysExactMatch)
Set whether exact matching is applied to the filter keys

Parameters:
keysExactMatch - true if exact matching is applied to the filter keys

isKeysExactMatch

public boolean isKeysExactMatch()
Return whether exact matching is applied to the filter keys

Returns:
true if exact matching is applied to the filter keys

setStartKeys

public void setStartKeys(java.lang.Object startKeys)
Set the key used to define the first row for a view

Parameters:
startKeys - the key used to define the first row for a view

getStartKeys

public java.lang.Object getStartKeys()
Return the key used to define the first row for a view

Returns:
the key used to define the first row for a view

setDataCache

public void setDataCache(java.lang.String dataCache)
Set how data is cached between requests (full, id, nodata)

Parameters:
dataCache - full, id, nodata

getDataCache

public java.lang.String getDataCache()
Return how data is cached between requests (full, id, nodata)

Returns:
(full, id, nodata)

setExpandLevel

public void setExpandLevel(int expandLevel)
Set the level of expansion for entries in a hierarchical View

Parameters:
expandLevel - the level of expansion for entries in a hierarchical View

getExpandLevel

public int getExpandLevel()
Return the level of expansion for entries in a hierarchical View

Returns:
the level of expansion for entries in a hierarchical View

setSearchList

public void setSearchList(java.lang.Object searchList)
Set an object containing a lists of search terms used to build a multi-word full text query

Parameters:
searchList - the collections object used to full text search the content of an indexed view

getSearchList

public java.lang.Object getSearchList()
Return the object containing the terms used to full text search the content of an indexed view

Returns:
the object containing the terms used to full text search the content of an indexed view

setSearchExactMatch

public void setSearchExactMatch(boolean searchExactMatch)
Set whether exact matching is applied to the full text search operation

Parameters:
searchExactMatch - true if exact matching is applied to full text query results

isSearchExactMatch

public boolean isSearchExactMatch()
Return whether exact matching is applied to the filter keys

Returns:
true if exact matching is applied to the filter keys

setSearchVariants

public void setSearchVariants(boolean searchVariants)
Set whether word variations are to be includes in the result set

Parameters:
searchVariants - true if variants are to be included in the full text query results

isSearchVariants

public boolean isSearchVariants()
Return whether word variations are included in the full text query result

Returns:
true if word variations are included in the full text query result

setSearchFuzzy

public void setSearchFuzzy(boolean searchFuzzy)
Set whether fuzzy searching is allowed e.g. include misspelled words in the the full text query results

Parameters:
setSearchFuzzy - true if fuzzy searching is to be performed, e.g. include misspelled words in the full text query results

isSearchFuzzy

public boolean isSearchFuzzy()
Return whether fuzzy searching is allowed e.g. include misspelled words in the the full text query results

Returns:
true if fuzzy searching is allowed e.g. include misspelled words in the the full text query results

saveState

public java.lang.Object saveState(javax.faces.context.FacesContext context)
Specified by:
saveState in interface javax.faces.component.StateHolder
Overrides:
saveState in class AbstractViewDataSource

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 AbstractViewDataSource