Field (Liferay 7.0.10 portal-kernel API)

Object
- com.liferay.portal.kernel.search.Field

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

FieldArray
```
public class Field
extends Object
implements 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

Nested Classes
Modifier and Type	Class and Description
`static class`	`Field.NestedFieldBuilder`

Field Summary

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

Constructor Summary

Constructors
Constructor and Description
`Field(String name)`
`Field(String name, Map<Locale,String> localizedValues)`
`Field(String name, String value)`
`Field(String name, String[] values)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addField(Field field)`
`float`	`getBoost()` Deprecated. As of 7.0.0, replaced by `Query.getBoost()`
`Date[]`	`getDates()`
`List<Field>`	`getFields()`
`GeoLocationPoint`	`getGeoLocationPoint()`
`Map<Locale,String>`	`getLocalizedValues()`
`String`	`getName()`
`Class<? extends Number>`	`getNumericClass()`
`Field`	`getParentField()`
`String`	`getValue()`
`String[]`	`getValues()`
`boolean`	`hasChildren()`
`boolean`	`isArray()`
`boolean`	`isDate()`
`boolean`	`isLocalized()`
`boolean`	`isNested()`
`boolean`	`isNumeric()`
`boolean`	`isSortable()`
`boolean`	`isTokenized()`
`void`	`setBoost(float boost)` Deprecated. As of 7.0.0, replaced by `Query.setBoost(float)`
`void`	`setDates(Date[] dates)`
`void`	`setGeoLocationPoint(GeoLocationPoint geoLocationPoint)`
`void`	`setLocalizedValues(Map<Locale,String> localizedValues)`
`void`	`setName(String name)`
`void`	`setNumeric(boolean numeric)`
`void`	`setNumericClass(Class<? extends Number> numericClass)`
`void`	`setParentField(Field parentField)`
`void`	`setSortable(boolean sortable)`
`void`	`setTokenized(boolean tokenized)`
`void`	`setValue(String value)`
`void`	`setValues(String[] values)`
`protected void`	`validate(String name)`
`static boolean`	`validateFieldName(String name)`

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ANY
```
public static final String ANY
```
See Also:

Constant Field Values

ARTICLE_ID
```
public static final String ARTICLE_ID
```
See Also:

Constant Field Values

ASSET_CATEGORY_ID

public static final String ASSET_CATEGORY_ID

See Also:: Constant Field Values

ASSET_CATEGORY_IDS

public static final String ASSET_CATEGORY_IDS

See Also:: Constant Field Values

ASSET_CATEGORY_TITLE

public static final String ASSET_CATEGORY_TITLE

See Also:: Constant Field Values

ASSET_CATEGORY_TITLES

public static final String ASSET_CATEGORY_TITLES

See Also:: Constant Field Values

ASSET_PARENT_CATEGORY_ID

public static final String ASSET_PARENT_CATEGORY_ID

See Also:: Constant Field Values

ASSET_PARENT_CATEGORY_IDS

public static final String ASSET_PARENT_CATEGORY_IDS

See Also:: Constant Field Values

ASSET_TAG_IDS

public static final String ASSET_TAG_IDS

See Also:: Constant Field Values

ASSET_TAG_NAMES

public static final String ASSET_TAG_NAMES

See Also:: Constant Field Values

ASSET_VOCABULARY_ID

public static final String ASSET_VOCABULARY_ID

See Also:: Constant Field Values

ASSET_VOCABULARY_IDS

public static final String ASSET_VOCABULARY_IDS

See Also:: Constant Field Values

CAPTION
```
public static final String CAPTION
```
See Also:

Constant Field Values

CATEGORY_ID
```
public static final String CATEGORY_ID
```
See Also:

Constant Field Values

CLASS_NAME_ID

public static final String CLASS_NAME_ID

See Also:: Constant Field Values

CLASS_PK
```
public static final String CLASS_PK
```
See Also:

Constant Field Values

CLASS_TYPE_ID

public static final String CLASS_TYPE_ID

See Also:: Constant Field Values

COMMENTS
```
public static final String COMMENTS
```
See Also:

Constant Field Values

COMPANY_ID
```
public static final String COMPANY_ID
```
See Also:

Constant Field Values

CONTENT
```
public static final String CONTENT
```
See Also:

Constant Field Values

CREATE_DATE
```
public static final String CREATE_DATE
```
See Also:

Constant Field Values

DEFAULT_LANGUAGE_ID

public static final String DEFAULT_LANGUAGE_ID

See Also:: Constant Field Values

DESCRIPTION
```
public static final String DESCRIPTION
```
See Also:

Constant Field Values

ENTRY_CLASS_NAME

public static final String ENTRY_CLASS_NAME

See Also:: Constant Field Values

ENTRY_CLASS_PK

public static final String ENTRY_CLASS_PK

See Also:: Constant Field Values

EXPIRATION_DATE

public static final String EXPIRATION_DATE

See Also:: Constant Field Values

FOLDER_ID
```
public static final String FOLDER_ID
```
See Also:

Constant Field Values

GEO_LOCATION

public static final String GEO_LOCATION

See Also:: Constant Field Values

GROUP_ID
```
public static final String GROUP_ID
```
See Also:

Constant Field Values

GROUP_ROLE_ID

public static final String GROUP_ROLE_ID

See Also:: Constant Field Values

HIDDEN
```
public static final String HIDDEN
```
See Also:

Constant Field Values

KEYWORD_SEARCH

public static final String KEYWORD_SEARCH

See Also:: Constant Field Values

KEYWORDS
```
public static final String[] KEYWORDS
```

LANGUAGE_ID
```
public static final String LANGUAGE_ID
```
See Also:

Constant Field Values

LAYOUT_UUID
```
public static final String LAYOUT_UUID
```
See Also:

Constant Field Values

MODIFIED_DATE

public static final String MODIFIED_DATE

See Also:: Constant Field Values

NAME
```
public static final String NAME
```
See Also:

Constant Field Values

NODE_ID
```
public static final String NODE_ID
```
See Also:

Constant Field Values

ORGANIZATION_ID

public static final String ORGANIZATION_ID

See Also:: Constant Field Values

PORTLET_ID
```
@Deprecated
public static final String PORTLET_ID
```
Deprecated. As of 7.0.0, replaced by ENTRY_CLASS_NAME

See Also:

Constant Field Values

PRIORITY
```
public static final String PRIORITY
```
See Also:

Constant Field Values

PROPERTIES
```
public static final String PROPERTIES
```
See Also:

Constant Field Values

PUBLISH_DATE

public static final String PUBLISH_DATE

See Also:: Constant Field Values

RATINGS
```
public static final String RATINGS
```
See Also:

Constant Field Values

RELATED_ENTRY

public static final String RELATED_ENTRY

See Also:: Constant Field Values

REMOVED_BY_USER_NAME

public static final String REMOVED_BY_USER_NAME

See Also:: Constant Field Values

REMOVED_DATE

public static final String REMOVED_DATE

See Also:: Constant Field Values

ROLE_ID
```
public static final String ROLE_ID
```
See Also:

Constant Field Values

ROOT_ENTRY_CLASS_NAME

public static final String ROOT_ENTRY_CLASS_NAME

See Also:: Constant Field Values

ROOT_ENTRY_CLASS_PK

public static final String ROOT_ENTRY_CLASS_PK

See Also:: Constant Field Values

SCOPE_GROUP_ID

public static final String SCOPE_GROUP_ID

See Also:: Constant Field Values

SNIPPET
```
public static final String SNIPPET
```
See Also:

Constant Field Values

SPELL_CHECK_WORD

public static final String SPELL_CHECK_WORD

See Also:: Constant Field Values

STAGING_GROUP

public static final String STAGING_GROUP

See Also:: Constant Field Values

STATUS
```
public static final String STATUS
```
See Also:

Constant Field Values

SUBTITLE
```
public static final String SUBTITLE
```
See Also:

Constant Field Values

TITLE
```
public static final String TITLE
```
See Also:

Constant Field Values

TREE_PATH
```
public static final String TREE_PATH
```
See Also:

Constant Field Values

TYPE
```
public static final String TYPE
```
See Also:

Constant Field Values

UID
```
public static final String UID
```
See Also:

Constant Field Values

UNSCORED_FIELD_NAMES

public static final String[] UNSCORED_FIELD_NAMES

URL
```
public static final String URL
```
See Also:

Constant Field Values

USER_GROUP_ID

public static final String USER_GROUP_ID

See Also:: Constant Field Values

USER_ID
```
public static final String USER_ID
```
See Also:

Constant Field Values

USER_NAME
```
public static final String USER_NAME
```
See Also:

Constant Field Values

VERSION
```
public static final String VERSION
```
See Also:

Constant Field Values

VIEW_ACTION_ID

public static final String VIEW_ACTION_ID

See Also:: Constant Field Values

VIEW_COUNT
```
public static final String VIEW_COUNT
```
See Also:

Constant Field Values

Constructor Detail

Field
```
public Field(String name)
```

Field

public Field(String name,
             Map<Locale,String> localizedValues)

Field

public Field(String name,
             String value)

Field

public Field(String name,
             String[] values)

Method Detail

validateFieldName

public static boolean validateFieldName(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 Date[] getDates()
```

