com.atlassian.confluence.search.v2

Class SearchFieldNames

java.lang.Object

com.atlassian.confluence.search.v2.SearchFieldNames

public class SearchFieldNames
extends Object

A helper class that contains the known set of core available Strings.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ANONYMOUS_LAST_MODIFIER_ID Constant to represent the value for an anonymous last modifier in the index.
static String	ATTACHMENT_DOWNLOAD_PATH
static String	ATTACHMENT_FILE_EXTENSION
static String	ATTACHMENT_FILE_NAME
static String	ATTACHMENT_FILE_NAME_UNTOKENIZED
static String	ATTACHMENT_FILE_SIZE
static String	ATTACHMENT_MIME_TYPE
static String	ATTACHMENT_NICE_FILE_SIZE
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_TYPE Stores the fully qualified class name of the content that owns the attachment
static String	ATTACHMENT_OWNER_ID
static String	ATTACHMENT_OWNER_REAL_TITLE
static String	ATTACHMENT_OWNER_TYPE
static String	ATTACHMENT_OWNER_URL_PATH
static String	ATTACHMENT_OWNER_USERNAME
static String	ATTACHMENT_VERSION_COMMENT
static String	CLASS_NAME
static String	CONTAINER_CONTENT_TYPE
static String	CONTENT
static String	CONTENT_NAME_UNSTEMMED
static String	CONTENT_NAME_UNTOKENIZED An untokenized version of the title of a piece of content to enable sorting on it
static String	CONTENT_PERMISSION_SETS
static String	CONTENT_PLUGIN_KEY
static String	CONTENT_STATUS
static String	CONTENT_VERSION
static String	CREATION_DATE
static String	CREATOR
static String	DOCUMENT_TYPE Represents the document type.
static String	HANDLE
static String	HOME_PAGE
static String	IN_SPACE
static String	INHERITED_LABEL The same as LABEL, but for labels inherited from a containing object (i.e.
static String	INHERITED_LABEL_TEXT The same as LABEL_TEXT, but for labels inherited from a containing object (i.e.
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	LABEL Assigned multiple fields of namespaced labels
static String	LABEL_TEXT This field is assigned a value consisting of a space delimited list of all the publicly visible labels on a piece of content.
static String	LAST_MODIFICATION_DATE
static String	LAST_MODIFIER
static String	LAST_MODIFIERS
static String	LAST_UPDATE_DESCRIPTION
static String	LATEST_VERSION_ID
static String	MACRO_NAME
static String	MACRO_STORAGE_VERSION
static String	MENTION
static String	MODIFIED Deprecated. since 7.14 use LAST_MODIFICATION_DATE instead. An untokenized version of the title of a piece of content to enable sorting on it
static String	OWNER_CONTENT_TITLE Deprecated. since 7.20. This constant will be removed in Confluence 8.0. Use ATTACHMENT_OWNER_REAL_TITLE.
static String	OWNER_TYPE Deprecated. since 7.14 use ATTACHMENT_OWNER_CONTENT_TYPE instead. Stores the fully qualified class name of the content that owns the attachment
static String	PAGE_DISPLAY_TITLE
static String	PAGE_URL_PATH
static String	PARENT_TITLE_UNSTEMMED
static String	PARENT_TITLE_UNSTEMMED_FIELD Deprecated. since 7.20 use PARENT_TITLE_UNSTEMMED instead. "true" if the User has been removed from the system via an External Directory, else "false".
static String	PERSONAL_INFORMATION_EMAIL
static String	PERSONAL_INFORMATION_FULL_NAME
static String	PERSONAL_INFORMATION_FULL_NAME_UNTOKENIZED
static String	PERSONAL_INFORMATION_HAS_PERSONAL_SPACE
static String	PERSONAL_INFORMATION_USERNAME
static String	PROFILE_PICTURE_URL Relative URL of the user's profile picture, as returned by ProfilePictureInfo.getUriReference().
static String	RETENTION_POLICY
static String	RETENTION_POLICY_DELETE_TRASH
static String	RETENTION_POLICY_DELETE_VERSION
static String	SPACE_DESCRIPTION_EMAIL
static String	SPACE_DESCRIPTION_USER_FULLNAME
static String	SPACE_DESCRIPTION_USER_FULLNAME_SORTABLE
static String	SPACE_DESCRIPTION_USER_NAME
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	TYPE
static String	URL_PATH
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().
static String	VERSION

Constructor Summary

Constructors

Constructor and Description
SearchFieldNames()

Method Summary

Modifier and Type	Method and Description
static com.google.common.collect.ImmutableSet<String>	createWithDefaultValues(String... additionalFields) Deprecated. since 7.0.1. Use withDefaultValues(). This method will be removed in Confluence 8.0
static Set<String>	withDefaultValues() Creates a set of Strings suitable for passing to searchManager.search(ISearch, Set<String>) that includes the handle field and the content version field, these fields whilst optional are required to use the convertToEntities method of SearchManager.

Methods inherited from class java.lang.Object

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

Field Detail

ANONYMOUS_LAST_MODIFIER_ID

public static final String ANONYMOUS_LAST_MODIFIER_ID

Constant to represent the value for an anonymous last modifier in the index. We want to record anonymous users, so we can remove change documents by them (also because you cannot use lucene to search for documents that don't have a field).

See Also:

Constant Field Values

ATTACHMENT_DOWNLOAD_PATH

public static final String ATTACHMENT_DOWNLOAD_PATH

See Also:

Constant Field Values

ATTACHMENT_FILE_EXTENSION

public static final String ATTACHMENT_FILE_EXTENSION

See Also:

Constant Field Values

ATTACHMENT_FILE_NAME

public static final String ATTACHMENT_FILE_NAME

See Also:

Constant Field Values

ATTACHMENT_FILE_NAME_UNTOKENIZED

public static final String ATTACHMENT_FILE_NAME_UNTOKENIZED

See Also:

Constant Field Values

ATTACHMENT_FILE_SIZE

public static final String ATTACHMENT_FILE_SIZE

See Also:

Constant Field Values

ATTACHMENT_MIME_TYPE

public static final String ATTACHMENT_MIME_TYPE

See Also:

Constant Field Values

ATTACHMENT_NICE_FILE_SIZE

public static final String ATTACHMENT_NICE_FILE_SIZE

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_ID

public static final String ATTACHMENT_OWNER_ID

See Also:

Constant Field Values

ATTACHMENT_OWNER_REAL_TITLE

public static final String ATTACHMENT_OWNER_REAL_TITLE

See Also:

Constant Field Values

ATTACHMENT_OWNER_TYPE

public static final String ATTACHMENT_OWNER_TYPE

See Also:

Constant Field Values

ATTACHMENT_OWNER_URL_PATH

public static final String ATTACHMENT_OWNER_URL_PATH

See Also:

Constant Field Values

ATTACHMENT_OWNER_USERNAME

public static final String ATTACHMENT_OWNER_USERNAME

See Also:

Constant Field Values

ATTACHMENT_VERSION_COMMENT

public static final String ATTACHMENT_VERSION_COMMENT

See Also:

Constant Field Values

CLASS_NAME

public static final String CLASS_NAME

See Also:

Constant Field Values

CONTAINER_CONTENT_TYPE

public static final String CONTAINER_CONTENT_TYPE

See Also:

Constant Field Values

CONTENT

public static final String CONTENT

See Also:

Constant Field Values

CONTENT_NAME_UNSTEMMED

public static final String CONTENT_NAME_UNSTEMMED

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

CONTENT_PERMISSION_SETS

public static final String CONTENT_PERMISSION_SETS

See Also:

Constant Field Values

CONTENT_PLUGIN_KEY

public static final String CONTENT_PLUGIN_KEY

See Also:

Constant Field Values

CONTENT_STATUS

public static final String CONTENT_STATUS

See Also:

Constant Field Values

CONTENT_VERSION

public static final String CONTENT_VERSION

See Also:

Constant Field Values

CREATION_DATE

public static final String CREATION_DATE

See Also:

Constant Field Values

CREATOR

public static final String CREATOR

See Also:

Constant Field Values

DOCUMENT_TYPE

public static final String DOCUMENT_TYPE

Represents the document type.

See Also:

SearchResultType, Constant Field Values

HANDLE

public static final String HANDLE

See Also:

Constant Field Values

HOME_PAGE

public static final String HOME_PAGE

See Also:

Constant Field Values

INHERITED_LABEL

public static final String INHERITED_LABEL

The same as LABEL, but for labels inherited from a containing object (i.e. comments will get the labels of the object they are commenting on).

See Also:

Constant Field Values

INHERITED_LABEL_TEXT

public static final String INHERITED_LABEL_TEXT

The same as LABEL_TEXT, but for labels inherited from a containing object (i.e. comments will get the labels of the object they are commenting on).

See Also:

Constant Field Values

IN_SPACE

public static final String IN_SPACE

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_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

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

LABEL

public static final String LABEL

Assigned multiple fields of namespaced labels

See Also:

Constant Field Values

LABEL_TEXT

public static final String LABEL_TEXT

This field is assigned a value consisting of a space delimited list of all the publicly visible labels on a piece of content.

See Also:

Constant Field Values

LAST_MODIFICATION_DATE

public static final String LAST_MODIFICATION_DATE

See Also:

Constant Field Values

LAST_MODIFIER

public static final String LAST_MODIFIER

See Also:

Constant Field Values

LAST_MODIFIERS

public static final String LAST_MODIFIERS

See Also:

Constant Field Values

LAST_UPDATE_DESCRIPTION

public static final String LAST_UPDATE_DESCRIPTION

See Also:

Constant Field Values

LATEST_VERSION_ID

public static final String LATEST_VERSION_ID

See Also:

Constant Field Values

MENTION

public static final String MENTION

See Also:

Constant Field Values

MACRO_NAME

public static final String MACRO_NAME

See Also:

Constant Field Values

MACRO_STORAGE_VERSION

public static final String MACRO_STORAGE_VERSION

See Also:

Constant Field Values

MODIFIED

@Deprecated
public static final String MODIFIED

Deprecated. since 7.14 use LAST_MODIFICATION_DATE instead. An untokenized version of the title of a piece of content to enable sorting on it

See Also:

Constant Field Values

OWNER_CONTENT_TITLE

@Deprecated
public static final String OWNER_CONTENT_TITLE

Deprecated. since 7.20. This constant will be removed in Confluence 8.0. Use ATTACHMENT_OWNER_REAL_TITLE.

See Also:

Constant Field Values

OWNER_TYPE

@Deprecated
public static final String OWNER_TYPE

Deprecated. since 7.14 use ATTACHMENT_OWNER_CONTENT_TYPE instead. Stores the fully qualified class name of the content that owns the attachment

See Also:

Constant Field Values

PAGE_DISPLAY_TITLE

public static final String PAGE_DISPLAY_TITLE

See Also:

Constant Field Values

PAGE_URL_PATH

public static final String PAGE_URL_PATH

See Also:

Constant Field Values

PARENT_TITLE_UNSTEMMED

public static final String PARENT_TITLE_UNSTEMMED

See Also:

Constant Field Values

PARENT_TITLE_UNSTEMMED_FIELD

@Deprecated
public static final String PARENT_TITLE_UNSTEMMED_FIELD

Deprecated. since 7.20 use PARENT_TITLE_UNSTEMMED instead. "true" if the User has been removed from the system via an External Directory, else "false".

See Also:

Constant Field Values

PERSONAL_INFORMATION_EMAIL

public static final String PERSONAL_INFORMATION_EMAIL

See Also:

Constant Field Values

PERSONAL_INFORMATION_FULL_NAME

public static final String PERSONAL_INFORMATION_FULL_NAME

See Also:

Constant Field Values

PERSONAL_INFORMATION_FULL_NAME_UNTOKENIZED

public static final String PERSONAL_INFORMATION_FULL_NAME_UNTOKENIZED

See Also:

Constant Field Values

PERSONAL_INFORMATION_HAS_PERSONAL_SPACE

public static final String PERSONAL_INFORMATION_HAS_PERSONAL_SPACE

See Also:

Constant Field Values

PERSONAL_INFORMATION_USERNAME

public static final String PERSONAL_INFORMATION_USERNAME

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

RETENTION_POLICY

public static final String RETENTION_POLICY

See Also:

Constant Field Values

RETENTION_POLICY_DELETE_TRASH

public static final String RETENTION_POLICY_DELETE_TRASH

See Also:

Constant Field Values

RETENTION_POLICY_DELETE_VERSION

public static final String RETENTION_POLICY_DELETE_VERSION

See Also:

Constant Field Values

SPACE_DESCRIPTION_EMAIL

public static final String SPACE_DESCRIPTION_EMAIL

See Also:

Constant Field Values

SPACE_DESCRIPTION_USER_FULLNAME

public static final String SPACE_DESCRIPTION_USER_FULLNAME

See Also:

Constant Field Values

SPACE_DESCRIPTION_USER_FULLNAME_SORTABLE

public static final String SPACE_DESCRIPTION_USER_FULLNAME_SORTABLE

See Also:

Constant Field Values

SPACE_DESCRIPTION_USER_NAME

public static final String SPACE_DESCRIPTION_USER_NAME

See Also:

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

TITLE

public static final String TITLE

See Also:

Constant Field Values

TYPE

public static final String TYPE

See Also:

Constant Field Values

URL_PATH

public static final String URL_PATH

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

VERSION

public static final String VERSION

See Also:

Constant Field Values

Constructor Detail

SearchFieldNames

public SearchFieldNames()

Method Detail

createWithDefaultValues

@Deprecated
public static com.google.common.collect.ImmutableSet<String> createWithDefaultValues(String... additionalFields)

Deprecated. since 7.0.1. Use withDefaultValues(). This method will be removed in Confluence 8.0

Creates a set of Strings suitable for passing to searchManager.search(ISearch, Set<String>) that includes the handle field and the content version field, these fields whilst optional are required to use the convertToEntities method of SearchManager.

withDefaultValues

public static Set<String> withDefaultValues()

Creates a set of Strings suitable for passing to searchManager.search(ISearch, Set<String>) that includes the handle field and the content version field, these fields whilst optional are required to use the convertToEntities method of SearchManager.

Since:

7.0.1