com.xpn.xwiki.plugin.lucene
Class IndexFields

java.lang.Object
  com.xpn.xwiki.plugin.lucene.IndexFields

public abstract class IndexFields
extends java.lang.Object

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

Version:

$Id: IndexFields.java 29723 2010-06-24 16:45:59Z tmortagne $

Field Summary

static java.lang.String	DATE_FORMAT Format for date storage in the index, and therefore the format which has to be used for date-queries.
static java.lang.String	DOCUMENT_AUTHOR Last modifier
static java.lang.String	DOCUMENT_CREATIONDATE Date of creation
static java.lang.String	DOCUMENT_CREATOR Creator of the document
static java.lang.String	DOCUMENT_DATE Date of last modification
static java.lang.String	DOCUMENT_FULLNAME FullName of the document (example : Main.WebHome)
static java.lang.String	DOCUMENT_ID Keyword field, holds a string uniquely identifying a document across the index.
static java.lang.String	DOCUMENT_LANGUAGE Language of the document
static java.lang.String	DOCUMENT_NAME Name of the document
static java.lang.String	DOCUMENT_SPACE Name of the space the document belongs to
static java.lang.String	DOCUMENT_TITLE Title of the document
static java.lang.String	DOCUMENT_TYPE Type of a document, "attachment", "wikipage" or "objects", used to control presentation of searchresults.
static java.lang.String	DOCUMENT_WEB Deprecated.
static java.lang.String	DOCUMENT_WIKI Keyword field, holds the name of the virtual wiki a document belongs to
static java.lang.String	FILENAME Filename, only used for attachments
static java.lang.String	FULLTEXT Fulltext content, not stored (and can therefore not be restored from the index).
static java.lang.String	KEYWORDS not in use
static java.lang.String	OBJECT XWiki object type, only used for objects

Method Summary

static java.lang.String	dateToString(java.util.Date date)
static java.util.Date	stringToDate(java.lang.String dateValue)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DOCUMENT_ID

public static final java.lang.String DOCUMENT_ID

Keyword field, holds a string uniquely identifying a document across the index. this is used for finding old versions of a document to be indexed.

See Also:

Constant Field Values

DOCUMENT_WIKI

public static final java.lang.String DOCUMENT_WIKI

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

See Also:

Constant Field Values

DOCUMENT_TITLE

public static final java.lang.String DOCUMENT_TITLE

Title of the document

See Also:

Constant Field Values

DOCUMENT_NAME

public static final java.lang.String DOCUMENT_NAME

Name of the document

See Also:

Constant Field Values

DOCUMENT_WEB

@Deprecated
public static final java.lang.String DOCUMENT_WEB

Deprecated.

Name of the web the document belongs to

See Also:

Constant Field Values

DOCUMENT_SPACE

public static final java.lang.String DOCUMENT_SPACE

Name of the space the document belongs to

See Also:

Constant Field Values

DOCUMENT_FULLNAME

public static final java.lang.String DOCUMENT_FULLNAME

FullName of the document (example : Main.WebHome)

See Also:

Constant Field Values

DOCUMENT_LANGUAGE

public static final java.lang.String DOCUMENT_LANGUAGE

Language of the document

See Also:

Constant Field Values

DOCUMENT_TYPE

public static final java.lang.String DOCUMENT_TYPE

Type of a document, "attachment", "wikipage" or "objects", used to control presentation of searchresults. See SearchResultand xdocs/searchResult.vm.

See Also:

Constant Field Values

FILENAME

public static final java.lang.String FILENAME

Filename, only used for attachments

See Also:

Constant Field Values

OBJECT

public static final java.lang.String OBJECT

XWiki object type, only used for objects

See Also:

Constant Field Values

DOCUMENT_AUTHOR

public static final java.lang.String DOCUMENT_AUTHOR

Last modifier

See Also:

Constant Field Values

DOCUMENT_CREATOR

public static final java.lang.String DOCUMENT_CREATOR

Creator of the document

See Also:

Constant Field Values

DOCUMENT_DATE

public static final java.lang.String DOCUMENT_DATE

Date of last modification

See Also:

Constant Field Values

DOCUMENT_CREATIONDATE

public static final java.lang.String DOCUMENT_CREATIONDATE

Date of creation

See Also:

Constant Field Values

FULLTEXT

public static final java.lang.String FULLTEXT

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

See Also:

Constant Field Values

KEYWORDS

public static final java.lang.String KEYWORDS

not in use

See Also:

Constant Field Values

DATE_FORMAT

public static final java.lang.String DATE_FORMAT

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

See Also:

Constant Field Values

Method Detail

dateToString

public static final java.lang.String dateToString(java.util.Date date)

stringToDate

public static final java.util.Date stringToDate(java.lang.String dateValue)