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