org.xwiki.search.solr.internal.api
Interface Fields


public interface Fields

Contains constants naming the Solr/Lucene index fields used by this module for indexing entities. Also contains additional constants used for composing field names on multilingual fields.

A multilingual and virtual/alias field, is not stored in the index with the specified name. It is only used at query time and it is expanded automatically to the actual fields from the index.

Example: "title" becomes "title_ml | title_en | title_ro | title_fr | etc..."

Note: When indexing a field, the actual field name must be used instead of the virtual field name.

Since:
4.3M2

Field Summary
static String ATTACHMENT_CONTENT
          Attachment content.
static String AUTHOR
          Last modifier.
static String AUTHOR_DISPLAY
          Last modifier, in its display version (i.e., "first_name last_name").
static String AUTHOR_DISPLAY_SORT
          Lowercased, unanalyzed and not stored version of the document's last author display version, used for sorting.
static String CLASS
          XWiki object class, only used for objects and properties.
static String COMMENT
          For storing the comments.
static String CREATIONDATE
          Date of creation.
static String CREATOR
          Creator of the document.
static String CREATOR_DISPLAY
          Creator of the document, in its display version (i.e., "first_name last_name").
static String DATE
          Date of last modification.
static String DOCUMENT_CONTENT
          Fulltext content, not stored (and can therefore not be restored from the index).
static String FILENAME
          Filename, only used for attachments.
static String FULLNAME
          FullName of the document (example : Main.WebHome).
static String HIDDEN
          Document hidden flag.
static String ID
          Keyword field, holds a string uniquely identifying a document across the index.
static String LANGUAGE
          Language of the document.
static String MIME_TYPE
          For storing mimetype of the attachments.
static String MULTILIGNUAL_FORMAT
          Format string for multilingual fields.
static String MULTILINGUAL
          Multilingual field suffix for the field of "text_general" type.
static String NAME
          Name of the document.
static String OBJECT_CONTENT
          XWiki object content.
static String PROPERTY_NAME
          For storing property name.
static String PROPERTY_VALUE
          For storing property value.
static String SCORE
          Document score, not an actual field.
static String SPACE
          Name of the space the document belongs to.
static String SPACE_EXACT
          Unanalyzed and not stored version of the document's space.
static String TITLE
          Title of the document.
static String TITLE_SORT
          Lowercased, unanalyzed and not stored version of the document's title, used for sorting.
static String TYPE
          Type of a document.
static String USCORE
          Underscore character, used to separate the field name from the suffix.
static String VERSION
          Version of the document.
static String WIKI
          Keyword field, holds the name of the virtual wiki a document belongs to.
 

Field Detail

ID

static final String 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

LANGUAGE

static final String LANGUAGE
Language of the document.

See Also:
Constant Field Values

WIKI

static final String WIKI
Keyword field, holds the name of the virtual wiki a document belongs to.

See Also:
Constant Field Values

SPACE

static final String SPACE
Name of the space the document belongs to.

See Also:
Constant Field Values

SPACE_EXACT

static final String SPACE_EXACT
Unanalyzed and not stored version of the document's space.

See Also:
Constant Field Values

NAME

static final String NAME
Name of the document.

See Also:
Constant Field Values

FULLNAME

static final String FULLNAME
FullName of the document (example : Main.WebHome).

See Also:
Constant Field Values

TITLE

static final String TITLE
Title of the document.

Note: Multilingual and virtual field.

See Also:
Constant Field Values

TITLE_SORT

static final String TITLE_SORT
Lowercased, unanalyzed and not stored version of the document's title, used for sorting.

See Also:
Constant Field Values

VERSION

static final String VERSION
Version of the document.

See Also:
Constant Field Values

TYPE

static final String TYPE
Type of a document. "DOCUMENT", "ATTACHMENT", "OBJECT" and "OBJECT_PROPERTY" are the used values corresponding to the values from EntityType.

See Also:
Constant Field Values

CLASS

static final String CLASS
XWiki object class, only used for objects and properties.

See Also:
Constant Field Values

OBJECT_CONTENT

static final String OBJECT_CONTENT
XWiki object content. Used by objects to index their properties and by documents to index all the properties of the contained objects.

Note: Multilingual and virtual field.

See Also:
Constant Field Values

AUTHOR

static final String AUTHOR
Last modifier.

See Also:
Constant Field Values

AUTHOR_DISPLAY

static final String AUTHOR_DISPLAY
Last modifier, in its display version (i.e., "first_name last_name").

See Also:
Constant Field Values

AUTHOR_DISPLAY_SORT

static final String AUTHOR_DISPLAY_SORT
Lowercased, unanalyzed and not stored version of the document's last author display version, used for sorting.

See Also:
Constant Field Values

CREATOR

static final String CREATOR
Creator of the document.

See Also:
Constant Field Values

CREATOR_DISPLAY

static final String CREATOR_DISPLAY
Creator of the document, in its display version (i.e., "first_name last_name").

See Also:
Constant Field Values

DATE

static final String DATE
Date of last modification.

See Also:
Constant Field Values

CREATIONDATE

static final String CREATIONDATE
Date of creation.

See Also:
Constant Field Values

HIDDEN

static final String HIDDEN
Document hidden flag.

See Also:
Constant Field Values

SCORE

static final String SCORE
Document score, not an actual field. It's only computed at query time.

See Also:
Constant Field Values

DOCUMENT_CONTENT

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

Note: Multilingual and virtual field.

See Also:
Constant Field Values

ATTACHMENT_CONTENT

static final String ATTACHMENT_CONTENT
Attachment content.

Note: Multilingual and virtual field.

See Also:
Constant Field Values

MIME_TYPE

static final String MIME_TYPE
For storing mimetype of the attachments.

See Also:
Constant Field Values

FILENAME

static final String FILENAME
Filename, only used for attachments.

See Also:
Constant Field Values

COMMENT

static final String COMMENT
For storing the comments.

Note: Multilingual and virtual field.

See Also:
Constant Field Values

PROPERTY_NAME

static final String PROPERTY_NAME
For storing property name.

See Also:
Constant Field Values

PROPERTY_VALUE

static final String PROPERTY_VALUE
For storing property value.

Note: Multilingual and virtual field.

See Also:
Constant Field Values

USCORE

static final String USCORE
Underscore character, used to separate the field name from the suffix.

See Also:
Constant Field Values

MULTILINGUAL

static final String MULTILINGUAL
Multilingual field suffix for the field of "text_general" type.

See Also:
Constant Field Values

MULTILIGNUAL_FORMAT

static final String MULTILIGNUAL_FORMAT
Format string for multilingual fields.

See Also:
Constant Field Values