getFields
```
public List<Field> getFields()
```

getGeoLocationPoint

public GeoLocationPoint getGeoLocationPoint()

getLocalizedValues

public Map<Locale,String> getLocalizedValues()

getName
```
public String getName()
```

getNumericClass

public Class<? extends Number> getNumericClass()

getParentField
```
public Field getParentField()
```

getValue
```
public String getValue()
```

getValues
```
public 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(Date[] dates)
```

setGeoLocationPoint

public void setGeoLocationPoint(GeoLocationPoint geoLocationPoint)

setLocalizedValues

public void setLocalizedValues(Map<Locale,String> localizedValues)

setName
```
public void setName(String name)
```

setNumeric

public void setNumeric(boolean numeric)

setNumericClass

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

setParentField

public void setParentField(Field parentField)

setSortable

public void setSortable(boolean sortable)

setTokenized

public void setTokenized(boolean tokenized)

setValue
```
public void setValue(String value)
```

setValues

public void setValues(String[] values)

validate
```
protected void validate(String name)
```

Class Field

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class Object

Field Detail

ANY

ARTICLE_ID

ASSET_CATEGORY_ID

ASSET_CATEGORY_IDS

ASSET_CATEGORY_TITLE

ASSET_CATEGORY_TITLES

ASSET_PARENT_CATEGORY_ID

