com.raritantechnologies.searchApp.browse
Interface IBrowse

All Superinterfaces:

IConfigurable

All Known Implementing Classes:

Browse, DBBrowse

public interface IBrowse

extends IConfigurable

Interface for browse sources. Browse is a list of words/terms with counts.

Developed by Raritan Technologies .

Author:

Kepler Gelotte

Method Summary

java.util.ArrayList	getCurrentPage(java.lang.String sessionID) returns the current page worth of data
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
void	initialize(org.w3c.dom.Element elem) Initializes the object from an XML tag or element.
void	initialize(java.lang.String 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 row where the hit (or missing message) line should be rendered
void	setBrowsePageSize(int size) sets the page size for rendered results
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
boolean	wasTermFound(java.lang.String sessionID) indicates whether a match was found from getFirstPage( term )

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 IConfigurable

initialize

public void initialize(java.lang.String field)

setBrowsePageSize

public void setBrowsePageSize(int size)

sets the page size for rendered results

setBrowseHitPosition

public void setBrowseHitPosition(int pos)

sets the row where the hit (or missing message) line should be rendered

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.

getFirstPage

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

getPrevPage

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

returns the previous page worth of data relative to the last

getNextPage

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

returns the next page worth of data relative to the last

getCurrentPage

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

returns the current page worth of data

wasTermFound

public boolean wasTermFound(java.lang.String sessionID)

indicates whether a match was found from getFirstPage( term )

isFirstPage

public boolean isFirstPage(java.lang.String sessionID)

Indicates whether we're on the first page or not

isLastPage

public boolean isLastPage(java.lang.String sessionID)

Indicates whether we're on the last page or not

setExcludes

public void setExcludes(java.util.List l)

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

setIncludes

public void setIncludes(java.util.List l)

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