SearchBaseDataBean

java.lang.Object
- com.ibm.commerce.beans.InputDataBeanImpl
- - com.ibm.commerce.beans.SmartDataBeanImpl
  - - com.ibm.commerce.search.beans.SearchBaseDataBean

All Implemented Interfaces:

DataBean, InputDataBean, SmartDataBean, SearchConstants, java.io.Serializable

Direct Known Subclasses:

CatalogSearchListDataBean, CategorySearchListDataBean, CatEntrySearchListDataBean
```
public abstract class SearchBaseDataBean
extends SmartDataBeanImpl
implements SearchConstants
```
This abstract class is the super class of other search databeans. Search databeans allow users to retrieve information from the database based on search criteria.
Specific information can be retrieved from the database using the appropriate search data bean classes, which extend this super class.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.ibm.commerce.base.objects.Cursor`	`aCursor` aCursor (Cursor): This is a virtual cursor to manage paging of result set in pageSize blocks.
`protected java.lang.String`	`beginIndex` beginIndex (String): The value of this variable is used identify the first result of the any page.
`protected CommandContext`	`commandContext` commandContext (CommandContext): Commerce context containing session data
`protected java.lang.String`	`compId` compId (String): This is used to retrieve search limits
`protected ComponentConfiguration`	`config`
`protected java.lang.String`	`databaseType` databaseType (String): This is a virtual cursor to manage paging of result set in pageSize blocks.
`protected java.lang.String`	`defaultPageSize`
`protected boolean`	`exceededPageSize` This variable indicates whether the pageSize set, has exceeded maxPageSize limits of ProductSearchThreshold or not.
`protected boolean`	`exceededResultSize` This variable indicates whether the total number of results has exceeded maxResultSize limits of ProductSearchThreshold or not.
`protected java.lang.String`	`maxPageSize`
`protected int`	`maxPageSizeInt`
`protected java.lang.String`	`maxResultSize`
`protected int`	`maxResultSizeInt`
`protected java.lang.String`	`pageSize` pageSize (String): The value of this variable is used identify the number of elements on each page.
`protected RuleQuery`	`q` q (RuleQuery): The search interface query object containing generated SQL
`protected java.lang.String`	`resultCount` resultCount (String): The total number of elements found in result set.
`protected java.util.Vector`	`resultSet` resultSet (Vector): The result set of the search query.

Fields inherited from class com.ibm.commerce.beans.SmartDataBeanImpl
viewCommandContext

Fields inherited from class com.ibm.commerce.beans.InputDataBeanImpl
requestProperties

Fields inherited from interface com.ibm.commerce.beans.DataBean
emptyString

Constructor Summary

Constructors
Constructor and Description

SearchBaseDataBean()
SearchDataBean constructor comment.

Constructors
Constructor and Description
`SearchBaseDataBean()` SearchDataBean constructor comment.

Method Summary

Methods
Modifier and Type	Method and Description
`protected abstract void`	`execute()` Build complete query and retrieve result set
`protected boolean`	`getAcceleratorFlag()` This method indicates whether the search beans are accessed through catalog sections of Accelerator or not.
`java.lang.String`	`getBeginIndex()` Returns beginIndex of type String
`int`	`getCurrentPageNumber()` Returns the current page number in the result set (based on page size -- if page size is zero or null, this function returns 1)
`int`	`getEndIndex()` Returns the end index for the result set on the page.
`boolean`	`getExceededPageSize()` This method indicates whether the pageSize set has exceeded maxPageSize limits of ProductSearchThreshold or not.
`java.util.Locale`	`getLocale()` gets the locale used in the data bean.
`protected int`	`getNumericOperator(java.lang.String opKey)` The input search criteria operators are of type String.
`java.lang.String`	`getPageSize()` Return pageSize of type String
`java.lang.String`	`getResultCount()` Returns `resultCount`.
`int`	`getResultSetSize()` Gets the size of the result set list
`protected int`	`getStringOperator(java.lang.String opKey)` Converts Operators (`LIKE,EQUAL,NOTLIKE`) to search interface integer constant
`int`	`getTotalNumberOfResultSetPages()` Returns the total number of pages in the result set (based on page size -- if page size is zero or null, this function returns 1)
`protected void`	`initialize()` Defines cursor begin index and page size
`protected boolean`	`isEmpty(java.lang.String str)` Checks if a string is null or blank space.
`boolean`	`isNextPageExists()` Determines whether a next page of data exists
`boolean`	`isPreviousPageExists()` Determines whether a previous page of data exists
`boolean`	`isResultSetEmpty()` Determines whether the result set is empty
`abstract void`	`populate()` Populate the data bean.
`void`	`setAcceleratorFlag(boolean newAcceleratorFlag)` To set `acceleratorFlag`.
`void`	`setBeginIndex(java.lang.String newBeginIndex)` The beginIndex identifies the first element result of any page from total number of elements in result set.
`void`	`setExceededPageSize(boolean newExceededPageSize)` To set `exceededPageSize`.
`void`	`setLocale(java.util.Locale locale)` sets the locale used in the data bean.
`void`	`setPageSize(java.lang.String newPageSize)` To set pageSize defines the number elements in each page
`protected abstract void`	`setPredefinedAttributes()` Processes data bean variables from request object
`void`	`setResultCount(java.lang.String newResultCount)` The resultCount is the total number of elements in result set

Methods inherited from class com.ibm.commerce.beans.SmartDataBeanImpl
fulfills, getCommandContext, getHttpRequest, getHttpResponse, getResources, getViewCommandContext, setCommandContext, setHttpRequest, setHttpResponse, setViewCommandContext

Methods inherited from class com.ibm.commerce.beans.InputDataBeanImpl
getRequestProperties, setRequestProperties

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.ibm.commerce.beans.InputDataBean
getRequestProperties, setRequestProperties

- Field Detail
  - beginIndex
```
protected java.lang.String beginIndex
```
    beginIndex (String): The value of this variable is used identify the first result of the any page.
  - pageSize
```
protected java.lang.String pageSize
```
    pageSize (String): The value of this variable is used identify the number of elements on each page.
  - aCursor
```
protected com.ibm.commerce.base.objects.Cursor aCursor
```
    aCursor (Cursor): This is a virtual cursor to manage paging of result set in pageSize blocks.
  - databaseType
```
protected java.lang.String databaseType
```
    databaseType (String): This is a virtual cursor to manage paging of result set in pageSize blocks.
  - resultCount
```
protected java.lang.String resultCount
```
    resultCount (String): The total number of elements found in result set.
  - exceededResultSize
```
protected boolean exceededResultSize
```
    This variable indicates whether the total number of results has exceeded maxResultSize limits of ProductSearchThreshold or not.
  - exceededPageSize
```
protected boolean exceededPageSize
```
    This variable indicates whether the pageSize set, has exceeded maxPageSize limits of ProductSearchThreshold or not.
  - q
```
protected RuleQuery q
```
    q (RuleQuery): The search interface query object containing generated SQL
  - commandContext
```
protected CommandContext commandContext
```
    commandContext (CommandContext): Commerce context containing session data
  - resultSet
```
protected java.util.Vector resultSet
```
    resultSet (Vector): The result set of the search query.
  - compId
```
protected java.lang.String compId
```
    compId (String): This is used to retrieve search limits
  - config
```
protected ComponentConfiguration config
```
  - defaultPageSize
```
protected java.lang.String defaultPageSize
```
  - maxPageSize
```
protected java.lang.String maxPageSize
```
  - maxResultSize
```
protected java.lang.String maxResultSize
```
  - maxPageSizeInt
```
protected int maxPageSizeInt
```
  - maxResultSizeInt
```
protected int maxResultSizeInt
```
- Constructor Detail
  - SearchBaseDataBean
```
public SearchBaseDataBean()
```
    SearchDataBean constructor comment.
- Method Detail
  - execute
```
protected abstract void execute()
                         throws java.lang.Exception