ASSET_PARENT_CATEGORY_IDS

ASSET_TAG_IDS

ASSET_TAG_NAMES

ASSET_VOCABULARY_ID

ASSET_VOCABULARY_IDS

CAPTION

CATEGORY_ID

CLASS_NAME_ID

CLASS_PK

CLASS_TYPE_ID

COMMENTS

COMPANY_ID

CONTENT

CREATE_DATE

DEFAULT_LANGUAGE_ID

DESCRIPTION

ENTRY_CLASS_NAME

ENTRY_CLASS_PK

EXPIRATION_DATE

FOLDER_ID

GEO_LOCATION

GROUP_ID

GROUP_ROLE_ID

HIDDEN

KEYWORD_SEARCH

KEYWORDS

LANGUAGE_ID

LAYOUT_UUID

MODIFIED_DATE

NAME

NODE_ID

ORGANIZATION_ID

PORTLET_ID

PRIORITY

PROPERTIES

PUBLISH_DATE

RATINGS

RELATED_ENTRY

REMOVED_BY_USER_NAME

REMOVED_DATE

ROLE_ID

ROOT_ENTRY_CLASS_NAME

ROOT_ENTRY_CLASS_PK

SCOPE_GROUP_ID

SNIPPET

SPELL_CHECK_WORD

STAGING_GROUP

STATUS

SUBTITLE

TITLE

TREE_PATH

TYPE

UID

UNSCORED_FIELD_NAMES

URL

USER_GROUP_ID

USER_ID

USER_NAME

VERSION

VIEW_ACTION_ID

VIEW_COUNT

Constructor Detail

Field

Field

Field

Field