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            public static final String ASSET_CATEGORY_NAMES = "assetCategoryNames";
033    
034            public static final String ASSET_TAG_NAMES = "assetTagNames";
035    
036            public static final String CATEGORY_ID = "categoryId";
037    
038            public static final String CLASS_NAME_ID = "classNameId";
039    
040            public static final String CLASS_PK = "classPK";
041    
042            public static final String COMMENTS = "comments";
043    
044            public static final String COMPANY_ID = "companyId";
045    
046            public static final String CONTENT = "content";
047    
048            public static final String CREATE_DATE = "createDate";
049    
050            public static final String DESCRIPTION = "description";
051    
052            public static final String ENTRY_CLASS_NAME = "entryClassName";
053    
054            public static final String ENTRY_CLASS_PK = "entryClassPK";
055    
056            public static final String FOLDER_ID = "folderId";
057    
058            public static final String GROUP_ID = "groupId";
059    
060            public static final String GROUP_ROLE_ID = "groupRoleId";
061    
062            public static final String[] KEYWORDS = {
063                    Field.ASSET_CATEGORY_NAMES, Field.ASSET_TAG_NAMES, Field.COMMENTS,
064                    Field.CONTENT, Field.DESCRIPTION, Field.PROPERTIES, Field.TITLE,
065                    Field.URL, Field.USER_NAME
066            };
067    
068            /**
069             * @deprecated {@link #MODIFIED_DATE}
070             */
071            public static final String MODIFIED = "modified";
072    
073            public static final String MODIFIED_DATE = "modified";
074    
075            public static final String NAME = "name";
076    
077            public static final String NODE_ID = "nodeId";
078    
079            public static final String ORGANIZATION_ID = "organizationId";
080    
081            public static final String PORTLET_ID = "portletId";
082    
083            public static final String PROPERTIES = "properties";
084    
085            public static final String ROLE_ID = "roleId";
086    
087            public static final String ROOT_ENTRY_CLASS_PK = "rootEntryClassPK";
088    
089            public static final String SCOPE_GROUP_ID = "scopeGroupId";
090    
091            public static final String SNIPPET = "snippet";
092    
093            public static final String STAGING_GROUP = "stagingGroup";
094    
095            public static final String STATUS = "status";
096    
097            public static final String TITLE = "title";
098    
099            public static final String TYPE = "type";
100    
101            public static final String UID = "uid";
102    
103            public static final String[] UNSCORED_FIELD_NAMES = {
104                    Field.ASSET_CATEGORY_IDS, Field.COMPANY_ID, Field.ENTRY_CLASS_NAME,
105                    Field.ENTRY_CLASS_PK, Field.FOLDER_ID, Field.GROUP_ID,
106                    Field.GROUP_ROLE_ID, Field.PORTLET_ID, Field.ROLE_ID,
107                    Field.SCOPE_GROUP_ID, Field.USER_ID
108            };
109    
110            public static final String URL = "url";
111    
112            public static final String USER_ID = "userId";
113    
114            public static final String USER_NAME = "userName";
115    
116            public static final String VERSION = "version";
117    
118            public Field(String name, Map<Locale, String> localizedValues) {
119                    _name = name;
120                    _localizedValues = localizedValues;
121            }
122    
123            public Field(String name, String value) {
124                    this(name, new String[] {value});
125            }
126    
127            public Field(String name, String[] values) {
128                    _name = name;
129                    _values = values;
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            /**
142             * @deprecated
143             */
144            public Field(String name, String[] values, boolean tokenized) {
145                    this(name, values);
146    
147                    setTokenized(tokenized);
148            }
149    
150            /**
151             * @deprecated
152             */
153            public Field(String name, String[] values, boolean tokenized, float boost) {
154                    this(name, values);
155    
156                    setBoost(boost);
157                    setTokenized(tokenized);
158            }
159    
160            public float getBoost() {
161                    return _boost;
162            }
163    
164            public Map<Locale, String> getLocalizedValues() {
165                    return _localizedValues;
166            }
167    
168            public String getName() {
169                    return _name;
170            }
171    
172            public String getValue() {
173                    if ((_values != null) && (_values.length > 0)) {
174                            return _values[0];
175                    }
176                    else {
177                            return null;
178                    }
179            }
180    
181            public String[] getValues() {
182                    return _values;
183            }
184    
185            public boolean isLocalized() {
186                    if (_localizedValues != null) {
187                            return true;
188                    }
189                    else {
190                            return false;
191                    }
192            }
193    
194            public boolean isNumeric() {
195                    return _numeric;
196            }
197    
198            public boolean isTokenized() {
199                    return _tokenized;
200            }
201    
202            public void setBoost(float boost) {
203                    _boost = boost;
204            }
205    
206            public void setName(String name) {
207                    _name = name;
208            }
209    
210            public void setNumeric(boolean numeric) {
211                    _numeric = numeric;
212            }
213    
214            public void setTokenized(boolean tokenized) {
215                    _tokenized = tokenized;
216            }
217    
218            public void setValue(String value) {
219                    setValues(new String[] {value});
220            }
221    
222            public void setValues(String[] values) {
223                    _values = values;
224            }
225    
226            private float _boost = 1;
227            private Map<Locale, String> _localizedValues;
228            private String _name;
229            private boolean _numeric;
230            private boolean _tokenized;
231            private String[] _values;
232    
233    }