001    /**
002     * Copyright (c) 2000-2012 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portal.kernel.search;
016    
017    import java.io.Serializable;
018    
019    import java.util.Locale;
020    import java.util.Map;
021    
022    /**
023     * @author Bruno Farache
024     * @author Brian Wing Shun Chan
025     * @author Allen Chiang
026     * @author Alex Wallace
027     */
028    public class Field implements Serializable {
029    
030            public static final String ASSET_CATEGORY_IDS = "assetCategoryIds";
031    
032            /**
033             * @deprecated {@link #ASSET_CATEGORY_TITLES}
034             */
035            public static final String ASSET_CATEGORY_NAMES = "assetCategoryNames";
036    
037            public static final String ASSET_CATEGORY_TITLES = "assetCategoryTitles";
038    
039            public static final String ASSET_TAG_NAMES = "assetTagNames";
040    
041            public static final String CATEGORY_ID = "categoryId";
042    
043            public static final String CLASS_NAME_ID = "classNameId";
044    
045            public static final String CLASS_PK = "classPK";
046    
047            public static final String COMMENTS = "comments";
048    
049            public static final String COMPANY_ID = "companyId";
050    
051            public static final String CONTENT = "content";
052    
053            public static final String CREATE_DATE = "createDate";
054    
055            public static final String DESCRIPTION = "description";
056    
057            public static final String ENTRY_CLASS_NAME = "entryClassName";
058    
059            public static final String ENTRY_CLASS_PK = "entryClassPK";
060    
061            public static final String FOLDER_ID = "folderId";
062    
063            public static final String GROUP_ID = "groupId";
064    
065            public static final String GROUP_ROLE_ID = "groupRoleId";
066    
067            public static final String HIDDEN = "hidden";
068    
069            public static final String KEYWORD_SEARCH = "keywordSearch";
070    
071            public static final String[] KEYWORDS = {
072                    Field.ASSET_CATEGORY_TITLES, Field.ASSET_TAG_NAMES, Field.COMMENTS,
073                    Field.CONTENT, Field.DESCRIPTION, Field.PROPERTIES, Field.TITLE,
074                    Field.URL, Field.USER_NAME
075            };
076    
077            /**
078             * @deprecated {@link #MODIFIED_DATE}
079             */
080            public static final String MODIFIED = "modified";
081    
082            public static final String MODIFIED_DATE = "modified";
083    
084            public static final String NAME = "name";
085    
086            public static final String NODE_ID = "nodeId";
087    
088            public static final String ORGANIZATION_ID = "organizationId";
089    
090            public static final String PORTLET_ID = "portletId";
091    
092            public static final String PROPERTIES = "properties";
093    
094            public static final String RELATED_ENTRY = "relatedEntry";
095    
096            public static final String REMOVED_BY_USER_NAME = "removedByUserName";
097    
098            public static final String REMOVED_DATE = "removedDate";
099    
100            public static final String ROLE_ID = "roleId";
101    
102            public static final String ROOT_ENTRY_CLASS_NAME = "rootEntryClassName";
103    
104            public static final String ROOT_ENTRY_CLASS_PK = "rootEntryClassPK";
105    
106            public static final String SCOPE_GROUP_ID = "scopeGroupId";
107    
108            public static final String SNIPPET = "snippet";
109    
110            public static final String STAGING_GROUP = "stagingGroup";
111    
112            public static final String STATUS = "status";
113    
114            public static final String TITLE = "title";
115    
116            public static final String TYPE = "type";
117    
118            public static final String UID = "uid";
119    
120            public static final String[] UNSCORED_FIELD_NAMES = {
121                    Field.ASSET_CATEGORY_IDS, Field.COMPANY_ID, Field.ENTRY_CLASS_NAME,
122                    Field.ENTRY_CLASS_PK, Field.FOLDER_ID, Field.GROUP_ID,
123                    Field.GROUP_ROLE_ID, Field.PORTLET_ID, Field.ROLE_ID,
124                    Field.SCOPE_GROUP_ID, Field.USER_ID
125            };
126    
127            public static final String URL = "url";
128    
129            public static final String USER_GROUP_ID = "userGroupId";
130    
131            public static final String USER_ID = "userId";
132    
133            public static final String USER_NAME = "userName";
134    
135            public static final String VERSION = "version";
136    
137            public Field(String name, Map<Locale, String> localizedValues) {
138                    _name = name;
139                    _localizedValues = localizedValues;
140            }
141    
142            public Field(String name, String value) {
143                    this(name, new String[] {value});
144            }
145    
146            /**
147             * @deprecated
148             */
149            public Field(String name, String value, boolean tokenized) {
150                    this(name, value);
151    
152                    setTokenized(tokenized);
153            }
154    
155            public Field(String name, String[] values) {
156                    _name = name;
157                    _values = values;
158            }
159    
160            /**
161             * @deprecated
162             */
163            public Field(String name, String[] values, boolean tokenized) {
164                    this(name, values);
165    
166                    setTokenized(tokenized);
167            }
168    
169            /**
170             * @deprecated
171             */
172            public Field(String name, String[] values, boolean tokenized, float boost) {
173                    this(name, values);
174    
175                    setBoost(boost);
176                    setTokenized(tokenized);
177            }
178    
179            public float getBoost() {
180                    return _boost;
181            }
182    
183            public Map<Locale, String> getLocalizedValues() {
184                    return _localizedValues;
185            }
186    
187            public String getName() {
188                    return _name;
189            }
190    
191            public String getValue() {
192                    if ((_values != null) && (_values.length > 0)) {
193                            return _values[0];
194                    }
195                    else {
196                            return null;
197                    }
198            }
199    
200            public String[] getValues() {
201                    return _values;
202            }
203    
204            public boolean isLocalized() {
205                    if (_localizedValues != null) {
206                            return true;
207                    }
208                    else {
209                            return false;
210                    }
211            }
212    
213            public boolean isNumeric() {
214                    return _numeric;
215            }
216    
217            public boolean isTokenized() {
218                    return _tokenized;
219            }
220    
221            public void setBoost(float boost) {
222                    _boost = boost;
223            }
224    
225            public void setName(String name) {
226                    _name = name;
227            }
228    
229            public void setNumeric(boolean numeric) {
230                    _numeric = numeric;
231            }
232    
233            public void setTokenized(boolean tokenized) {
234                    _tokenized = tokenized;
235            }
236    
237            public void setValue(String value) {
238                    setValues(new String[] {value});
239            }
240    
241            public void setValues(String[] values) {
242                    _values = values;
243            }
244    
245            private float _boost = 1;
246            private Map<Locale, String> _localizedValues;
247            private String _name;
248            private boolean _numeric;
249            private boolean _tokenized;
250            private String[] _values;
251    
252    }