```
    Build complete query and retrieve result set
    
    Throws:
    
    java.lang.Exception
  - getBeginIndex
```
public java.lang.String getBeginIndex()
```
    Returns beginIndex of type String
    
    Returns:
    
    The starting index for a page
  - getNumericOperator
```
protected int getNumericOperator(java.lang.String opKey)
```
    The input search criteria operators are of type String. This method converts numeric input operators ( =, >, >=, <=,<) of type String to an equivalent integer constant defined in search interface class RuleQuery.
    
    Parameters:
    
    opKey - The input search criteria operator (numeric operator) of type String value.
    
    Returns:
    
    The integer value of a numeric operator defined in RuleQuery.
  - getPageSize
```
public java.lang.String getPageSize()
```
    Return pageSize of type String
    
    Returns:
    
    The number of search result records to be displayed in a page.
  - getAcceleratorFlag
```
protected boolean getAcceleratorFlag()
```
    This method indicates whether the search beans are accessed through catalog sections of Accelerator or not.
    
    Returns:
    
    true if accessed false otherwise.
  - getResultCount
```
public java.lang.String getResultCount()
```
    Returns resultCount. resultCount (String) : This variable will contain total number of results returned for a search.
    
    Returns:
    
    The number of rows retrieved for this search criteria.
  - getExceededPageSize
```
public boolean getExceededPageSize()
```
    This method indicates whether the pageSize set has exceeded maxPageSize limits of ProductSearchThreshold or not.
    
    Returns:
    
    true if limits exceeded false otherwise.
  - getStringOperator
```
protected int getStringOperator(java.lang.String opKey)
```
    Converts Operators (LIKE,EQUAL,NOTLIKE) to search interface integer constant
    
    Parameters:
    
    opKey - The search interface constant for operators Like, Equal and Not Equal.
    
    Returns:
  - initialize
```
protected void initialize()
                   throws java.lang.Exception
