com.liferay.portal.kernel.search

Class Field

java.lang.Object

com.liferay.portal.kernel.search.Field

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

FieldArray

@ProviderType
public class Field
extends java.lang.Object
implements java.io.Serializable

Author:

Bruno Farache, Brian Wing Shun Chan, Allen Chiang, Alex Wallace

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Field.NestedFieldBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ANY
static java.lang.String	ARTICLE_ID
static java.lang.String	ASSET_CATEGORY_ID
static java.lang.String	ASSET_CATEGORY_IDS
static java.lang.String	ASSET_CATEGORY_TITLE
static java.lang.String	ASSET_CATEGORY_TITLES
static java.lang.String	ASSET_PARENT_CATEGORY_ID
static java.lang.String	ASSET_PARENT_CATEGORY_IDS
static java.lang.String	ASSET_TAG_IDS
static java.lang.String	ASSET_TAG_NAMES
static java.lang.String	ASSET_VOCABULARY_ID
static java.lang.String	ASSET_VOCABULARY_IDS
static java.lang.String	CAPTION
static java.lang.String	CATEGORY_ID
static java.lang.String	CLASS_NAME_ID
static java.lang.String	CLASS_PK
static java.lang.String	CLASS_TYPE_ID
static java.lang.String	COMMENTS
static java.lang.String	COMPANY_ID
static java.lang.String	CONTENT
static java.lang.String	CREATE_DATE
static java.lang.String	DEFAULT_LANGUAGE_ID
static java.lang.String	DESCRIPTION
static java.lang.String	DISPLAY_DATE
static java.lang.String	ENTRY_CLASS_NAME
static java.lang.String	ENTRY_CLASS_PK
static java.lang.String	EXPIRATION_DATE
static java.lang.String	FOLDER_ID
static java.lang.String	GEO_LOCATION
static java.lang.String	GROUP_ID
static java.lang.String	GROUP_ROLE_ID
static java.lang.String	HIDDEN
static java.lang.String	KEYWORD_SEARCH
static java.lang.String[]	KEYWORDS
static java.lang.String	LANGUAGE_ID
static java.lang.String	LAYOUT_UUID
static java.lang.String	MODIFIED_DATE
static java.lang.String	NAME
static java.lang.String	NODE_ID
static java.lang.String	ORGANIZATION_ID
static java.lang.String	PORTLET_ID Deprecated. As of 7.0.0, replaced by ENTRY_CLASS_NAME
static java.lang.String	PRIORITY
static java.lang.String	PROPERTIES
static java.lang.String	PUBLISH_DATE
static java.lang.String	RATINGS Deprecated. As of 7.0.0, with no direct replacement
static java.lang.String	RELATED_ENTRY
static java.lang.String	REMOVED_BY_USER_NAME
static java.lang.String	REMOVED_DATE
static java.lang.String	ROLE_ID
static java.lang.String	ROOT_ENTRY_CLASS_NAME
static java.lang.String	ROOT_ENTRY_CLASS_PK
static java.lang.String	SCOPE_GROUP_ID
static java.lang.String	SNIPPET
static java.lang.String	SORTABLE_FIELD_SUFFIX
static java.lang.String	SPELL_CHECK_WORD
static java.lang.String	STAGING_GROUP
static java.lang.String	STATUS
static java.lang.String	SUBTITLE
static java.lang.String	TITLE
static java.lang.String	TREE_PATH
static java.lang.String	TYPE
static java.lang.String	UID
static java.lang.String[]	UNSCORED_FIELD_NAMES
static java.lang.String	URL
static java.lang.String	USER_GROUP_ID
static java.lang.String	USER_ID
static java.lang.String	USER_NAME
static java.lang.String	VERSION
static java.lang.String	VIEW_ACTION_ID
static java.lang.String	VIEW_COUNT Deprecated. As of 7.0.0, with no direct replacement

Constructor Summary

Constructors

Constructor and Description
Field(java.lang.String name)
Field(java.lang.String name, java.util.Map<java.util.Locale,java.lang.String> localizedValues)
Field(java.lang.String name, java.lang.String value)
Field(java.lang.String name, java.lang.String[] values)

Method Summary

