com.liferay.portal.kernel.search.SearchContext Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of portal-service Show documentation
Show all versions of portal-service Show documentation
Contains interfaces for the portal services. Interfaces are only loaded by the global class loader and are shared by all plugins.
/**
* Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
*
* This library is free software; you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; either version 2.1 of the License, or (at your option)
* any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
* details.
*/
package com.liferay.portal.kernel.search;
import com.liferay.portal.kernel.dao.orm.QueryUtil;
import com.liferay.portal.kernel.search.facet.Facet;
import com.liferay.portal.kernel.util.ArrayUtil;
import com.liferay.portal.kernel.util.LocaleUtil;
import com.liferay.portal.kernel.util.Validator;
import com.liferay.portal.model.Layout;
import java.io.Serializable;
import java.util.HashMap;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.TimeZone;
import java.util.concurrent.ConcurrentHashMap;
/**
* @author Brian Wing Shun Chan
* @author Julio Camarero
*/
public class SearchContext implements Serializable {
public void addFacet(Facet facet) {
if (facet == null) {
return;
}
_facets.put(facet.getFieldName(), facet);
}
public long[] getAssetCategoryIds() {
return _assetCategoryIds;
}
public String[] getAssetTagNames() {
return _assetTagNames;
}
public Serializable getAttribute(String name) {
if (_attributes == null) {
return null;
}
return _attributes.get(name);
}
public Map getAttributes() {
if (_attributes == null) {
_attributes = new HashMap();
}
return _attributes;
}
public BooleanClause[] getBooleanClauses() {
return _booleanClauses;
}
public long[] getCategoryIds() {
return _categoryIds;
}
public long[] getClassTypeIds() {
return _classTypeIds;
}
public long getCompanyId() {
return _companyId;
}
public int getEnd() {
return _end;
}
public String[] getEntryClassNames() {
if (_entryClassNames == null) {
_entryClassNames = new String[0];
}
return _entryClassNames;
}
public Facet getFacet(String fieldName) {
return _facets.get(fieldName);
}
public Map getFacets() {
return _facets;
}
public long[] getFolderIds() {
return _folderIds;
}
public long[] getGroupIds() {
return _groupIds;
}
public String getKeywords() {
return _keywords;
}
public String getLanguageId() {
return LocaleUtil.toLanguageId(_locale);
}
public Layout getLayout() {
return _layout;
}
public Locale getLocale() {
return _locale;
}
public long[] getNodeIds() {
return _nodeIds;
}
public long getOwnerUserId() {
return _ownerUserId;
}
public String[] getPortletIds() {
return _portletIds;
}
public QueryConfig getQueryConfig() {
if (_queryConfig == null) {
_queryConfig = new QueryConfig();
}
return _queryConfig;
}
public float getScoresThreshold() {
return _scoresThreshold;
}
public String getSearchEngineId() {
if (Validator.isNull(_searchEngineId)) {
return SearchEngineUtil.getDefaultSearchEngineId();
}
return _searchEngineId;
}
public Sort[] getSorts() {
return _sorts;
}
public int getStart() {
return _start;
}
public TimeZone getTimeZone() {
return _timeZone;
}
public long getUserId() {
return _userId;
}
public boolean hasOverridenKeywords() {
return Validator.isNull(_originalKeywords);
}
public boolean isAndSearch() {
return _andSearch;
}
public boolean isIncludeAttachments() {
return _includeAttachments;
}
public boolean isIncludeDiscussions() {
return _includeDiscussions;
}
public boolean isIncludeLiveGroups() {
return _includeLiveGroups;
}
public boolean isIncludeStagingGroups() {
return _includeStagingGroups;
}
public boolean isLike() {
return _like;
}
public boolean isScopeStrict() {
return _scopeStrict;
}
public void overrideKeywords(String keywords) {
_originalKeywords = _keywords;
_keywords = keywords;
}
public void setAndSearch(boolean andSearch) {
_andSearch = andSearch;
}
public void setAssetCategoryIds(long[] assetCategoryIds) {
_assetCategoryIds = assetCategoryIds;
}
public void setAssetTagNames(String[] assetTagNames) {
_assetTagNames = assetTagNames;
}
public void setAttribute(String name, Serializable value) {
if (_attributes == null) {
_attributes = new HashMap();
}
_attributes.put(name, value);
}
public void setAttributes(Map attributes) {
_attributes = attributes;
}
public void setBooleanClauses(BooleanClause[] booleanClauses) {
_booleanClauses = booleanClauses;
}
public void setCategoryIds(long[] categoryIds) {
_categoryIds = categoryIds;
}
public void setClassTypeIds(long[] classTypeIds) {
_classTypeIds = classTypeIds;
}
public void setCompanyId(long companyId) {
_companyId = companyId;
}
public void setEnd(int end) {
_end = end;
}
public void setEntryClassNames(String[] entryClassNames) {
_entryClassNames = entryClassNames;
}
public void setFacets(List facets) {
for (Facet facet : facets) {
_facets.put(facet.getFieldName(), facet);
}
}
public void setFolderIds(List folderIds) {
_folderIds = ArrayUtil.toArray(
folderIds.toArray(new Long[folderIds.size()]));
}
public void setFolderIds(long[] folderIds) {
_folderIds = folderIds;
}
public void setGroupIds(long[] groupIds) {
_groupIds = groupIds;
}
public void setIncludeAttachments(boolean includeAttachments) {
_includeAttachments = includeAttachments;
}
public void setIncludeDiscussions(boolean includeDiscussions) {
_includeDiscussions = includeDiscussions;
}
public void setIncludeLiveGroups(boolean includeLiveGroups) {
_includeLiveGroups = includeLiveGroups;
}
public void setIncludeStagingGroups(boolean includeStagingGroups) {
_includeStagingGroups = includeStagingGroups;
}
public void setKeywords(String keywords) {
_keywords = keywords;
}
public void setLayout(Layout layout) {
_layout = layout;
}
public void setLike(boolean like) {
_like = like;
}
public void setLocale(Locale locale) {
if (locale != null) {
_locale = locale;
}
}
public void setNodeIds(long[] nodeIds) {
_nodeIds = nodeIds;
}
public void setOwnerUserId(long ownerUserId) {
_ownerUserId = ownerUserId;
}
public void setPortletIds(String[] portletIds) {
_portletIds = portletIds;
}
public void setQueryConfig(QueryConfig queryConfig) {
_queryConfig = queryConfig;
}
public void setScopeStrict(boolean scopeStrict) {
_scopeStrict = scopeStrict;
}
public void setScoresThreshold(float scoresThreshold) {
_scoresThreshold = scoresThreshold;
}
public void setSearchEngineId(String searchEngineId) {
if (_searchEngineId == null) {
_searchEngineId = searchEngineId;
}
}
public void setSorts(Sort... sorts) {
_sorts = sorts;
}
public void setStart(int start) {
_start = start;
}
public void setTimeZone(TimeZone timeZone) {
_timeZone = timeZone;
}
public void setUserId(long userId) {
_userId = userId;
}
private boolean _andSearch;
private long[] _assetCategoryIds;
private String[] _assetTagNames;
private Map _attributes;
private BooleanClause[] _booleanClauses;
private long[] _categoryIds;
private long[] _classTypeIds;
private long _companyId;
private int _end = QueryUtil.ALL_POS;
private String[] _entryClassNames;
private Map _facets = new ConcurrentHashMap();
private long[] _folderIds;
private long[] _groupIds;
private boolean _includeAttachments;
private boolean _includeDiscussions;
private boolean _includeLiveGroups = true;
private boolean _includeStagingGroups = true;
private String _keywords;
private Layout _layout;
private boolean _like;
private Locale _locale = LocaleUtil.getMostRelevantLocale();
private long[] _nodeIds;
private String _originalKeywords;
private long _ownerUserId;
private String[] _portletIds;
private QueryConfig _queryConfig;
private boolean _scopeStrict = true;
private float _scoresThreshold;
private String _searchEngineId;
private Sort[] _sorts;
private int _start = QueryUtil.ALL_POS;
private TimeZone _timeZone;
private long _userId;
}