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[] KEYWORDS = {
068                    Field.ASSET_CATEGORY_TITLES, Field.ASSET_TAG_NAMES, Field.COMMENTS,
069                    Field.CONTENT, Field.DESCRIPTION, Field.PROPERTIES, Field.TITLE,
070                    Field.URL, Field.USER_NAME
071            };
072    
073            /**
074             * @deprecated {@link #MODIFIED_DATE}
075             */
076            public static final String MODIFIED = "modified";
077    
078            public static final String MODIFIED_DATE = "modified";
079    
080            public static final String NAME = "name";
081    
082            public static final String NODE_ID = "nodeId";
083    
084            public static final String ORGANIZATION_ID = "organizationId";
085    
086            public static final String PORTLET_ID = "portletId";
087    
088            public static final String PROPERTIES = "properties";
089    
090            public static final String REMOVED_BY_USER_NAME = "removedByUserName";
091    
092            public static final String REMOVED_DATE = "removedDate";
093    
094            public static final String ROLE_ID = "roleId";
095    
096            public static final String ROOT_ENTRY_CLASS_NAME = "rootEntryClassName";
097    
098            public static final String ROOT_ENTRY_CLASS_PK = "rootEntryClassPK";
099    
100            public static final String SCOPE_GROUP_ID = "scopeGroupId";
101    
102            public static final String SNIPPET = "snippet";
103    
104            public static final String STAGING_GROUP = "stagingGroup";
105    
106            public static final String STATUS = "status";
107    
108            public static final String TITLE = "title";
109    
110            public static final String TYPE = "type";
111    
112            public static final String UID = "uid";
113    
114            public static final String[] UNSCORED_FIELD_NAMES = {
115                    Field.ASSET_CATEGORY_IDS, Field.COMPANY_ID, Field.ENTRY_CLASS_NAME,
116                    Field.ENTRY_CLASS_PK, Field.FOLDER_ID, Field.GROUP_ID,
117                    Field.GROUP_ROLE_ID, Field.PORTLET_ID, Field.ROLE_ID,
118                    Field.SCOPE_GROUP_ID, Field.USER_ID
119            };
120    
121            public static final String URL = "url";
122    
123            public static final String USER_ID = "userId";
124    
125            public static final String USER_NAME = "userName";
126    
127            public static final String VERSION = "version";
128    
129            public Field(String name, Map<Locale, String> localizedValues) {
130                    _name = name;
131                    _localizedValues = localizedValues;
132            }
133    
134            public Field(String name, String value) {
135                    this(name, new String[] {value});
136            }
137    
138            /**
139             * @deprecated
140             */
141            public Field(String name, String value, boolean tokenized) {
142                    this(name, value);
143    
144                    setTokenized(tokenized);
145            }
146    
147            public Field(String name, String[] values) {
148                    _name = name;
149                    _values = values;
150            }
151    
152            /**
153             * @deprecated
154             */
155            public Field(String name, String[] values, boolean tokenized) {
156                    this(name, values);
157    
158                    setTokenized(tokenized);
159            }
160    
161            /**
162             * @deprecated
163             */
164            public Field(String name, String[] values, boolean tokenized, float boost) {
165                    this(name, values);
166    
167                    setBoost(boost);
168                    setTokenized(tokenized);
169            }
170    
171            public float getBoost() {
172                    return _boost;
173            }
174    
175            public Map<Locale, String> getLocalizedValues() {
176                    return _localizedValues;
177            }
178    
179            public String getName() {
180                    return _name;
181            }
182    
183            public String getValue() {
184                    if ((_values != null) && (_values.length > 0)) {
185                            return _values[0];
186                    }
187                    else {
188                            return null;
189                    }
190            }
191    
192            public String[] getValues() {
193                    return _values;
194            }
195    
196            public boolean isLocalized() {
197                    if (_localizedValues != null) {
198                            return true;
199                    }
200                    else {
201                            return false;
202                    }
203            }
204    
205            public boolean isNumeric() {
206                    return _numeric;
207            }
208    
209            public boolean isTokenized() {
210                    return _tokenized;
211            }
212    
213            public void setBoost(float boost) {
214                    _boost = boost;
215            }
216    
217            public void setName(String name) {
218                    _name = name;
219            }
220    
221            public void setNumeric(boolean numeric) {
222                    _numeric = numeric;
223            }
224    
225            public void setTokenized(boolean tokenized) {
226                    _tokenized = tokenized;
227            }
228    
229            public void setValue(String value) {
230                    setValues(new String[] {value});
231            }
232    
233            public void setValues(String[] values) {
234                    _values = values;
235            }
236    
237            private float _boost = 1;
238            private Map<Locale, String> _localizedValues;
239            private String _name;
240            private boolean _numeric;
241            private boolean _tokenized;
242            private String[] _values;
243    
244    }