2 * Copyright (c) 2000-2012 Liferay, Inc. All rights reserved.
\r
4 * This library is free software; you can redistribute it and/or modify it under
\r
5 * the terms of the GNU Lesser General Public License as published by the Free
\r
6 * Software Foundation; either version 2.1 of the License, or (at your option)
\r
9 * This library is distributed in the hope that it will be useful, but WITHOUT
\r
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
\r
11 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
\r
15 package com.liferay.portal.kernel.search;
\r
17 import java.io.Serializable;
\r
19 import java.util.Locale;
\r
20 import java.util.Map;
\r
23 * @author Bruno Farache
\r
24 * @author Brian Wing Shun Chan
\r
25 * @author Allen Chiang
\r
26 * @author Alex Wallace
\r
28 public class Field implements Serializable {
\r
30 public static final String ACCOUNT_ID = "accountId";
\r
32 public static final String ASSET_CATEGORY_IDS = "assetCategoryIds";
\r
35 * @deprecated {@link #ASSET_CATEGORY_TITLES}
\r
37 public static final String ASSET_CATEGORY_NAMES = "assetCategoryNames";
\r
39 public static final String ASSET_CATEGORY_TITLES = "assetCategoryTitles";
\r
41 public static final String ASSET_TAG_NAMES = "assetTagNames";
\r
43 public static final String CALENDAR_ID = "calendarId";
\r
45 public static final String CATEGORY_ID = "categoryId";
\r
47 public static final String CHANEL_ID = "chanelId";
\r
49 public static final String CHANEL_TITLE = "chanelTitle";
\r
51 public static final String CLASS_NAME_ID = "classNameId";
\r
53 public static final String CLASS_PK = "classPK";
\r
55 public static final String COMMENTS = "comments";
\r
57 public static final String COMPANY_ID = "companyId";
\r
59 public static final String CONTENT = "content";
\r
61 public static final String CREATE_DATE = "createDate";
\r
63 public static final String DESCRIPTION = "description";
\r
65 public static final String ENTRY_CLASS_NAME = "entryClassName";
\r
67 public static final String ENTRY_CLASS_PK = "entryClassPK";
\r
69 public static final String ETAB_ID = "etabId";
\r
71 public static final String FOLDER_ID = "folderId";
\r
73 public static final String GROUP_ID = "groupId";
\r
75 public static final String GROUP_ROLE_ID = "groupRoleId";
\r
77 public static final String KEYWORD_LIST = "keywordList";
\r
79 public static final String[] KEYWORDS = {
\r
80 Field.ASSET_CATEGORY_TITLES, Field.ASSET_TAG_NAMES, Field.COMMENTS,
\r
81 Field.CONTENT, Field.DESCRIPTION, Field.PROPERTIES, Field.TITLE,
\r
82 Field.URL, Field.USER_NAME
\r
85 public static final String LINK_LIST = "linkList";
\r
88 * @deprecated {@link #MODIFIED_DATE}
\r
90 public static final String MODIFIED = "modified";
\r
92 public static final String MODIFIED_DATE = "modified";
\r
94 public static final String NAME = "name";
\r
96 public static final String NODE_ID = "nodeId";
\r
98 public static final String ORGANIZATION_ID = "organizationId";
\r
100 public static final String PORTLET_ID = "portletId";
\r
102 public static final String PROPERTIES = "properties";
\r
104 public static final String ROLE_ID = "roleId";
\r
106 public static final String ROOT_ENTRY_CLASS_PK = "rootEntryClassPK";
\r
108 public static final String SCOPE_GROUP_ID = "scopeGroupId";
\r
110 public static final String SNIPPET = "snippet";
\r
112 public static final String STAGING_GROUP = "stagingGroup";
\r
114 public static final String STATUS = "status";
\r
116 public static final String TAG_LIST = "tagList";
\r
118 public static final String THREAD_ID = "threadId";
\r
120 public static final String TITLE = "title";
\r
122 public static final String TYPE = "type";
\r
124 public static final String UID = "uid";
\r
126 public static final String[] UNSCORED_FIELD_NAMES = {
\r
127 Field.ASSET_CATEGORY_IDS, Field.COMPANY_ID, Field.ENTRY_CLASS_NAME,
\r
128 Field.ENTRY_CLASS_PK, Field.FOLDER_ID, Field.GROUP_ID,
\r
129 Field.GROUP_ROLE_ID, Field.PORTLET_ID, Field.ROLE_ID,
\r
130 Field.SCOPE_GROUP_ID, Field.USER_ID
\r
133 public static final String URL = "url";
\r
135 public static final String USER_ID = "userId";
\r
137 public static final String USER_NAME = "userName";
\r
139 public static final String VERSION = "version";
\r
141 public Field(String name, Map<Locale, String> localizedValues) {
\r
143 _localizedValues = localizedValues;
\r
146 public Field(String name, String value) {
\r
147 this(name, new String[] {value});
\r
150 public Field(String name, String[] values) {
\r
158 public Field(String name, String value, boolean tokenized) {
\r
161 setTokenized(tokenized);
\r
167 public Field(String name, String[] values, boolean tokenized) {
\r
168 this(name, values);
\r
170 setTokenized(tokenized);
\r
176 public Field(String name, String[] values, boolean tokenized, float boost) {
\r
177 this(name, values);
\r
180 setTokenized(tokenized);
\r
183 public float getBoost() {
\r
187 public Map<Locale, String> getLocalizedValues() {
\r
188 return _localizedValues;
\r
191 public String getName() {
\r
195 public String getValue() {
\r
196 if ((_values != null) && (_values.length > 0)) {
\r
204 public String[] getValues() {
\r
208 public boolean isLocalized() {
\r
209 if (_localizedValues != null) {
\r
217 public boolean isNumeric() {
\r
221 public boolean isTokenized() {
\r
225 public void setBoost(float boost) {
\r
229 public void setName(String name) {
\r
233 public void setNumeric(boolean numeric) {
\r
234 _numeric = numeric;
\r
237 public void setTokenized(boolean tokenized) {
\r
238 _tokenized = tokenized;
\r
241 public void setValue(String value) {
\r
242 setValues(new String[] {value});
\r
245 public void setValues(String[] values) {
\r
249 private float _boost = 1;
\r
250 private Map<Locale, String> _localizedValues;
\r
251 private String _name;
\r
252 private boolean _numeric;
\r
253 private boolean _tokenized;
\r
254 private String[] _values;
\r