Modifier and Type	Method and Description
void	addField(Field field)
float	getBoost() Deprecated. As of 7.0.0, replaced by Query.getBoost()
java.util.Date[]	getDates()
java.util.List<Field>	getFields()
GeoLocationPoint	getGeoLocationPoint()
static java.lang.String	getLocalizedName(java.util.Locale locale, java.lang.String name)
static java.lang.String	getLocalizedName(java.lang.String languageId, java.lang.String name)
java.util.Map<java.util.Locale,java.lang.String>	getLocalizedValues()
java.lang.String	getName()
java.lang.Class<? extends java.lang.Number>	getNumericClass()
Field	getParentField()
static java.lang.String	getSortableFieldName(java.lang.String name)
static java.lang.String	getSortFieldName(Sort sort, java.lang.String scoreFieldName)
static java.lang.String	getUID(java.lang.String portletId, java.lang.String field1)
static java.lang.String	getUID(java.lang.String portletId, java.lang.String field1, java.lang.String field2)
static java.lang.String	getUID(java.lang.String portletId, java.lang.String field1, java.lang.String field2, java.lang.String field3)
static java.lang.String	getUID(java.lang.String portletId, java.lang.String field1, java.lang.String field2, java.lang.String field3, java.lang.String field4)
java.lang.String	getValue()
java.lang.String[]	getValues()
boolean	hasChildren()
boolean	isArray()
boolean	isDate()
boolean	isLocalized()
boolean	isNested()
boolean	isNumeric()
boolean	isSortable()
static boolean	isSortableFieldName(java.lang.String name)
boolean	isTokenized()
void	setBoost(float boost) Deprecated. As of 7.0.0, replaced by Query.setBoost(float)
void	setDates(java.util.Date[] dates)
void	setGeoLocationPoint(GeoLocationPoint geoLocationPoint)
void	setLocalizedValues(java.util.Map<java.util.Locale,java.lang.String> localizedValues)
void	setName(java.lang.String name)
void	setNumeric(boolean numeric)
void	setNumericClass(java.lang.Class<? extends java.lang.Number> numericClass)
void	setParentField(Field parentField)
void	setSortable(boolean sortable)
void	setTokenized(boolean tokenized)
void	setValue(java.lang.String value)
void	setValues(java.lang.String[] values)
protected void	validate(java.lang.String name)
static boolean	validateFieldName(java.lang.String name)

Methods inherited from class java.lang.Object

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

Field Detail

ANY

public static final java.lang.String ANY

See Also:

Constant Field Values

ARTICLE_ID

public static final java.lang.String ARTICLE_ID

See Also:

Constant Field Values

ASSET_CATEGORY_ID

public static final java.lang.String ASSET_CATEGORY_ID

See Also:

Constant Field Values

ASSET_CATEGORY_IDS

public static final java.lang.String ASSET_CATEGORY_IDS

See Also:

Constant Field Values

ASSET_CATEGORY_TITLE

public static final java.lang.String ASSET_CATEGORY_TITLE

See Also:

Constant Field Values

ASSET_CATEGORY_TITLES

public static final java.lang.String ASSET_CATEGORY_TITLES

See Also:

Constant Field Values

ASSET_PARENT_CATEGORY_ID

public static final java.lang.String ASSET_PARENT_CATEGORY_ID

See Also:

Constant Field Values

ASSET_PARENT_CATEGORY_IDS

public static final java.lang.String ASSET_PARENT_CATEGORY_IDS

See Also:

Constant Field Values

ASSET_TAG_IDS

public static final java.lang.String ASSET_TAG_IDS

See Also:

Constant Field Values

ASSET_TAG_NAMES

public static final java.lang.String ASSET_TAG_NAMES

See Also:

Constant Field Values

ASSET_VOCABULARY_ID

public static final java.lang.String ASSET_VOCABULARY_ID

See Also:

Constant Field Values

ASSET_VOCABULARY_IDS

public static final java.lang.String ASSET_VOCABULARY_IDS

See Also:

Constant Field Values

CAPTION

public static final java.lang.String CAPTION

See Also:

Constant Field Values

CATEGORY_ID

public static final java.lang.String CATEGORY_ID

See Also:

Constant Field Values

CLASS_NAME_ID

public static final java.lang.String CLASS_NAME_ID

See Also:

Constant Field Values

CLASS_PK

public static final java.lang.String CLASS_PK

See Also:

Constant Field Values

CLASS_TYPE_ID

public static final java.lang.String CLASS_TYPE_ID

See Also:

Constant Field Values

COMMENTS

public static final java.lang.String COMMENTS

See Also:

Constant Field Values

COMPANY_ID

public static final java.lang.String COMPANY_ID

See Also:

Constant Field Values