```
    Defines cursor begin index and page size
    
    Throws:
    
    java.lang.Exception
  - isEmpty
```
protected boolean isEmpty(java.lang.String str)
```
    Checks if a string is null or blank space.
    
    Parameters:
    
    str - Input string that is to be checked for null or blank space.
    
    Returns:
    
    false if null or space, true otherwise.
  - populate
```
public abstract void populate()
                       throws java.lang.Exception
```
    Populate the data bean.
    
    Specified by:
    
    populate in interface SmartDataBean
    
    Overrides:
    
    populate in class SmartDataBeanImpl
    
    Throws:
    
    java.lang.Exception - This method should never be thrown because there is no data retrieved to populate the data bean.
  - setBeginIndex
```
public void setBeginIndex(java.lang.String newBeginIndex)
```
    The beginIndex identifies the first element result of any page from total number of elements in result set.
    
    Parameters:
    
    newBeginIndex - int. The first element result of any page from total number of elements in result set.
  - setPageSize
```
public void setPageSize(java.lang.String newPageSize)
```
    To set pageSize defines the number elements in each page
    
    Parameters:
    
    newPageSize - int. The number of elements in each page.
  - setAcceleratorFlag
```
public void setAcceleratorFlag(boolean newAcceleratorFlag)
```
    To set acceleratorFlag.
    
    Parameters:
    
    newAcceleratorFlag - boolean. Used for IBM Internal Use Only
  - setPredefinedAttributes
```
protected abstract void setPredefinedAttributes()
                                         throws java.lang.Exception
```
    Processes data bean variables from request object
    
    Throws:
    
    java.lang.Exception
  - setResultCount
```
public void setResultCount(java.lang.String newResultCount)
```
    The resultCount is the total number of elements in result set
    
    Parameters:
    
    newResultCount - java.lang.String. The total number of elements in the result set.
  - setExceededPageSize
```
public void setExceededPageSize(boolean newExceededPageSize)
```
    To set exceededPageSize.
    
    Parameters:
    
    newExceededPageSize - boolean. The exceeded flag.
  - getResultSetSize
```
public int getResultSetSize()
```
    Gets the size of the result set list
    
    Returns:
    
    the size
  - isResultSetEmpty
```
public boolean isResultSetEmpty()
```
    Determines whether the result set is empty
    
    Returns:
    
    true if the result set is empty
  - isPreviousPageExists
```
public boolean isPreviousPageExists()
```
    Determines whether a previous page of data exists
    
    Returns:
    
    true if there is a previous page, false otherwise
  - isNextPageExists
```
public boolean isNextPageExists()
```
    Determines whether a next page of data exists
    
    Returns:
    
    true if there is a next page, false otherwise
  - getEndIndex
```
public int getEndIndex()
```
    Returns the end index for the result set on the page. The end index identifies the last element result of any page from total number of elements in result set.
    
    Returns:
    
    the end index
  - getTotalNumberOfResultSetPages
```
public int getTotalNumberOfResultSetPages()
```
    Returns the total number of pages in the result set (based on page size -- if page size is zero or null, this function returns 1)
    
    Returns:
    
    the total number of pages in the result set
  - getCurrentPageNumber
```
public int getCurrentPageNumber()
```
    Returns the current page number in the result set (based on page size -- if page size is zero or null, this function returns 1)
    
    Returns:
    
    the current page number in the result set
  - getLocale
```
public java.util.Locale getLocale()
```
    gets the locale used in the data bean.
    
    Returns:
    
    the locale used in the data bean.
  - setLocale
```
public void setLocale(java.util.Locale locale)
```
    sets the locale used in the data bean.
    
    Parameters:
    
    locale - the locale.

Class SearchBaseDataBean

Field Summary

Fields inherited from class com.ibm.commerce.beans.SmartDataBeanImpl

Fields inherited from class com.ibm.commerce.beans.InputDataBeanImpl

Fields inherited from interface com.ibm.commerce.search.beans.SearchConstants

Fields inherited from interface com.ibm.commerce.beans.DataBean

Constructor Summary

Method Summary

Methods inherited from class com.ibm.commerce.beans.SmartDataBeanImpl

Methods inherited from class com.ibm.commerce.beans.InputDataBeanImpl

Methods inherited from class java.lang.Object

Methods inherited from interface com.ibm.commerce.beans.InputDataBean

Field Detail

beginIndex

pageSize

aCursor

databaseType

resultCount

exceededResultSize

exceededPageSize

q

commandContext

resultSet

compId

config

defaultPageSize

maxPageSize

maxResultSize

maxPageSizeInt

maxResultSizeInt

Constructor Detail

SearchBaseDataBean

Method Detail

execute

getBeginIndex

getNumericOperator

getPageSize

getAcceleratorFlag

getResultCount

getExceededPageSize

getStringOperator

initialize

isEmpty

populate

setBeginIndex

setPageSize

setAcceleratorFlag

setPredefinedAttributes

setResultCount

setExceededPageSize

getResultSetSize

isResultSetEmpty

isPreviousPageExists

isNextPageExists

getEndIndex

getTotalNumberOfResultSetPages

getCurrentPageNumber

getLocale

setLocale