com.atlassian.confluence.search.lucene

Class DocumentFieldName

java.lang.Object

com.atlassian.confluence.search.lucene.DocumentFieldName

public final class DocumentFieldName
extends Object

Class to contain the field names for Confluence lucene documents.

Ideally we want to move towards moving field names out of bonnie and core extractors into this class so we have a central place for them.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTACHMENT_MIME_TYPE
static String	ATTACHMENT_NICE_TYPE Stores a general type for multiple MIME types; multiple MIME types may map to one description, e.g.
static String	ATTACHMENT_OWNER_CONTENT_TITLE
static String	ATTACHMENT_OWNER_CONTENT_TYPE Stores the fully qualified class name of the content that owns the attachment
static String	CONTENT_NAME_UNTOKENIZED An untokenized version of the title of a piece of content to enable sorting on it
static String	CONTENT_VERSION
static String	CREATION_DATE
static String	DOCUMENT_TYPE Represents the document type.
static String	IS_DEACTIVATED_USER "true" if the User is deactivated/disabled, else "false".
static String	IS_EXTERNALLY_DELETED_USER "true" if the User has been removed from the system via an External Directory, else "false".
static String	IS_LICENSED_USER "true" if the User has a license to use the system, else "false".
static String	IS_SHADOWED_USER "true" if the User is a shadowed user.
static String	LAST_MODIFICATION_DATE
static String	LAST_MODIFIER_NAME
static String	LATEST_VERSION_ID
static String	MENTION
static String	PROFILE_PICTURE_URL Relative URL of the user's profile picture, as returned by ProfilePictureInfo.getUriReference().
static String	SPACE_KEY Space key (a constant for the field name we use in our *.lucene.xml mappings)
static String	SPACE_NAME
static String	SPACE_TYPE
static String	TITLE
static String	USER_FULLNAME The display name of the user.
static String	USER_KEY The user key as returned by ConfluenceUser.getKey().
static String	USER_NAME The username as returned by Entity.getName().

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

DOCUMENT_TYPE

public static final String DOCUMENT_TYPE

Represents the document type.

See Also:

SearchResultType, Constant Field Values

SPACE_KEY

public static final String SPACE_KEY

Space key (a constant for the field name we use in our *.lucene.xml mappings)

See Also:

Constant Field Values

SPACE_NAME

public static final String SPACE_NAME

See Also:

Constant Field Values

SPACE_TYPE

public static final String SPACE_TYPE

See Also:

Constant Field Values

LATEST_VERSION_ID

public static final String LATEST_VERSION_ID

See Also:

Constant Field Values

ATTACHMENT_MIME_TYPE

public static final String ATTACHMENT_MIME_TYPE

See Also:

Constant Field Values

ATTACHMENT_NICE_TYPE

public static final String ATTACHMENT_NICE_TYPE

Stores a general type for multiple MIME types; multiple MIME types may map to one description, e.g. "Image".

See Also:

Constant Field Values

ATTACHMENT_OWNER_CONTENT_TYPE

public static final String ATTACHMENT_OWNER_CONTENT_TYPE

Stores the fully qualified class name of the content that owns the attachment

See Also:

Constant Field Values

ATTACHMENT_OWNER_CONTENT_TITLE

public static final String ATTACHMENT_OWNER_CONTENT_TITLE

See Also:

Constant Field Values

LAST_MODIFIER_NAME

public static final String LAST_MODIFIER_NAME

See Also:

Constant Field Values

CREATION_DATE

public static final String CREATION_DATE

See Also:

Constant Field Values

LAST_MODIFICATION_DATE

public static final String LAST_MODIFICATION_DATE

See Also:

Constant Field Values

TITLE

public static final String TITLE

See Also:

Constant Field Values

CONTENT_VERSION

public static final String CONTENT_VERSION

See Also:

Constant Field Values

CONTENT_NAME_UNTOKENIZED

public static final String CONTENT_NAME_UNTOKENIZED

An untokenized version of the title of a piece of content to enable sorting on it

See Also:

Constant Field Values

IS_DEACTIVATED_USER

public static final String IS_DEACTIVATED_USER

"true" if the User is deactivated/disabled, else "false".

See Also:

Constant Field Values

IS_EXTERNALLY_DELETED_USER

public static final String IS_EXTERNALLY_DELETED_USER

"true" if the User has been removed from the system via an External Directory, else "false".

See Also:

Constant Field Values

IS_SHADOWED_USER

public static final String IS_SHADOWED_USER

"true" if the User is a shadowed user. The shadowed users come from multiple user directories. The primary user is the active user.

See Also:

Constant Field Values

IS_LICENSED_USER

public static final String IS_LICENSED_USER

"true" if the User has a license to use the system, else "false".

See Also:

Constant Field Values

PROFILE_PICTURE_URL

public static final String PROFILE_PICTURE_URL

Relative URL of the user's profile picture, as returned by ProfilePictureInfo.getUriReference().

See Also:

Constant Field Values

USER_KEY

public static final String USER_KEY

The user key as returned by ConfluenceUser.getKey().

See Also:

Constant Field Values

USER_NAME

public static final String USER_NAME

The username as returned by Entity.getName(). @see PersonalInformation.lucene.xml

See Also:

Constant Field Values

USER_FULLNAME

public static final String USER_FULLNAME

The display name of the user. @see PersonalInformation.lucene.xml

See Also:

Constant Field Values

MENTION

public static final String MENTION

See Also:

Constant Field Values