A C D G H I M P Q R S

A

AbstractQZarchServlet - class com.toalango.qzarch.servlet.AbstractQZarchServlet.
This is an abstract servlet that can be subclassed by presentation specific servlet implementations.
AbstractQZarchServlet() - Constructor for class com.toalango.qzarch.servlet.AbstractQZarchServlet
 
addExcludeBase(String) - Method in class com.toalango.qzarch.SearchEngineConfig
Add an exclude base directory for the searches.
addSearchBase(String) - Method in class com.toalango.qzarch.SearchEngineConfig
Add a base directory for the searches.
ATTRIBUTE_RESOURCES - Static variable in class com.toalango.qzarch.servlet.QZarchJSPServlet
 

C

com.toalango.qzarch - package com.toalango.qzarch
 
com.toalango.qzarch.servlet - package com.toalango.qzarch.servlet
 
ConfigException - exception com.toalango.qzarch.ConfigException.
This exception is thrown if the init parameters provided to configure the search engine are not set correctly.
ConfigException() - Constructor for class com.toalango.qzarch.ConfigException
 
ConfigException(String) - Constructor for class com.toalango.qzarch.ConfigException
 

D

debug(String) - Method in class com.toalango.qzarch.servlet.AbstractQZarchServlet
Help method to print debug statements during development mode.
DEFAULT_DIRECTORY_LARGE_ICONS - Static variable in class com.toalango.qzarch.SearchEngineConfig
 
DEFAULT_DIRECTORY_SMALL_ICONS - Static variable in class com.toalango.qzarch.SearchEngineConfig
 
DEFAULT_ICON - Static variable in class com.toalango.qzarch.SearchEngineConfig
The file name of the default icons
doGet(HttpServletRequest, HttpServletResponse) - Method in class com.toalango.qzarch.servlet.AbstractQZarchServlet
Process the request
doPost(HttpServletRequest, HttpServletResponse) - Method in class com.toalango.qzarch.servlet.AbstractQZarchServlet
Process the request

G

getExcludeBases() - Method in class com.toalango.qzarch.SearchEngineConfig
Getter method for the base directories for the searches.
getFileTypes() - Method in class com.toalango.qzarch.SearchEngineConfig
Getter method for the file types that this instance of the serarch engine is configured to use by default if the calling client doesn't pass on this argument in the calls.
getLargeIcon() - Method in class com.toalango.qzarch.Resource
 
getLargeIcons() - Method in class com.toalango.qzarch.SearchEngineConfig
 
getLastModified() - Method in class com.toalango.qzarch.Resource
The last modified timestamp of the file formatted as yyyy-MM-dd.
getMountedRootDirectory() - Method in class com.toalango.qzarch.SearchEngineConfig
Getter method for the directory mounted as the document root.
getName() - Method in class com.toalango.qzarch.Resource
Getter method for the file name.
getPath() - Method in class com.toalango.qzarch.Resource
The path to the resource in the web app it is deployed in.
getResourcePath(File) - Method in class com.toalango.qzarch.SearchEngineConfig
This method maps the physical file name to the resource path required by the web server.
getRootRelativeToServlet() - Method in class com.toalango.qzarch.SearchEngineConfig
Returns the relative path from the virtual directory of the search servlet to the mounted root without a trailing slash.
getSearchBases() - Method in class com.toalango.qzarch.SearchEngineConfig
Getter method for the base directories for the searches.
getSearchEngineConfig() - Method in class com.toalango.qzarch.SearchEngine
 
getSize() - Method in class com.toalango.qzarch.Resource
Nicely formatted size property, returning the size in megabyte or kilobyte.
getSmallIcon() - Method in class com.toalango.qzarch.Resource
 
getSmallIcons() - Method in class com.toalango.qzarch.SearchEngineConfig
 
getTitle() - Method in class com.toalango.qzarch.Resource
 
getType() - Method in class com.toalango.qzarch.Resource
Getter method for the file type (extension).

