Package
Class
Use
Tree
Deprecated
Index
Help
PREV NEXT
FRAMES
NO FRAMES
All Classes
A
B
C
D
E
F
G
H
I
J
L
M
N
P
R
S
T
A
addExtension(String)
- Method in class net.grcomputing.opencms.search.lucene.
ExtensionMapping
Adds an extension.
ATTR_ENABLED
- Static variable in interface net.grcomputing.opencms.search.lucene.
I_XmlConfigConstants
enabled attribute
ATTR_LOCATION
- Static variable in interface net.grcomputing.opencms.search.lucene.
I_XmlConfigConstants
location attribute.
ATTR_NAME
- Static variable in interface net.grcomputing.opencms.search.lucene.
I_XmlConfigConstants
name attribute
B
BodylessDocument
- class net.grcomputing.opencms.search.lucene.
BodylessDocument
.
BodylessDocument()
- Constructor for class net.grcomputing.opencms.search.lucene.
BodylessDocument
C
CronIndexManager
- class net.grcomputing.opencms.search.lucene.
CronIndexManager
.
Handles the cron updates to the Lucene index.
CronIndexManager()
- Constructor for class net.grcomputing.opencms.search.lucene.
CronIndexManager
D
Document(CmsObject, CmsFile)
- Method in class net.grcomputing.opencms.search.lucene.
BodylessDocument
Takes an instance of some type and builds a Lucene Document suitable for index generation.
Document(CmsObject, CmsFile)
- Method in interface net.grcomputing.opencms.search.lucene.
I_DocumentFactory
Takes a CmsFile instance and builds a Lucene Document suitable for index generation.
Document(CmsObject, CmsFile)
- Method in class net.grcomputing.opencms.search.lucene.
PageDocument
Takes a Page instance and builds a Lucene Document suitable for index generation.
Document(CmsObject, CmsFile)
- Method in class net.grcomputing.opencms.search.lucene.
JspDocument
Right now, this is just a convenience function that calls BodylessDocument.
Document(CmsObject, CmsFile)
- Method in class net.grcomputing.opencms.search.lucene.
TaggedPlainDocument
Takes a tagged Plain instance and builds a Lucene Document suitable for index generation.
Document(CmsObject, CmsFile)
- Method in class net.grcomputing.opencms.search.lucene.
PlainDocument
Takes a Plain instance and builds a Lucene Document suitable for index generation.
Document(CmsObject, CmsFile, HashMap)
- Method in class net.grcomputing.opencms.search.lucene.
BodylessDocument
Takes an instance of some type and builds a Lucene Document suitable for index generation.
Document(CmsObject, CmsFile, HashMap)
- Method in interface net.grcomputing.opencms.search.lucene.
I_DocumentFactory
Takes a CmsFile instance and builds a Lucene Document suitable for index generation.
Document(CmsObject, CmsFile, HashMap)
- Method in class net.grcomputing.opencms.search.lucene.
PageDocument
Takes a Page instance and builds a Lucene Document suitable for index generation.
Document(CmsObject, CmsFile, HashMap)
- Method in class net.grcomputing.opencms.search.lucene.
JspDocument
Right now, this is just a convenience function that calls BodylessDocument.
Document(CmsObject, CmsFile, HashMap)
- Method in class net.grcomputing.opencms.search.lucene.
TaggedPlainDocument
Takes a Plain instance of tagged content and builds a Lucene Document suitable for index generation.
Document(CmsObject, CmsFile, HashMap)
- Method in class net.grcomputing.opencms.search.lucene.
PlainDocument
Takes a Plain instance and builds a Lucene Document suitable for index generation.
doIndex(boolean)
- Method in class net.grcomputing.opencms.search.lucene.
IndexManager
Runs an IndexWriter over the appropriate files.
doSimpleSearch(String)
- Method in class net.grcomputing.opencms.search.lucene.
SearchHelper
Does a very simple search, running a StopAnalyzer against a search within bodies.
E
ELE_ANALYZER
- Static variable in interface net.grcomputing.opencms.search.lucene.
I_XmlConfigConstants
Element to determine analyzer class.
ELE_CLASS
- Static variable in interface net.grcomputing.opencms.search.lucene.
I_XmlConfigConstants
class element
ELE_DIRECTORIES
- Static variable in interface net.grcomputing.opencms.search.lucene.
I_XmlConfigConstants
directories element
ELE_DIRECTORY
- Static variable in interface net.grcomputing.opencms.search.lucene.
I_XmlConfigConstants
directory element
ELE_DOC_FACTORIES
- Static variable in interface net.grcomputing.opencms.search.lucene.
I_XmlConfigConstants
docFactory Element
ELE_EXTENSION
- Static variable in interface net.grcomputing.opencms.search.lucene.
I_XmlConfigConstants
extension element
ELE_FILE_TYPE
- Static variable in interface net.grcomputing.opencms.search.lucene.
I_XmlConfigConstants
fileType element
ELE_INDEX_DIR
- Static variable in interface net.grcomputing.opencms.search.lucene.
I_XmlConfigConstants
Element to determine where the Index is.
ELE_JSP_DOC_FACTORY
- Static variable in interface net.grcomputing.opencms.search.lucene.
I_XmlConfigConstants
jspDocFactory element
ELE_MERGE_FACTOR
- Static variable in interface net.grcomputing.opencms.search.lucene.
I_XmlConfigConstants
Element to determine merge factor.
ELE_PAGE_DOC_FACTORY
- Static variable in interface net.grcomputing.opencms.search.lucene.
I_XmlConfigConstants
ELE_PERM_CHECK
- Static variable in interface net.grcomputing.opencms.search.lucene.
I_XmlConfigConstants
Element to determine where the Index is.
ELE_PLAIN_DOC_FACTORY
- Static variable in interface net.grcomputing.opencms.search.lucene.
I_XmlConfigConstants
plainDocFactory Element
ELE_PROJECT
- Static variable in interface net.grcomputing.opencms.search.lucene.
I_XmlConfigConstants
section element
ELE_SECTION
- Static variable in interface net.grcomputing.opencms.search.lucene.
I_XmlConfigConstants
section element
ELE_SUBSEARCH
- Static variable in interface net.grcomputing.opencms.search.lucene.
I_XmlConfigConstants
Element to determine if subdirectory searches are enabled.
ELE_XML_TEMPLATE_DOC_FACTORY
- Static variable in interface net.grcomputing.opencms.search.lucene.
I_XmlConfigConstants
xmlTemplateDocFactory element
ExtensionMapping
- class net.grcomputing.opencms.search.lucene.
ExtensionMapping
.
This class maps extensions to Lucene search document factories (e.g.
ExtensionMapping(String, String)
- Constructor for class net.grcomputing.opencms.search.lucene.
ExtensionMapping
Creates a new Extension Mapping with an empty list of extensions.
F
FastTagStripper
- class net.grcomputing.opencms.search.lucene.
FastTagStripper
.
This class implements a very fast tag stripper.
FastTagStripper()
- Constructor for class net.grcomputing.opencms.search.lucene.
FastTagStripper
FIELD_BODY
- Static variable in interface net.grcomputing.opencms.search.lucene.
I_DocumentConstants
body is the body of the file .
FIELD_DESC
- Static variable in interface net.grcomputing.opencms.search.lucene.
I_DocumentConstants
description is property "description" from file
FIELD_INITIAL_ADD
- Static variable in interface net.grcomputing.opencms.search.lucene.
I_DocumentConstants
initial_add is DateAdded of CmsFile
FIELD_KEYWORDS
- Static variable in interface net.grcomputing.opencms.search.lucene.
I_DocumentConstants
keywords is "keywords" property from file.
FIELD_LAST_MOD
- Static variable in interface net.grcomputing.opencms.search.lucene.
I_DocumentConstants
last_modified is DateLastModified of CmsFile
FIELD_PATH
- Static variable in interface net.grcomputing.opencms.search.lucene.
I_DocumentConstants
abs_path is absolute VFS path.
FIELD_TITLE
- Static variable in interface net.grcomputing.opencms.search.lucene.
I_DocumentConstants
title is property "title" from file
G
getAnalyzerName()
- Method in class net.grcomputing.opencms.search.lucene.
SearchParameters
Returns the classname of the appropropriate analyzer.
getDirectories()
- Method in class net.grcomputing.opencms.search.lucene.
SearchParameters
Returns HashMap of (String dirPath, String enabled).
getDocumentFactory()
- Method in class net.grcomputing.opencms.search.lucene.
ExtensionMapping
Returns an instance of the appropriate DocumentFactory.
getDocumentFactoryName()
- Method in class net.grcomputing.opencms.search.lucene.
ExtensionMapping
Gets the class name for the document factory.
getIndexedFields()
- Method in class net.grcomputing.opencms.search.lucene.
SearchHelper
Returns a list of indexed fields.
getIndexPath()
- Method in class net.grcomputing.opencms.search.lucene.
SearchHelper
Get the path for the Lucene search index.
getIndexPath()
- Method in class net.grcomputing.opencms.search.lucene.
SearchParameters
Returns the path that Lucene should use for creating indexes.
getJspDocumentFactory()
- Method in class net.grcomputing.opencms.search.lucene.
SearchParameters
returns an instance of a jsp-specific DocumentFactory.
getLuceneSearchElement(Element)
- Method in class net.grcomputing.opencms.search.lucene.
SearchParameters
Gets the right node from the system element.
getMergeFactor()
- Method in class net.grcomputing.opencms.search.lucene.
SearchParameters
returns the mergeFactor for the indexer.
getName()
- Method in class net.grcomputing.opencms.search.lucene.
ExtensionMapping
Gets the name of this extension map.
getPageDocumentFactory()
- Method in class net.grcomputing.opencms.search.lucene.
SearchParameters
returns an instance of a page-specific DocumentFactory.
getPlainDocumentFactory(CmsFile)
- Method in class net.grcomputing.opencms.search.lucene.
SearchParameters
Using CmsFile, return the appropriate DocumentFactory.
getPlainExtensionMappings()
- Method in class net.grcomputing.opencms.search.lucene.
SearchParameters
Get the extension mappings for Plain DocumentFactories.
getProject()
- Method in class net.grcomputing.opencms.search.lucene.
SearchParameters
Returns the project that the indexer ought to index against.
getXmlTemplateDocumentFactory()
- Method in class net.grcomputing.opencms.search.lucene.
SearchParameters
returns an instance of an XMLTemplate-specific DocumentFactory.
H
handlesExtension(String)
- Method in class net.grcomputing.opencms.search.lucene.
ExtensionMapping
Returns true if this ExtensionMapping handles the given extension.
I
I_DocumentConstants
- interface net.grcomputing.opencms.search.lucene.
I_DocumentConstants
.
Constants for building Lucene Documents, Searches and Indexers.
I_DocumentFactory
- interface net.grcomputing.opencms.search.lucene.
I_DocumentFactory
.
All implementations of OpenCMS Document-building classes must implement this interface.
I_XmlConfigConstants
- interface net.grcomputing.opencms.search.lucene.
I_XmlConfigConstants
.
This interface contains String constants for the names of XML elements that are used by the Lucene Search Configuration.
INDEX_TYPE_JSP
- Static variable in class net.grcomputing.opencms.search.lucene.
IndexManager
Defines the name of what it considers to be a jsp.
INDEX_TYPE_PAGE
- Static variable in class net.grcomputing.opencms.search.lucene.
IndexManager
Defines the name of what it considers to be a page.
INDEX_TYPE_PLAIN
- Static variable in class net.grcomputing.opencms.search.lucene.
IndexManager
Defines the name of what it considers to be a plain resource.
INDEX_TYPE_XML_TEMPLATE
- Static variable in class net.grcomputing.opencms.search.lucene.
IndexManager
Defines the name of what it considers to be an XML template.
indexedFields
- Static variable in class net.grcomputing.opencms.search.lucene.
SearchHelper
Fields that get indexed.
IndexManager
- class net.grcomputing.opencms.search.lucene.
IndexManager
.
This class builds and maintains the Lucene index.
IndexManager(CmsObject)
- Constructor for class net.grcomputing.opencms.search.lucene.
IndexManager
Constructs an IndexManager from a CmsObject.
IndexManager(CmsObject, Element)
- Constructor for class net.grcomputing.opencms.search.lucene.
IndexManager
Creates an index manager with a specific registry.
IndexManager(CmsObject, String)
- Constructor for class net.grcomputing.opencms.search.lucene.
IndexManager
Creates an index manager with a specific registry.
isUsingJspDocumentFactory()
- Method in class net.grcomputing.opencms.search.lucene.
SearchParameters
Returns true if the DocumentFactory is enabled for this type.
isUsingPageDocumentFactory()
- Method in class net.grcomputing.opencms.search.lucene.
SearchParameters
Returns true if the DocumentFactory is enabled for this type.
isUsingPlainDocumentFactory()
- Method in class net.grcomputing.opencms.search.lucene.
SearchParameters
Returns true if the DocumentFactory is enabled for this type.
isUsingXmlTemplateDocumentFactory()
- Method in class net.grcomputing.opencms.search.lucene.
SearchParameters
Returns true if the DocumentFactory is enabled for this type.
isWhitespace(char)
- Static method in class net.grcomputing.opencms.search.lucene.
FastTagStripper
J
JspDocument
- class net.grcomputing.opencms.search.lucene.
JspDocument
.
This class serves as a document factory for OpenCMS resources.
JspDocument()
- Constructor for class net.grcomputing.opencms.search.lucene.
JspDocument
L
launch(CmsObject, String)
- Method in class net.grcomputing.opencms.search.lucene.
CronIndexManager
This method is executed by the cron manager.
LUCENE_SEARCH_ELEMENT
- Static variable in interface net.grcomputing.opencms.search.lucene.
I_XmlConfigConstants
Name of the top config element for Lucene Search parameters.
M
main(String[])
- Static method in class net.grcomputing.opencms.search.lucene.
FastTagStripper
N
needsSecurityCheck()
- Method in class net.grcomputing.opencms.search.lucene.
SearchParameters
Returns true if global viewing permissions should be checked before making the index.
needsSubsearch()
- Method in class net.grcomputing.opencms.search.lucene.
SearchParameters
Get the value of global subsearching.
net.grcomputing.opencms.search.lucene
- package net.grcomputing.opencms.search.lucene
P
PageDocument
- class net.grcomputing.opencms.search.lucene.
PageDocument
.
This class serves as a document factory for OpenCMS resources.
PageDocument()
- Constructor for class net.grcomputing.opencms.search.lucene.
PageDocument
PARAM_CREATE_INDEX
- Static variable in class net.grcomputing.opencms.search.lucene.
CronIndexManager
Param to control whether or not index is created.
PARAM_REGISTRY_PATH
- Static variable in class net.grcomputing.opencms.search.lucene.
CronIndexManager
THis param designates an alternate registry path.
PlainDocument
- class net.grcomputing.opencms.search.lucene.
PlainDocument
.
Handles Plain ResourceTypes, converting them into Lucene Documents.
PlainDocument()
- Constructor for class net.grcomputing.opencms.search.lucene.
PlainDocument
processDir(String, boolean, IndexWriter)
- Method in class net.grcomputing.opencms.search.lucene.
IndexManager
Do all the hard stuff.
processFile(String, IndexWriter)
- Method in class net.grcomputing.opencms.search.lucene.
IndexManager
Convenience method for processFile(CmsFile, IndexWriter).
R
readConfig()
- Method in class net.grcomputing.opencms.search.lucene.
SearchParameters
Reads the config information and stores it.
removeExtension(String)
- Method in class net.grcomputing.opencms.search.lucene.
ExtensionMapping
Removes an extension from the list of extensions.
S
SearchHelper
- class net.grcomputing.opencms.search.lucene.
SearchHelper
.
Provides convenience functions for JSPs or external classes that want to provide Lucene search capablilites.
SearchHelper(CmsJspActionElement)
- Constructor for class net.grcomputing.opencms.search.lucene.
SearchHelper
Creates new SearchHelper, getting information out of the main registry.
SearchHelper(CmsObject, Element)
- Constructor for class net.grcomputing.opencms.search.lucene.
SearchHelper
Creates new SearchHelper, using the registry provided.
SearchHelper(CmsObject, String)
- Constructor for class net.grcomputing.opencms.search.lucene.
SearchHelper
Creates new SearchHelper, using the registry provided.
SearchParameters
- class net.grcomputing.opencms.search.lucene.
SearchParameters
.
This class retrieves/sets parameters for searching.
SearchParameters(CmsObject)
- Constructor for class net.grcomputing.opencms.search.lucene.
SearchParameters
This method constructs a new SearchParameters by retrieving configuration data from the current system registry.
setName(String)
- Method in class net.grcomputing.opencms.search.lucene.
ExtensionMapping
Sets the name of this extension map.
strip(char[])
- Static method in class net.grcomputing.opencms.search.lucene.
FastTagStripper
Ruthlessly strips all tags out of a string.
T
TaggedPlainDocument
- class net.grcomputing.opencms.search.lucene.
TaggedPlainDocument
.
This class serves as a document factory for OpenCMS resources.
TaggedPlainDocument()
- Constructor for class net.grcomputing.opencms.search.lucene.
TaggedPlainDocument
A
B
C
D
E
F
G
H
I
J
L
M
N
P
R
S
T
Package
Class
Use
Tree
Deprecated
Index
Help
PREV NEXT
FRAMES
NO FRAMES
All Classes
Copyright © 2003 Matt Butcher of
Global Resources for Computing
. Reporoduction and modification of this documents are allowed as in accordance with the GPL v2. Refer to COPYING.txt for information on acceptible use