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