H

handleResults(HttpServletRequest, HttpServletResponse, Resource[], String) - Method in class com.toalango.qzarch.servlet.AbstractQZarchServlet
Hand over the processing or the request to the implementing servlet in order to present the search result suing the desirable presentation technology.
handleResults(HttpServletRequest, HttpServletResponse, Resource[], String) - Method in class com.toalango.qzarch.servlet.QZarchJSPServlet
 
handleResults(HttpServletRequest, HttpServletResponse, Resource[], String) - Method in class com.toalango.qzarch.servlet.QZarchPlainHTMLServlet
 

I

INIT_CASE_SENSITIVE - Static variable in class com.toalango.qzarch.SearchEngineConfig
 
INIT_EXCLUDE_BASE - Static variable in class com.toalango.qzarch.SearchEngineConfig
 
INIT_EXCLUDE_BASES - Static variable in class com.toalango.qzarch.SearchEngineConfig
 
INIT_EXPRESSION_SUPPORT - Static variable in class com.toalango.qzarch.SearchEngineConfig
 
INIT_EXTRACT_TITLES - Static variable in class com.toalango.qzarch.SearchEngineConfig
 
INIT_FILE_TYPE - Static variable in class com.toalango.qzarch.SearchEngineConfig
 
INIT_FILE_TYPES - Static variable in class com.toalango.qzarch.SearchEngineConfig
 
INIT_ICONS - Static variable in class com.toalango.qzarch.SearchEngineConfig
 
INIT_ICONS_LARGE - Static variable in class com.toalango.qzarch.SearchEngineConfig
 
INIT_ICONS_SMALL - Static variable in class com.toalango.qzarch.SearchEngineConfig
 
INIT_MOUNTED_ROOT - Static variable in class com.toalango.qzarch.SearchEngineConfig
The mounted-root is the complete path to the document root directory.
INIT_RELATIVE_ROOT - Static variable in class com.toalango.qzarch.SearchEngineConfig
The root-relative-to-servlet is used to produce links to the documents in the result list and the icons.
INIT_SEARCH_BASE - Static variable in class com.toalango.qzarch.SearchEngineConfig
The search-base can be used if the search engine is going to be configured with one single directory as the search base.
INIT_SEARCH_BASES - Static variable in class com.toalango.qzarch.SearchEngineConfig
The search-bases can be used to configure the search engine with multiple search base directories.
init(ServletConfig) - Method in class com.toalango.qzarch.servlet.AbstractQZarchServlet
Initialise the servlet using the ServletConfig object.
isCaseSensitive() - Method in class com.toalango.qzarch.SearchEngineConfig
Will the searches be performed case-sensitive by default unless the case-sensitive argument is passed together with the search call?
isExtractingTitles() - Method in class com.toalango.qzarch.SearchEngineConfig
Getter method for the propety whether to extract titles for the known file type or not.
isSupportingExpressions() - Method in class com.toalango.qzarch.SearchEngineConfig
Getter method for the expression support property.

M

mDebug - Variable in class com.toalango.qzarch.servlet.AbstractQZarchServlet
Print debug statements to the console during execution?

P

PARAMETER_CASE_SENSITIVE - Static variable in class com.toalango.qzarch.servlet.AbstractQZarchServlet
 
PARAMETER_FILE_TYPE - Static variable in class com.toalango.qzarch.servlet.AbstractQZarchServlet
 
PARAMETER_FILE_TYPES - Static variable in class com.toalango.qzarch.servlet.AbstractQZarchServlet
 
PARAMETER_KEYWORDS - Static variable in class com.toalango.qzarch.servlet.AbstractQZarchServlet
 
PARAMETER_SUPPORT_EXPRESSIONS - Static variable in class com.toalango.qzarch.servlet.AbstractQZarchServlet
 
PARAMETER_TARGET - Static variable in class com.toalango.qzarch.servlet.AbstractQZarchServlet
 

Q

QZarchJSPServlet - class com.toalango.qzarch.servlet.QZarchJSPServlet.
This implementation puts the result set into a request attributes and dispatches the request to a JSP specified in one of the request parameters.
QZarchJSPServlet() - Constructor for class com.toalango.qzarch.servlet.QZarchJSPServlet
 
QZarchPlainHTMLServlet - class com.toalango.qzarch.servlet.QZarchPlainHTMLServlet.
 
QZarchPlainHTMLServlet() - Constructor for class com.toalango.qzarch.servlet.QZarchPlainHTMLServlet
 

R

Resource - class com.toalango.qzarch.Resource.
This class wraps the files in the search result.
Resource() - Constructor for class com.toalango.qzarch.Resource
 
run(String) - Method in class com.toalango.qzarch.SearchEngine
Apply all the default settings for the search engine and perform a search based on a particular search expression.
run(String[], String, boolean) - Method in class com.toalango.qzarch.SearchEngine
Method to call to perform a search based on particular file types, and a given setting for case sensitivity.
run(String[], String, boolean, boolean) - Method in class com.toalango.qzarch.SearchEngine
Method to call to provide the search engine with a full set of arguments to the search.
run(String, boolean) - Method in class com.toalango.qzarch.SearchEngine
Method to call to perform a search.

S

SearchEngine - class com.toalango.qzarch.SearchEngine.
This search engine can either be set up in advance with all the configurations, or the execute metods can be called with the relevant configurations as arguments, thus overriding any defaults set already.
SearchEngine() - Constructor for class com.toalango.qzarch.SearchEngine
An empty constructor for clients that want to configure the properties of the search engine themselves.
SearchEngine(SearchEngineConfig) - Constructor for class com.toalango.qzarch.SearchEngine
From the main servlet handling the searches you instantiate the SearchEngine in the overridden GenericServlet.init() method by passing SearchEngineConfig object to this constructor.
SearchEngineConfig - class com.toalango.qzarch.SearchEngineConfig.
This configuration object is passed on to the search engine as an argument to one of the constructors of the engine.
SearchEngineConfig() - Constructor for class com.toalango.qzarch.SearchEngineConfig
 
setCaseSensitive(boolean) - Method in class com.toalango.qzarch.SearchEngineConfig
Setter method for the case sensitive property
setExtractingTitles(boolean) - Method in class com.toalango.qzarch.SearchEngineConfig
Setter method for the extraction of titles from the source files in the result set.
setFile(File) - Method in class com.toalango.qzarch.Resource
 
setFileTypes(String[]) - Method in class com.toalango.qzarch.SearchEngineConfig
Setter method for the file types that this instance of the serarch engine going to use by default if the calling client doesn't pass on this argument in the calls.
setLargeIcon(String) - Method in class com.toalango.qzarch.Resource
 
setLargeIconsLocation(File) - Method in class com.toalango.qzarch.SearchEngineConfig
Setter method for the large icons directory.
setMountedRootDirectory(File) - Method in class com.toalango.qzarch.SearchEngineConfig
Setter method for the directory mounted as the document root.
setPath(String) - Method in class com.toalango.qzarch.Resource
Setter method for the resource path
setRootRelativeToServlet(String) - Method in class com.toalango.qzarch.SearchEngineConfig
 
setSearchEngineConfig(SearchEngineConfig) - Method in class com.toalango.qzarch.SearchEngine
 
setSmallIcon(String) - Method in class com.toalango.qzarch.Resource
 
setSmallIconsLocation(File) - Method in class com.toalango.qzarch.SearchEngineConfig
Setter method for the small icons directory.
setSupportingExpressions(boolean) - Method in class com.toalango.qzarch.SearchEngineConfig
Setter method for the expression support property.
setTitle(String) - Method in class com.toalango.qzarch.Resource
 
setType(String) - Method in class com.toalango.qzarch.Resource
Setter method for the file type.

A C D G H I M P Q R S