com.raritantechnologies.searchApp.browse
Class DBBrowse

java.lang.Object
  com.raritantechnologies.searchApp.browse.DBBrowse

All Implemented Interfaces:

IBrowse, IConfigurable

public class DBBrowse

extends java.lang.Object

implements IBrowse

Implementation of Browse that uses an relational database to store the browse list entries.

Developed by Raritan Technologies .

Author:

Kepler Gelotte

Field Summary

static java.lang.String	dbConnectionName
java.lang.String	tableName

Constructor Summary

DBBrowse()

Method Summary

boolean	addLineToCache(int index, java.lang.String display, java.lang.String search, int count) Callback function to add a line to the cache
java.util.ArrayList	getCurrentPage(java.lang.String sessionID) returns the current page worth of data
static java.lang.String	getDbConnectionName() returns the connection string
java.util.ArrayList	getFirstPage(java.lang.String sessionID, java.lang.String term) returns a page worth of data as ArrayList of Browse.Line entries.
java.util.ArrayList	getFirstPage(java.lang.String sessionID, java.lang.String term, java.lang.String missingTemplate)
java.util.ArrayList	getNextPage(java.lang.String sessionID) returns the next page worth of data relative to the last
java.util.ArrayList	getPrevPage(java.lang.String sessionID) returns the previous page worth of data relative to the last
java.lang.String	getTableName() returns the table name (uses field name if not set )
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.
void	initialize(java.lang.String field) Use this method to create a browse instance for a single field.
boolean	isFirstPage(java.lang.String sessionID) Indicates whether we're on the first page or not
boolean	isLastPage(java.lang.String sessionID) Indicates whether we're on the last page or not
void	setBrowseHitPosition(int pos) sets the page size for rendered results
void	setBrowsePageSize(int size) sets the page size for rendered results
static void	setDbConnectionName(java.lang.String dbName) sets the connection string
void	setExcludes(java.util.List l) A list of exclusion comparator(s) to filter the browse lists
void	setIncludes(java.util.List l) A list of inclusion comparator(s) to filter the browse lists
void	setTableName(java.lang.String table) sets the table name from BrowseResultsRenderer
boolean	wasTermFound(java.lang.String sessionID) indicates whether a match was found from getFirstPage( term )

Methods inherited from class java.lang.Object

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

Field Detail

dbConnectionName

public static java.lang.String dbConnectionName

tableName

public java.lang.String tableName

Constructor Detail

DBBrowse

public DBBrowse()

Method Detail

initialize

public void initialize(org.w3c.dom.Element elem)

Description copied from interface: IConfigurable

Initializes the object from an XML tag or element. This method is called by the Framework as part of the application initializtion. see ConfigurationManager, XMLConfigurationManager, XMLSearchFieldMapFactory, XMLSearchSourceFactory. Configurable objects that are owned or contained by other configurable objects will be initialized in by the parent object.

Specified by:

initialize in interface IBrowse

initialize

public void initialize(java.lang.String field)

Use this method to create a browse instance for a single field. It will prime the static structures if they are not already in existance

Specified by:

initialize in interface IBrowse

setDbConnectionName

public static void setDbConnectionName(java.lang.String dbName)

sets the connection string

getDbConnectionName

public static java.lang.String getDbConnectionName()

returns the connection string

setTableName

public void setTableName(java.lang.String table)

sets the table name from BrowseResultsRenderer

getTableName

public java.lang.String getTableName()

returns the table name (uses field name if not set )

setBrowsePageSize

public void setBrowsePageSize(int size)

sets the page size for rendered results

Specified by:

setBrowsePageSize in interface IBrowse

setBrowseHitPosition

public void setBrowseHitPosition(int pos)

sets the page size for rendered results

Specified by:

setBrowseHitPosition in interface IBrowse

getFirstPage

public java.util.ArrayList getFirstPage(java.lang.String sessionID,
                                        java.lang.String term)

returns a page worth of data as ArrayList of Browse.Line entries.

Specified by:

getFirstPage in interface IBrowse

getFirstPage

public java.util.ArrayList getFirstPage(java.lang.String sessionID,
                                        java.lang.String term,
                                        java.lang.String missingTemplate)

Specified by:

getFirstPage in interface IBrowse

getPrevPage

public java.util.ArrayList getPrevPage(java.lang.String sessionID)

returns the previous page worth of data relative to the last

Specified by:

getPrevPage in interface IBrowse

getNextPage

public java.util.ArrayList getNextPage(java.lang.String sessionID)

returns the next page worth of data relative to the last

Specified by:

getNextPage in interface IBrowse

getCurrentPage

public java.util.ArrayList getCurrentPage(java.lang.String sessionID)

Description copied from interface: IBrowse

returns the current page worth of data

Specified by:

getCurrentPage in interface IBrowse

wasTermFound

public boolean wasTermFound(java.lang.String sessionID)

Description copied from interface: IBrowse

indicates whether a match was found from getFirstPage( term )

Specified by:

wasTermFound in interface IBrowse

addLineToCache

public boolean addLineToCache(int index,
                              java.lang.String display,
                              java.lang.String search,
                              int count)

Callback function to add a line to the cache

isFirstPage

public boolean isFirstPage(java.lang.String sessionID)

Indicates whether we're on the first page or not

Specified by:

isFirstPage in interface IBrowse

isLastPage

public boolean isLastPage(java.lang.String sessionID)

Indicates whether we're on the last page or not

Specified by:

isLastPage in interface IBrowse

setExcludes

public void setExcludes(java.util.List l)

A list of exclusion comparator(s) to filter the browse lists

Specified by:

setExcludes in interface IBrowse

setIncludes

public void setIncludes(java.util.List l)

A list of inclusion comparator(s) to filter the browse lists

Specified by:

setIncludes in interface IBrowse