com.raritantechnologies.searchApp.browse
Class BrowseDirectoryEntry

java.lang.Object
  extended bycom.raritantechnologies.searchApp.browse.BrowseDirectoryEntry
All Implemented Interfaces:
IBrowseDirectoryEntry

public class BrowseDirectoryEntry
extends java.lang.Object
implements IBrowseDirectoryEntry

Basic implementation of IBrowseDirectoryEntry - uses hierarchical set of files to store browse entries.


Developed by Raritan Technologies .

Author:
Kepler Gelotte

Constructor Summary
BrowseDirectoryEntry()
           
 
Method Summary
 void addPage(com.raritantechnologies.searchApp.browse.BrowseDirectoryEntry.Element browseElement)
           
 int getMaxPage()
          Get the maximum page number for the field's browse list
 int getMinPage()
          Get the minimum page number for the field's browse list
 int getPageNumber(java.lang.String term)
          this function figures out which page the search term should be in
 void initialize(org.w3c.dom.Element elem)
           
 void initialize(java.lang.String field)
          Use this method to initialize a BrowseDirectoryEntry instance for a single field.
 boolean isRefreshRequired()
          Use this method to see if the master list has been updated.
 boolean isValid()
           
 void reset()
           
 void setFieldName(java.lang.String fieldName)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BrowseDirectoryEntry

public BrowseDirectoryEntry()
Method Detail

initialize

public void initialize(org.w3c.dom.Element elem)
Specified by:
initialize in interface IBrowseDirectoryEntry

setFieldName

public void setFieldName(java.lang.String fieldName)

initialize

public void initialize(java.lang.String field)
Use this method to initialize a BrowseDirectoryEntry instance for a single field. It will load the ArrayList of pages used for the binary lookup of the correct browse page.

Specified by:
initialize in interface IBrowseDirectoryEntry

addPage

public void addPage(com.raritantechnologies.searchApp.browse.BrowseDirectoryEntry.Element browseElement)

reset

public void reset()

isRefreshRequired

public boolean isRefreshRequired()
Use this method to see if the master list has been updated.

Specified by:
isRefreshRequired in interface IBrowseDirectoryEntry

getPageNumber

public int getPageNumber(java.lang.String term)
this function figures out which page the search term should be in

Specified by:
getPageNumber in interface IBrowseDirectoryEntry

getMaxPage

public int getMaxPage()
Get the maximum page number for the field's browse list

Specified by:
getMaxPage in interface IBrowseDirectoryEntry

getMinPage

public int getMinPage()
Get the minimum page number for the field's browse list

Specified by:
getMinPage in interface IBrowseDirectoryEntry

isValid

public boolean isValid()
Specified by:
isValid in interface IBrowseDirectoryEntry