|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.commons.scaffold.util.ProcessBeanBase org.apache.commons.scaffold.sql.StorageBeanBase org.apache.commons.scaffold.sql.ScrollerBeanBase
public class ScrollerBeanBase
Base class for scrolling searches.
Field Summary | |
---|---|
Integer |
scrollFrom
The entry (or page) from which to scroll [1]. |
Fields inherited from class org.apache.commons.scaffold.sql.StorageBeanBase |
---|
commands, DELETE, DOT, INSERT, KEYS_INC, KEYS_NEXT, PARAM_SEP, PARAMS, RECYCLE, RESTORE, RETRIEVE, TABLE, UPDATE |
Fields inherited from interface org.apache.commons.scaffold.util.ProcessBean |
---|
USER_PROFILE_KEY |
Constructor Summary | |
---|---|
ScrollerBeanBase()
|
Method Summary | |
---|---|
String |
commandKey()
Returns the String to use to retrieve the appropriate query for this search. |
String |
countKey()
Returns the String to use to retrieve the appropriate query to count the entries matching this search. |
int |
entryCount()
The total number of entries in search list. |
boolean |
failsOnEmpty()
Whether to branch to "failure" if list returns zero entries. |
Integer |
getScrollFrom()
The relative position of the first entry in this set. |
boolean |
hasParameter()
Returns whether this search takes a parameter (eg primary key) [false]. |
boolean |
isLike()
Returns whether this search uses the LIKE operator so that other methods know to wrap searchValue in a call to
like [false]. |
void |
listLegend(ResultList list)
Setup the legend for the result list. |
Scroller |
newScroller(int entries)
Return new scroller using the current starting point (getScrollFrom), the default limit (set.SCROLL_ROWS), and current count from Access (countCurrent). |
Collection |
result(Object target,
Object parameter)
Returns the collection representing the result of the Search [null]. |
Object[] |
scrollerParams(String parameter)
Return the array of parameters needed to select the entries for this set. |
ProcessResult |
scrollerSearch()
Invoke business logic; return result. |
Integer |
scrollOffset()
The number of entries before the first entry in the set (One less than scrollFrom) [0]. |
int |
scrollRows()
The number of entries to return [Scroller.SCROLL_ROWS]. |
String |
searchLabel()
Returns a label to the property being searched. |
String |
searchProperty()
Returns the name of the property being matched with the searchValue . |
Object |
searchValue()
Returns the value used in the search [null]. |
void |
setScrollFrom(Integer scrollFrom)
|
String |
tokenEmptyDispatch()
Returns the dispatch token for an empty result [Tokens.FAILURE]. |
String |
tokenEmptyMessage()
Returns the message token for an empty result [Tokens.DATA_ACCESS_EMPTY]. |
Methods inherited from class org.apache.commons.scaffold.sql.StorageBeanBase |
---|
allocateKey, blank, blank, blankValue, collection, collectionResult, count, count, createKey, delete, delete, element, elementResult, executeUpdate, executeUpdateRoot, findByProperty, findCollection, findCollection, findCollection, findCollection, findElement, fixModified, getMarked, getModified, getParameters, getParamList, getPrefix, getResult, getResultCode, getStorageKey, init, isCurrent, isNew, like, lookup, lookupRoot, populate, recycle, recycle, restore, restore, retrieve, retrieve, setMarked, setModified, setParameters, setParamList, setPrefix, setResult, setResultCode, setStorageKey, store, store, update, updateResultCode |
Methods inherited from class org.apache.commons.scaffold.util.ProcessBeanBase |
---|
execute, execute, getLocale, getParameter, getRemoteAddr, getRemoteNode, getRemoteServer, setLocale, setParameter, setRemoteAddr, setRemoteNode, setRemoteServer |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.apache.commons.scaffold.util.ProcessBean |
---|
execute, execute, getLocale, getParameter, getRemoteNode, getRemoteServer, setLocale, setParameter, setRemoteNode, setRemoteServer |
Field Detail |
---|
public Integer scrollFrom
Constructor Detail |
---|
public ScrollerBeanBase()
Method Detail |
---|
public Integer getScrollFrom()
ScrollerBean
getScrollFrom
in interface ScrollerBean
public void setScrollFrom(Integer scrollFrom)
setScrollFrom
in interface ScrollerBean
public Integer scrollOffset()
ScrollerBean
scrollOffset
in interface ScrollerBean
public int scrollRows()
ScrollerBean
scrollRows
in interface ScrollerBean
public String countKey()
ScrollerBean
countKey
in interface ScrollerBean
public boolean hasParameter()
ScrollerBean
getParameter
to return the
required parameter.
hasParameter
in interface ScrollerBean
public Object searchValue()
ScrollerBean
searchValue
in interface ScrollerBean
public boolean isLike()
ScrollerBean
searchValue
in a call to
like
[false].
isLike
in interface ScrollerBean
public int entryCount() throws ResourceException
ScrollerBean
entryCount
in interface ScrollerBean
ResourceException
public String commandKey()
ScrollerBean
commandKey
in interface ScrollerBean
public String searchProperty()
ScrollerBean
searchValue
.
Default method returns null.
Must be overridden or provide functionality.
searchProperty
in interface ScrollerBean
public String searchLabel()
ScrollerBean
searchProperty
.
Must be overridden or provide functionality.
searchLabel
in interface ScrollerBean
public boolean failsOnEmpty()
ScrollerBean
failsOnEmpty
in interface ScrollerBean
public String tokenEmptyMessage()
ScrollerBean
tokenEmptyMessage
in interface ScrollerBean
public String tokenEmptyDispatch()
ScrollerBean
tokenEmptyDispatch
in interface ScrollerBean
public Object[] scrollerParams(String parameter)
ScrollerBean
scrollerParams
in interface ScrollerBean
parameter
- The additional parameter needed to select
this set, if any.public Collection result(Object target, Object parameter) throws ResourceException
ScrollerBean
isParameter
is false.
result
in interface ScrollerBean
target
- Bean to use for entriesparameter
- Value to use to match entries
ResourceException
public Scroller newScroller(int entries) throws ResourceException
ScrollerBean
newScroller
in interface ScrollerBean
ResourceException
- on data access errorpublic void listLegend(ResultList list)
ScrollerBean
searchLabel
and searchValue
(if any).
listLegend
in interface ScrollerBean
public ProcessResult scrollerSearch() throws Exception
ScrollerBean
scrollerSearch
in interface ScrollerBean
Exception
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |