A B C D F G H I K L O P Q R S T X

A

add(XWikiDocument, XWikiContext) - Method in class com.xpn.xwiki.plugin.lucene.IndexUpdater

add(XWikiDocument, XWikiAttachment, XWikiContext) - Method in class com.xpn.xwiki.plugin.lucene.IndexUpdater

add(IndexData) - Method in class com.xpn.xwiki.plugin.lucene.XWikiDocumentQueue

Adds an item to the queue.

addAttachmentsOfDocument(XWikiDocument, XWikiContext) - Method in class com.xpn.xwiki.plugin.lucene.IndexUpdater

addDataToLuceneDocument(Document, XWikiDocument, XWikiContext) - Method in class com.xpn.xwiki.plugin.lucene.AttachmentData

Adds this documents data to a lucene Document instance for indexing.

addDataToLuceneDocument(Document, XWikiDocument, XWikiContext) - Method in class com.xpn.xwiki.plugin.lucene.DocumentData

addDataToLuceneDocument(Document, XWikiDocument, XWikiContext) - Method in class com.xpn.xwiki.plugin.lucene.IndexData

Adds this documents data to a lucene Document instance for indexing.

addTranslationsOfDocument(XWikiDocument, XWikiContext) - Method in class com.xpn.xwiki.plugin.lucene.IndexRebuilder

AttachmentData - Class in com.xpn.xwiki.plugin.lucene

Holds all data but the content of an attachment to be indexed.

AttachmentData(XWikiDocument, XWikiAttachment, XWikiContext) - Constructor for class com.xpn.xwiki.plugin.lucene.AttachmentData

B

buildQuery() - Method in class com.xpn.xwiki.plugin.lucene.IndexData

Builds a Lucene query matching only the document this instance represents.

C

cleanIndex() - Method in class com.xpn.xwiki.plugin.lucene.IndexUpdater

closeSearchers(Searcher[]) - Static method in class com.xpn.xwiki.plugin.lucene.LucenePlugin

com.xpn.xwiki.plugin.lucene - package com.xpn.xwiki.plugin.lucene

createSearcher(Directory, XWikiContext) - Method in class com.xpn.xwiki.plugin.lucene.IndexRebuilder

createSearchers(String, XWikiContext) - Method in class com.xpn.xwiki.plugin.lucene.LucenePlugin

Creates an array of Searchers for a number of lucene indexes.

D

DATE_FORMAT - Static variable in class com.xpn.xwiki.plugin.lucene.IndexFields

Format for date storage in the index, and therefore the format which has to be used for date-queries.

dateToString(Date) - Static method in class com.xpn.xwiki.plugin.lucene.IndexFields

DOCTYPE_ATTACHMENT - Static variable in class com.xpn.xwiki.plugin.lucene.LucenePlugin

DOCTYPE_WIKIPAGE - Static variable in class com.xpn.xwiki.plugin.lucene.LucenePlugin

DOCUMENT_AUTHOR - Static variable in class com.xpn.xwiki.plugin.lucene.IndexFields

Last modifier

DOCUMENT_CREATIONDATE - Static variable in class com.xpn.xwiki.plugin.lucene.IndexFields

Date of creation

DOCUMENT_CREATOR - Static variable in class com.xpn.xwiki.plugin.lucene.IndexFields

Creator of the document

DOCUMENT_DATE - Static variable in class com.xpn.xwiki.plugin.lucene.IndexFields

Date of last modification

DOCUMENT_FULLNAME - Static variable in class com.xpn.xwiki.plugin.lucene.IndexFields

FullName of the document (example : Main.WebHome)

DOCUMENT_ID - Static variable in class com.xpn.xwiki.plugin.lucene.IndexFields

Keyword field, holds a string uniquely identifying a document across the index.

DOCUMENT_LANGUAGE - Static variable in class com.xpn.xwiki.plugin.lucene.IndexFields

Language of the document

DOCUMENT_NAME - Static variable in class com.xpn.xwiki.plugin.lucene.IndexFields

Name of the document

DOCUMENT_SPACE - Static variable in class com.xpn.xwiki.plugin.lucene.IndexFields

Name of the space the document belongs to

DOCUMENT_TITLE - Static variable in class com.xpn.xwiki.plugin.lucene.IndexFields

Title of the document

DOCUMENT_TYPE - Static variable in class com.xpn.xwiki.plugin.lucene.IndexFields

Type of a document, "attachment", "wikipage" or "objects", used to control presentation of searchresults.

DOCUMENT_WEB - Static variable in class com.xpn.xwiki.plugin.lucene.IndexFields

Deprecated.

DOCUMENT_WIKI - Static variable in class com.xpn.xwiki.plugin.lucene.IndexFields

Keyword field, holds the name of the virtual wiki a document belongs to

DocumentData - Class in com.xpn.xwiki.plugin.lucene

Holds all data but the content of a wiki page to be indexed.

DocumentData(XWikiDocument, XWikiContext) - Constructor for class com.xpn.xwiki.plugin.lucene.DocumentData

doExit() - Method in class com.xpn.xwiki.plugin.lucene.IndexUpdater

F

FILENAME - Static variable in class com.xpn.xwiki.plugin.lucene.IndexFields

Filename, only used for attachments

finalize() - Method in class com.xpn.xwiki.plugin.lucene.LucenePlugin

flushCache(XWikiContext) - Method in class com.xpn.xwiki.plugin.lucene.LucenePlugin

FULLTEXT - Static variable in class com.xpn.xwiki.plugin.lucene.IndexFields

Fulltext content, not stored (and can therefore not be restored from the index).

G

getAuthor() - Method in class com.xpn.xwiki.plugin.lucene.SearchResult

getCreationDate() - Method in class com.xpn.xwiki.plugin.lucene.IndexData

getCreationDate() - Method in class com.xpn.xwiki.plugin.lucene.SearchResult

getCreator() - Method in class com.xpn.xwiki.plugin.lucene.IndexData

getCreator() - Method in class com.xpn.xwiki.plugin.lucene.SearchResult

getDate() - Method in class com.xpn.xwiki.plugin.lucene.SearchResult

getDirectory() - Method in class com.xpn.xwiki.plugin.lucene.IndexUpdater

Return a reference to the directory that this updater is currently working with.

getDocumentFullName() - Method in class com.xpn.xwiki.plugin.lucene.IndexData

getDocumentName() - Method in class com.xpn.xwiki.plugin.lucene.IndexData

getDocumentSpace() - Method in class com.xpn.xwiki.plugin.lucene.IndexData

getDocumentTitle() - Method in class com.xpn.xwiki.plugin.lucene.IndexData

getDocumentWeb() - Method in class com.xpn.xwiki.plugin.lucene.IndexData

Deprecated. use IndexData.getDocumentSpace() instead

getEndIndex(String, String) - Method in class com.xpn.xwiki.plugin.lucene.SearchResults

getEvents() - Method in class com.xpn.xwiki.plugin.lucene.IndexUpdater

getFilename() - Method in class com.xpn.xwiki.plugin.lucene.AttachmentData

getFilename() - Method in class com.xpn.xwiki.plugin.lucene.SearchResult

getFullName() - Method in class com.xpn.xwiki.plugin.lucene.IndexData

getFullName() - Method in class com.xpn.xwiki.plugin.lucene.SearchResult

getFullText(StringBuilder, XWikiDocument, XWikiContext) - Method in class com.xpn.xwiki.plugin.lucene.AttachmentData

getFullText(StringBuilder, XWikiDocument, XWikiContext) - Method in class com.xpn.xwiki.plugin.lucene.DocumentData

getFullText(XWikiDocument, XWikiContext) - Method in class com.xpn.xwiki.plugin.lucene.IndexData

getFullText(StringBuilder, XWikiDocument, XWikiContext) - Method in class com.xpn.xwiki.plugin.lucene.IndexData

getHitcount() - Method in class com.xpn.xwiki.plugin.lucene.SearchResults

getId() - Method in class com.xpn.xwiki.plugin.lucene.AttachmentData

overridden to append the filename

getId() - Method in class com.xpn.xwiki.plugin.lucene.IndexData

getId() - Method in class com.xpn.xwiki.plugin.lucene.SearchResult

getIndexDirs() - Method in class com.xpn.xwiki.plugin.lucene.LucenePlugin

getLanguage() - Method in class com.xpn.xwiki.plugin.lucene.IndexData

getLanguage() - Method in class com.xpn.xwiki.plugin.lucene.SearchResult

getLuceneDocCount() - Method in class com.xpn.xwiki.plugin.lucene.IndexUpdater

getLuceneDocCount() - Method in class com.xpn.xwiki.plugin.lucene.LucenePlugin

getLuceneDocCount() - Method in class com.xpn.xwiki.plugin.lucene.LucenePluginApi

getMaxQueueSize() - Method in class com.xpn.xwiki.plugin.lucene.IndexUpdater

getName() - Method in class com.xpn.xwiki.plugin.lucene.IndexUpdater

getName() - Method in class com.xpn.xwiki.plugin.lucene.LucenePlugin

getName() - Method in class com.xpn.xwiki.plugin.lucene.SearchResult

getNextIndex(String, String) - Method in class com.xpn.xwiki.plugin.lucene.SearchResults

getObjects() - Method in class com.xpn.xwiki.plugin.lucene.SearchResult

getPluginApi(XWikiPluginInterface, XWikiContext) - Method in class com.xpn.xwiki.plugin.lucene.LucenePlugin

getPreviousIndex(String, String) - Method in class com.xpn.xwiki.plugin.lucene.SearchResults

getQueueSize() - Method in class com.xpn.xwiki.plugin.lucene.IndexUpdater

getQueueSize() - Method in class com.xpn.xwiki.plugin.lucene.LucenePlugin

getQueueSize() - Method in class com.xpn.xwiki.plugin.lucene.LucenePluginApi

getResults(String, String) - Method in class com.xpn.xwiki.plugin.lucene.SearchResults

Helper method for use in velocity templates, takes string values instead of ints.

getResults(int, int) - Method in class com.xpn.xwiki.plugin.lucene.SearchResults

Returns a list of search results.

getResults() - Method in class com.xpn.xwiki.plugin.lucene.SearchResults

getScore() - Method in class com.xpn.xwiki.plugin.lucene.SearchResult

getSearchResults(String, String, String, String, XWikiContext) - Method in class com.xpn.xwiki.plugin.lucene.LucenePlugin

Searches all Indexes configured in xwiki.cfg (property xwiki.plugins.lucene.indexdir).

getSearchResults(String, String[], String, String, XWikiContext) - Method in class com.xpn.xwiki.plugin.lucene.LucenePlugin

Searches all Indexes configured in xwiki.cfg (property xwiki.plugins.lucene.indexdir).

getSearchResults(String, String) - Method in class com.xpn.xwiki.plugin.lucene.LucenePluginApi

Searches the configured Indexes using the specified lucene query for documents in the given languages.

getSearchResults(String, String, String) - Method in class com.xpn.xwiki.plugin.lucene.LucenePluginApi

Searches the configured Indexes using the specified lucene query for documents in the given languages.

getSearchResults(String, String, String, String) - Method in class com.xpn.xwiki.plugin.lucene.LucenePluginApi

Searches the configured Indexes using the specified lucene query for documents in the given languages belonging to one of the given virtual wikis.

getSearchResults(String, String[], String) - Method in class com.xpn.xwiki.plugin.lucene.LucenePluginApi

Searches the configured Indexes using the specified lucene query for documents in the given languages.

getSearchResults(String, String[], String, String) - Method in class com.xpn.xwiki.plugin.lucene.LucenePluginApi

Searches the configured Indexes using the specified lucene query for documents in the given languages belonging to one of the given virtual wikis.

getSearchResultsFromIndexes(String, String, String, XWikiContext) - Method in class com.xpn.xwiki.plugin.lucene.LucenePlugin

Allows to search special named lucene indexes without having to configure them in xwiki.cfg.

getSearchResultsFromIndexes(String, String[], String, String, XWikiContext) - Method in class com.xpn.xwiki.plugin.lucene.LucenePlugin

Allows to search special named lucene indexes without having to configure them in xwiki.cfg.

getSearchResultsFromIndexes(String, String, String, String, XWikiContext) - Method in class com.xpn.xwiki.plugin.lucene.LucenePlugin

Allows to search special named lucene indexes without having to configure them in xwiki.cfg.

getSearchResultsFromIndexes(String, String, String) - Method in class com.xpn.xwiki.plugin.lucene.LucenePluginApi

Searches the named indexes using the given query for documents in the given languages

getSearchResultsFromIndexes(String, String, String, String) - Method in class com.xpn.xwiki.plugin.lucene.LucenePluginApi

Searches the named indexes using the given query for documents in the given languages

getSearchResultsFromIndexes(String, String[], String, String) - Method in class com.xpn.xwiki.plugin.lucene.LucenePluginApi

Searches the named indexes using the given query for documents in the given languages

getSize() - Method in class com.xpn.xwiki.plugin.lucene.AttachmentData

getSize() - Method in class com.xpn.xwiki.plugin.lucene.XWikiDocumentQueue

Returns the number of elements in the queue.

getSpace() - Method in class com.xpn.xwiki.plugin.lucene.SearchResult

getTitle() - Method in class com.xpn.xwiki.plugin.lucene.SearchResult

getTotalHitcount() - Method in class com.xpn.xwiki.plugin.lucene.SearchResults

getType() - Method in class com.xpn.xwiki.plugin.lucene.AttachmentData

getType() - Method in class com.xpn.xwiki.plugin.lucene.DocumentData

getType() - Method in class com.xpn.xwiki.plugin.lucene.IndexData

getType() - Method in class com.xpn.xwiki.plugin.lucene.SearchResult

getUrl() - Method in class com.xpn.xwiki.plugin.lucene.SearchResult

getWeb() - Method in class com.xpn.xwiki.plugin.lucene.SearchResult

Deprecated. Use SearchResult.getSpace() instead.

getWiki() - Method in class com.xpn.xwiki.plugin.lucene.IndexData

getWiki() - Method in class com.xpn.xwiki.plugin.lucene.SearchResult

H

hasNext(String, String) - Method in class com.xpn.xwiki.plugin.lucene.SearchResults

hasPrevious(String) - Method in class com.xpn.xwiki.plugin.lucene.SearchResults

I

IndexData - Class in com.xpn.xwiki.plugin.lucene

IndexData(XWikiDocument, XWikiContext) - Constructor for class com.xpn.xwiki.plugin.lucene.IndexData

IndexFields - Class in com.xpn.xwiki.plugin.lucene

Contains constants naming the Lucene index fields used by this Plugin and some helper methods for proper handling of special field values like dates.

IndexRebuilder - Class in com.xpn.xwiki.plugin.lucene

Handles rebuilding of the whole Lucene Search Index.

IndexRebuilder(IndexUpdater, XWikiContext) - Constructor for class com.xpn.xwiki.plugin.lucene.IndexRebuilder

IndexUpdater - Class in com.xpn.xwiki.plugin.lucene

indexWiki(String, XWikiContext) - Method in class com.xpn.xwiki.plugin.lucene.IndexRebuilder

Adds the content of a given wiki to the indexUpdater's queue.

init(XWikiContext) - Method in class com.xpn.xwiki.plugin.lucene.LucenePlugin

init(Directory, XWikiContext) - Method in class com.xpn.xwiki.plugin.lucene.LucenePlugin

init(IndexUpdater, XWikiContext) - Method in class com.xpn.xwiki.plugin.lucene.LucenePlugin

init(IndexUpdater, IndexRebuilder, XWikiContext) - Method in class com.xpn.xwiki.plugin.lucene.LucenePlugin

isEmpty() - Method in class com.xpn.xwiki.plugin.lucene.XWikiDocumentQueue

Check if the queue is empty or not.

isIndexed(String, String, Searcher) - Method in class com.xpn.xwiki.plugin.lucene.IndexRebuilder

isWikiContent() - Method in class com.xpn.xwiki.plugin.lucene.SearchResult

K

KEYWORDS - Static variable in class com.xpn.xwiki.plugin.lucene.IndexFields

not in use

L

LucenePlugin - Class in com.xpn.xwiki.plugin.lucene

A plugin offering support for advanced searches using Lucene, a high performance, open source search engine.

LucenePlugin(String, String, XWikiContext) - Constructor for class com.xpn.xwiki.plugin.lucene.LucenePlugin

LucenePluginApi - Class in com.xpn.xwiki.plugin.lucene

This plugin allows index based search in the contents of Wiki Pages and their attachments, as far as any text can be extracted from them.

LucenePluginApi(LucenePlugin, XWikiContext) - Constructor for class com.xpn.xwiki.plugin.lucene.LucenePluginApi

O

OBJECT - Static variable in class com.xpn.xwiki.plugin.lucene.IndexFields

XWiki object type, only used for objects

onEvent(Event, Object, Object) - Method in class com.xpn.xwiki.plugin.lucene.IndexUpdater

openSearchers(XWikiContext) - Method in class com.xpn.xwiki.plugin.lucene.LucenePlugin

Opens the searchers for the configured index Dirs after closing any already existing ones.

openWriter(boolean) - Method in class com.xpn.xwiki.plugin.lucene.IndexUpdater

P

PROP_ANALYZER - Static variable in class com.xpn.xwiki.plugin.lucene.LucenePlugin

PROP_INDEX_DIR - Static variable in class com.xpn.xwiki.plugin.lucene.LucenePlugin

PROP_INDEXING_INTERVAL - Static variable in class com.xpn.xwiki.plugin.lucene.LucenePlugin

PROP_MAX_QUEUE_SIZE - Static variable in class com.xpn.xwiki.plugin.lucene.LucenePlugin

Q

queueAttachment(XWikiDocument, XWikiAttachment, XWikiContext) - Method in class com.xpn.xwiki.plugin.lucene.LucenePlugin

queueAttachment(XWikiDocument, XWikiContext) - Method in class com.xpn.xwiki.plugin.lucene.LucenePlugin

queueDocument(XWikiDocument, XWikiContext) - Method in class com.xpn.xwiki.plugin.lucene.LucenePlugin

R

REBUILD_IN_PROGRESS - Static variable in class com.xpn.xwiki.plugin.lucene.LucenePluginApi

Return value for LucenePluginApi.rebuildIndex() meaning that another rebuild is already in progress.

REBUILD_NOT_ALLOWED - Static variable in class com.xpn.xwiki.plugin.lucene.LucenePluginApi

Return value for LucenePluginApi.rebuildIndex() meaning that the caller does not have admin rights.

rebuildIndex(XWikiContext) - Method in class com.xpn.xwiki.plugin.lucene.LucenePlugin

rebuildIndex() - Method in class com.xpn.xwiki.plugin.lucene.LucenePluginApi

Starts a rebuild of the whole index.

rebuildIndex(XWiki, Context) - Method in class com.xpn.xwiki.plugin.lucene.LucenePluginApi

Deprecated. use rebuildIndex without context values

remove() - Method in class com.xpn.xwiki.plugin.lucene.XWikiDocumentQueue

Remove an item from the queue and return it.

runInternal() - Method in class com.xpn.xwiki.plugin.lucene.IndexRebuilder

runInternal() - Method in class com.xpn.xwiki.plugin.lucene.IndexUpdater

Main loop.

S

SearchResult - Class in com.xpn.xwiki.plugin.lucene

Result of a search.

SearchResult(Document, float, XWiki) - Constructor for class com.xpn.xwiki.plugin.lucene.SearchResult

SearchResults - Class in com.xpn.xwiki.plugin.lucene

Container for the results of a search.

SearchResults(Hits, XWiki, XWikiContext) - Constructor for class com.xpn.xwiki.plugin.lucene.SearchResults

setAnalyzer(Analyzer) - Method in class com.xpn.xwiki.plugin.lucene.IndexUpdater

setAuthor(String) - Method in class com.xpn.xwiki.plugin.lucene.IndexData

setCreationDate(Date) - Method in class com.xpn.xwiki.plugin.lucene.IndexData

setCreator(String) - Method in class com.xpn.xwiki.plugin.lucene.IndexData

setDocumentFullName(String) - Method in class com.xpn.xwiki.plugin.lucene.IndexData

setDocumentName(String) - Method in class com.xpn.xwiki.plugin.lucene.IndexData

setDocumentSpace(String) - Method in class com.xpn.xwiki.plugin.lucene.IndexData

setDocumentTitle(String) - Method in class com.xpn.xwiki.plugin.lucene.IndexData

setDocumentWeb(String) - Method in class com.xpn.xwiki.plugin.lucene.IndexData

Deprecated. use IndexData.setDocumentSpace(String) instead

setFilename(String) - Method in class com.xpn.xwiki.plugin.lucene.AttachmentData

setFullName(String) - Method in class com.xpn.xwiki.plugin.lucene.IndexData

setLanguage(String) - Method in class com.xpn.xwiki.plugin.lucene.IndexData

setModificationDate(Date) - Method in class com.xpn.xwiki.plugin.lucene.IndexData

setSize(int) - Method in class com.xpn.xwiki.plugin.lucene.AttachmentData

setUrl(String) - Method in class com.xpn.xwiki.plugin.lucene.SearchResult

setWiki(String) - Method in class com.xpn.xwiki.plugin.lucene.IndexData

startIndex(Collection<String>, String, boolean, boolean, XWikiContext) - Method in class com.xpn.xwiki.plugin.lucene.IndexRebuilder

startIndex(Collection<String>, String, boolean, boolean, XWikiContext) - Method in class com.xpn.xwiki.plugin.lucene.LucenePlugin

startIndex(Collection<String>, String, boolean, boolean) - Method in class com.xpn.xwiki.plugin.lucene.LucenePluginApi

Starts a rebuild of the whole index.

startRebuildIndex(XWikiContext) - Method in class com.xpn.xwiki.plugin.lucene.IndexRebuilder

stringToDate(String) - Static method in class com.xpn.xwiki.plugin.lucene.IndexFields

T

toString() - Method in class com.xpn.xwiki.plugin.lucene.IndexData

X

XWikiDocumentQueue - Class in com.xpn.xwiki.plugin.lucene

This class represents a Queue (FirstInFirstOut) for XWikiDocument objects.

XWikiDocumentQueue() - Constructor for class com.xpn.xwiki.plugin.lucene.XWikiDocumentQueue

A B C D F G H I K L O P Q R S T X