CONTENT

public static final java.lang.String CONTENT

See Also:

Constant Field Values

CREATE_DATE

public static final java.lang.String CREATE_DATE

See Also:

Constant Field Values

DEFAULT_LANGUAGE_ID

public static final java.lang.String DEFAULT_LANGUAGE_ID

See Also:

Constant Field Values

DESCRIPTION

public static final java.lang.String DESCRIPTION

See Also:

Constant Field Values

DISPLAY_DATE

public static final java.lang.String DISPLAY_DATE

See Also:

Constant Field Values

ENTRY_CLASS_NAME

public static final java.lang.String ENTRY_CLASS_NAME

See Also:

Constant Field Values

ENTRY_CLASS_PK

public static final java.lang.String ENTRY_CLASS_PK

See Also:

Constant Field Values

EXPIRATION_DATE

public static final java.lang.String EXPIRATION_DATE

See Also:

Constant Field Values

FOLDER_ID

public static final java.lang.String FOLDER_ID

See Also:

Constant Field Values

GEO_LOCATION

public static final java.lang.String GEO_LOCATION

See Also:

Constant Field Values

GROUP_ID

public static final java.lang.String GROUP_ID

See Also:

Constant Field Values

GROUP_ROLE_ID

public static final java.lang.String GROUP_ROLE_ID

See Also:

Constant Field Values

HIDDEN

public static final java.lang.String HIDDEN

See Also:

Constant Field Values

KEYWORD_SEARCH

public static final java.lang.String KEYWORD_SEARCH

See Also:

Constant Field Values

KEYWORDS

public static final java.lang.String[] KEYWORDS

LANGUAGE_ID

public static final java.lang.String LANGUAGE_ID

See Also:

Constant Field Values

LAYOUT_UUID

public static final java.lang.String LAYOUT_UUID

See Also:

Constant Field Values

MODIFIED_DATE

public static final java.lang.String MODIFIED_DATE

See Also:

Constant Field Values

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

NODE_ID

public static final java.lang.String NODE_ID

See Also:

Constant Field Values

ORGANIZATION_ID

public static final java.lang.String ORGANIZATION_ID

See Also:

Constant Field Values

PORTLET_ID

@Deprecated
public static final java.lang.String PORTLET_ID

Deprecated. As of 7.0.0, replaced by ENTRY_CLASS_NAME

See Also:

Constant Field Values

PRIORITY

public static final java.lang.String PRIORITY

See Also:

Constant Field Values

PROPERTIES

public static final java.lang.String PROPERTIES

See Also:

Constant Field Values

PUBLISH_DATE

public static final java.lang.String PUBLISH_DATE

See Also:

Constant Field Values

RATINGS

@Deprecated
public static final java.lang.String RATINGS

Deprecated. As of 7.0.0, with no direct replacement

See Also:

Constant Field Values

RELATED_ENTRY

public static final java.lang.String RELATED_ENTRY

See Also:

Constant Field Values

REMOVED_BY_USER_NAME

public static final java.lang.String REMOVED_BY_USER_NAME

See Also:

Constant Field Values

REMOVED_DATE

public static final java.lang.String REMOVED_DATE

See Also:

Constant Field Values

ROLE_ID

public static final java.lang.String ROLE_ID

See Also:

Constant Field Values

ROOT_ENTRY_CLASS_NAME

public static final java.lang.String ROOT_ENTRY_CLASS_NAME

See Also:

Constant Field Values

ROOT_ENTRY_CLASS_PK

public static final java.lang.String ROOT_ENTRY_CLASS_PK

See Also:

Constant Field Values

SCOPE_GROUP_ID

public static final java.lang.String SCOPE_GROUP_ID

See Also:

Constant Field Values

SNIPPET

public static final java.lang.String SNIPPET

See Also:

Constant Field Values

SORTABLE_FIELD_SUFFIX

public static final java.lang.String SORTABLE_FIELD_SUFFIX

See Also:

Constant Field Values

SPELL_CHECK_WORD

public static final java.lang.String SPELL_CHECK_WORD

See Also:

Constant Field Values

STAGING_GROUP

public static final java.lang.String STAGING_GROUP

See Also:

Constant Field Values

STATUS

public static final java.lang.String STATUS

See Also:

Constant Field Values

SUBTITLE

public static final java.lang.String SUBTITLE

See Also:

Constant Field Values

TITLE

public static final java.lang.String TITLE

See Also:

Constant Field Values

TREE_PATH

public static final java.lang.String TREE_PATH

See Also:

Constant Field Values

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

UID

public static final java.lang.String UID

See Also:

Constant Field Values

UNSCORED_FIELD_NAMES

public static final java.lang.String[] UNSCORED_FIELD_NAMES

URL

public static final java.lang.String URL

See Also:

Constant Field Values

USER_GROUP_ID

public static final java.lang.String USER_GROUP_ID

See Also:

Constant Field Values

USER_ID

public static final java.lang.String USER_ID

See Also:

Constant Field Values

USER_NAME

public static final java.lang.String USER_NAME

See Also:

Constant Field Values

VERSION

public static final java.lang.String VERSION

See Also:

Constant Field Values

VIEW_ACTION_ID

public static final java.lang.String VIEW_ACTION_ID

See Also:

Constant Field Values

VIEW_COUNT

@Deprecated
public static final java.lang.String VIEW_COUNT

Deprecated. As of 7.0.0, with no direct replacement

See Also:

Constant Field Values

Constructor Detail

Field

public Field(java.lang.String name)

Field

public Field(java.lang.String name,
             java.util.Map<java.util.Locale,java.lang.String> localizedValues)

Field

public Field(java.lang.String name,
             java.lang.String value)

Field

public Field(java.lang.String name,
             java.lang.String[] values)

Method Detail

getLocalizedName

public static java.lang.String getLocalizedName(java.util.Locale locale,
                                                java.lang.String name)

getLocalizedName

public static java.lang.String getLocalizedName(java.lang.String languageId,
                                                java.lang.String name)

getSortableFieldName

public static java.lang.String getSortableFieldName(java.lang.String name)

getSortFieldName

public static java.lang.String getSortFieldName(Sort sort,
                                                java.lang.String scoreFieldName)

getUID

public static java.lang.String getUID(java.lang.String portletId,
                                      java.lang.String field1)

getUID

public static java.lang.String getUID(java.lang.String portletId,
                                      java.lang.String field1,
                                      java.lang.String field2)

getUID

public static java.lang.String getUID(java.lang.String portletId,
                                      java.lang.String field1,
                                      java.lang.String field2,
                                      java.lang.String field3)

getUID

public static java.lang.String getUID(java.lang.String portletId,
                                      java.lang.String field1,
                                      java.lang.String field2,
                                      java.lang.String field3,
                                      java.lang.String field4)

isSortableFieldName

public static boolean isSortableFieldName(java.lang.String name)

validateFieldName

public static boolean validateFieldName(java.lang.String name)

addField

public void addField(Field field)

getBoost

@Deprecated
public float getBoost()

Deprecated. As of 7.0.0, replaced by Query.getBoost()

getDates

public java.util.Date[] getDates()

getFields

public java.util.List<Field> getFields()

getGeoLocationPoint

public GeoLocationPoint getGeoLocationPoint()

getLocalizedValues

public java.util.Map<java.util.Locale,java.lang.String> getLocalizedValues()

getName

public java.lang.String getName()

getNumericClass

public java.lang.Class<? extends java.lang.Number> getNumericClass()

getParentField

public Field getParentField()

getValue

public java.lang.String getValue()

getValues

public java.lang.String[] getValues()

hasChildren

public boolean hasChildren()

isArray

public boolean isArray()

isDate

public boolean isDate()

isLocalized

public boolean isLocalized()

isNested

public boolean isNested()

isNumeric

public boolean isNumeric()

isSortable

public boolean isSortable()

isTokenized

public boolean isTokenized()

setBoost

@Deprecated
public void setBoost(float boost)

Deprecated. As of 7.0.0, replaced by Query.setBoost(float)

setDates

public void setDates(java.util.Date[] dates)

setGeoLocationPoint

public void setGeoLocationPoint(GeoLocationPoint geoLocationPoint)

setLocalizedValues

public void setLocalizedValues(java.util.Map<java.util.Locale,java.lang.String> localizedValues)

setName

public void setName(java.lang.String name)

setNumeric

public void setNumeric(boolean numeric)

setNumericClass

public void setNumericClass(java.lang.Class<? extends java.lang.Number> numericClass)

setParentField

public void setParentField(Field parentField)

setSortable

public void setSortable(boolean sortable)

setTokenized

public void setTokenized(boolean tokenized)

setValue

public void setValue(java.lang.String value)

setValues

public void setValues(java.lang.String[] values)

validate

protected void validate(java.lang.String name)