com.liferay.portal.kernel.search

Class SearchEngineUtil

java.lang.Object

com.liferay.portal.kernel.search.SearchEngineUtil

public class SearchEngineUtil
extends java.lang.Object

Author:

Bruno Farache, Raymond Augé, Michael C. Han

Field Summary

Fields

Modifier and Type	Field and Description
static int	ALL_POS Deprecated. As of 6.2.0, replaced by QueryUtil.ALL_POS
static java.lang.String	GENERIC_ENGINE_ID
static java.lang.String	SYSTEM_ENGINE_ID

Constructor Summary

Constructors

Constructor and Description
SearchEngineUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static void	addDocument(long companyId, Document document) Deprecated. As of 6.2.0, replaced by addDocument(String, long, Document, boolean)
static void	addDocument(java.lang.String searchEngineId, long companyId, Document document) Deprecated. As of 7.0.0, replaced by addDocument(String, long, Document, boolean)
static void	addDocument(java.lang.String searchEngineId, long companyId, Document document, boolean commitImmediately)
static void	addDocuments(long companyId, java.util.Collection<Document> documents) Deprecated. As of 6.2.0, replaced by addDocuments(String, long, Collection, boolean)
static void	addDocuments(java.lang.String searchEngineId, long companyId, java.util.Collection<Document> documents) Deprecated. As of 7.0.0, replaced by addDocuments(String, long, Collection, boolean)
static void	addDocuments(java.lang.String searchEngineId, long companyId, java.util.Collection<Document> documents, boolean commitImmediately)
static void	addSearchEngine(SearchEngine searchEngine) Deprecated. As of 6.2.0, replaced by setSearchEngine(String, SearchEngine)
static void	deleteDocument(long companyId, java.lang.String uid) Deprecated. As of 6.2.0, replaced by deleteDocument(String, long, String)
static void	deleteDocument(java.lang.String searchEngineId, long companyId, java.lang.String uid) Deprecated. As of 7.0.0, replaced by deleteDocument(String, long, String, boolean)
static void	deleteDocument(java.lang.String searchEngineId, long companyId, java.lang.String uid, boolean commitImmediately)
static void	deleteDocuments(long companyId, java.util.Collection<java.lang.String> uids) Deprecated. As of 6.2.0, replaced by deleteDocuments(String, long, Collection, boolean)
static void	deleteDocuments(java.lang.String searchEngineId, long companyId, java.util.Collection<java.lang.String> uids) Deprecated. As of 7.0.0, replaced by deleteDocuments(String, long, Collection, boolean)
static void	deleteDocuments(java.lang.String searchEngineId, long companyId, java.util.Collection<java.lang.String> uids, boolean commitImmediately)
static void	deletePortletDocuments(long companyId, java.lang.String portletId) Deprecated. As of 6.2.0, replaced by deletePortletDocuments(String, long, String, boolean)
static void	deletePortletDocuments(java.lang.String searchEngineId, long companyId, java.lang.String portletId) Deprecated. As of 7.0.0, replaced by deletePortletDocuments(String, long, String, boolean)
static void	deletePortletDocuments(java.lang.String searchEngineId, long companyId, java.lang.String portletId, boolean commitImmediately)
static java.lang.String	getDefaultSearchEngineId()
static java.lang.String[]	getEntryClassNames()
static SearchEngine	getSearchEngine() Deprecated. As of 6.2.0, replaced by getSearchEngine(String)
static SearchEngine	getSearchEngine(java.lang.String searchEngineId)
static java.lang.String	getSearchEngineId(java.util.Collection<Document> documents)
static java.lang.String	getSearchEngineId(Document document)
static java.util.Set<java.lang.String>	getSearchEngineIds()
static SearchEngine	getSearchEngineSilent(java.lang.String searchEngineId)
static SearchPermissionChecker	getSearchPermissionChecker()
static java.lang.String	getSearchReaderDestinationName(java.lang.String searchEngineId)
static java.lang.String	getSearchWriterDestinationName(java.lang.String searchEngineId)
static void	indexKeyword(long companyId, java.lang.String querySuggestion, float weight, java.lang.String keywordType, java.util.Locale locale)
static void	indexKeyword(java.lang.String searchEngineId, long companyId, java.lang.String querySuggestion, float weight, java.lang.String keywordType, java.util.Locale locale)
static void	indexQuerySuggestionDictionaries(long companyId)
static void	indexQuerySuggestionDictionaries(java.lang.String searchEngineId, long companyId)
static void	indexQuerySuggestionDictionary(long companyId, java.util.Locale locale)
static void	indexQuerySuggestionDictionary(java.lang.String searchEngineId, long companyId, java.util.Locale locale)
static void	indexSpellCheckerDictionaries(long companyId)
static void	indexSpellCheckerDictionaries(java.lang.String searchEngineId, long companyId)
static void	indexSpellCheckerDictionary(long companyId, java.util.Locale locale)
static void	indexSpellCheckerDictionary(java.lang.String searchEngineId, long companyId, java.util.Locale locale)
static boolean	isIndexReadOnly()
static SearchEngine	removeSearchEngine(java.lang.String searchEngineId)
static Hits	search(long companyId, long[] groupIds, long userId, java.lang.String className, Query query, int start, int end) Deprecated. As of 6.2.0
static Hits	search(long companyId, long[] groupIds, long userId, java.lang.String className, Query query, Sort[] sorts, int start, int end) Deprecated. As of 6.2.0
static Hits	search(long companyId, long[] groupIds, long userId, java.lang.String className, Query query, Sort sort, int start, int end) Deprecated. As of 6.2.0
static Hits	search(long companyId, Query query, int start, int end) Deprecated. As of 6.2.0, replaced by search(String, long, Query, int, int)
static Hits	search(long companyId, Query query, Sort[] sorts, int start, int end) Deprecated. As of 6.2.0, replaced by search(String, long, Query, Sort[], int, int)
static Hits	search(long companyId, Query query, Sort sort, int start, int end) Deprecated. As of 6.2.0, replaced by search(String, long, Query, Sort, int, int)
static Hits	search(SearchContext searchContext, Query query)
static Hits	search(java.lang.String searchEngineId, long companyId, Query query, int start, int end)
static Hits	search(java.lang.String searchEngineId, long companyId, Query query, Sort[] sorts, int start, int end)
static Hits	search(java.lang.String searchEngineId, long companyId, Query query, Sort sort, int start, int end)
static void	setDefaultSearchEngineId(java.lang.String defaultSearchEngineId)
void	setExcludedEntryClassNames(java.util.List<java.lang.String> excludedEntryClassNames)
static void	setIndexReadOnly(boolean indexReadOnly)
void	setSearchEngine(SearchEngine searchEngine) Deprecated. As of 6.2.0, replaced by setSearchEngine(String, SearchEngine)
static void	setSearchEngine(java.lang.String searchEngineId, SearchEngine searchEngine)
void	setSearchPermissionChecker(SearchPermissionChecker searchPermissionChecker)
static java.lang.String	spellCheckKeywords(SearchContext searchContext)
static java.util.Map<java.lang.String,java.util.List<java.lang.String>>	spellCheckKeywords(SearchContext searchContext, int max)
static java.lang.String[]	suggestKeywordQueries(SearchContext searchContext, int max)
static void	updateDocument(long companyId, Document document) Deprecated. As of 6.2.0, replaced by updateDocument(String, long, Document)
static void	updateDocument(java.lang.String searchEngineId, long companyId, Document document) Deprecated. As of 7.0.0, replaced by updateDocument(String, long, Document, boolean)
static void	updateDocument(java.lang.String searchEngineId, long companyId, Document document, boolean commitImmediately)
static void	updateDocuments(long companyId, java.util.Collection<Document> documents) Deprecated. As of 6.2.0, replaced by updateDocuments(String, long, Collection)
static void	updateDocuments(java.lang.String searchEngineId, long companyId, java.util.Collection<Document> documents) Deprecated. As of 7.0.0, replaced by updateDocuments(String, long, Collection, boolean)
static void	updateDocuments(java.lang.String searchEngineId, long companyId, java.util.Collection<Document> documents, boolean commitImmediately)
static void	updatePermissionFields(java.lang.String name, java.lang.String primKey)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ALL_POS

public static final int ALL_POS

Deprecated. As of 6.2.0, replaced by QueryUtil.ALL_POS

See Also:

Constant Field Values

GENERIC_ENGINE_ID

public static final java.lang.String GENERIC_ENGINE_ID

See Also:

Constant Field Values

SYSTEM_ENGINE_ID

public static final java.lang.String SYSTEM_ENGINE_ID

See Also:

Constant Field Values

Constructor Detail

SearchEngineUtil

public SearchEngineUtil()

Method Detail

addDocument

public static void addDocument(long companyId,
               Document document)
                        throws SearchException

Deprecated. As of 6.2.0, replaced by addDocument(String, long, Document, boolean)

Throws:

SearchException

addDocument

@Deprecated
public static void addDocument(java.lang.String searchEngineId,
                          long companyId,
                          Document document)
                        throws SearchException

Deprecated. As of 7.0.0, replaced by addDocument(String, long, Document, boolean)

Throws:

SearchException

addDocument

public static void addDocument(java.lang.String searchEngineId,
               long companyId,
               Document document,
               boolean commitImmediately)
                        throws SearchException

Throws:

SearchException

addDocuments

public static void addDocuments(long companyId,
                java.util.Collection<Document> documents)
                         throws SearchException

Deprecated. As of 6.2.0, replaced by addDocuments(String, long, Collection, boolean)

Throws:

SearchException

addDocuments

@Deprecated
public static void addDocuments(java.lang.String searchEngineId,
                           long companyId,
                           java.util.Collection<Document> documents)
                         throws SearchException

Deprecated. As of 7.0.0, replaced by addDocuments(String, long, Collection, boolean)

Throws:

SearchException

addDocuments

public static void addDocuments(java.lang.String searchEngineId,
                long companyId,
                java.util.Collection<Document> documents,
                boolean commitImmediately)
                         throws SearchException

Throws:

SearchException

addSearchEngine

public static void addSearchEngine(SearchEngine searchEngine)

Deprecated. As of 6.2.0, replaced by setSearchEngine(String, SearchEngine)

deleteDocument

public static void deleteDocument(long companyId,
                  java.lang.String uid)
                           throws SearchException

Deprecated. As of 6.2.0, replaced by deleteDocument(String, long, String)

Throws:

SearchException

deleteDocument

@Deprecated
public static void deleteDocument(java.lang.String searchEngineId,
                             long companyId,
                             java.lang.String uid)
                           throws SearchException

Deprecated. As of 7.0.0, replaced by deleteDocument(String, long, String, boolean)

Throws:

SearchException

deleteDocument

public static void deleteDocument(java.lang.String searchEngineId,
                  long companyId,
                  java.lang.String uid,
                  boolean commitImmediately)
                           throws SearchException

Throws:

SearchException

deleteDocuments

public static void deleteDocuments(long companyId,
                   java.util.Collection<java.lang.String> uids)
                            throws SearchException

Deprecated. As of 6.2.0, replaced by deleteDocuments(String, long, Collection, boolean)

Throws:

SearchException

deleteDocuments

@Deprecated
public static void deleteDocuments(java.lang.String searchEngineId,
                              long companyId,
                              java.util.Collection<java.lang.String> uids)
                            throws SearchException

Deprecated. As of 7.0.0, replaced by deleteDocuments(String, long, Collection, boolean)

Throws:

SearchException

deleteDocuments

public static void deleteDocuments(java.lang.String searchEngineId,
                   long companyId,
                   java.util.Collection<java.lang.String> uids,
                   boolean commitImmediately)
                            throws SearchException

Throws:

SearchException

deletePortletDocuments

public static void deletePortletDocuments(long companyId,
                          java.lang.String portletId)
                                   throws SearchException

Deprecated. As of 6.2.0, replaced by deletePortletDocuments(String, long, String, boolean)

Throws:

SearchException

deletePortletDocuments

@Deprecated
public static void deletePortletDocuments(java.lang.String searchEngineId,
                                     long companyId,
                                     java.lang.String portletId)
                                   throws SearchException

Deprecated. As of 7.0.0, replaced by deletePortletDocuments(String, long, String, boolean)

Throws:

SearchException

deletePortletDocuments

public static void deletePortletDocuments(java.lang.String searchEngineId,
                          long companyId,
                          java.lang.String portletId,
                          boolean commitImmediately)
                                   throws SearchException

Throws:

SearchException

getDefaultSearchEngineId

public static java.lang.String getDefaultSearchEngineId()

getEntryClassNames

public static java.lang.String[] getEntryClassNames()

getSearchEngine

public static SearchEngine getSearchEngine()

Deprecated. As of 6.2.0, replaced by getSearchEngine(String)

getSearchEngine

public static SearchEngine getSearchEngine(java.lang.String searchEngineId)

getSearchEngineId

public static java.lang.String getSearchEngineId(java.util.Collection<Document> documents)

getSearchEngineId

public static java.lang.String getSearchEngineId(Document document)

getSearchEngineIds

public static java.util.Set<java.lang.String> getSearchEngineIds()

getSearchEngineSilent

public static SearchEngine getSearchEngineSilent(java.lang.String searchEngineId)

getSearchPermissionChecker

public static SearchPermissionChecker getSearchPermissionChecker()

getSearchReaderDestinationName

public static java.lang.String getSearchReaderDestinationName(java.lang.String searchEngineId)

getSearchWriterDestinationName

public static java.lang.String getSearchWriterDestinationName(java.lang.String searchEngineId)

indexKeyword

public static void indexKeyword(long companyId,
                java.lang.String querySuggestion,
                float weight,
                java.lang.String keywordType,
                java.util.Locale locale)
                         throws SearchException

Throws:

SearchException

indexKeyword

public static void indexKeyword(java.lang.String searchEngineId,
                long companyId,
                java.lang.String querySuggestion,
                float weight,
                java.lang.String keywordType,
                java.util.Locale locale)
                         throws SearchException

Throws:

SearchException

indexQuerySuggestionDictionaries

public static void indexQuerySuggestionDictionaries(long companyId)
                                             throws SearchException

Throws:

SearchException

indexQuerySuggestionDictionaries

public static void indexQuerySuggestionDictionaries(java.lang.String searchEngineId,
                                    long companyId)
                                             throws SearchException

Throws:

SearchException

indexQuerySuggestionDictionary

public static void indexQuerySuggestionDictionary(long companyId,
                                  java.util.Locale locale)
                                           throws SearchException

Throws:

SearchException

indexQuerySuggestionDictionary

public static void indexQuerySuggestionDictionary(java.lang.String searchEngineId,
                                  long companyId,
                                  java.util.Locale locale)
                                           throws SearchException

Throws:

SearchException

indexSpellCheckerDictionaries

public static void indexSpellCheckerDictionaries(long companyId)
                                          throws SearchException

Throws:

SearchException

indexSpellCheckerDictionaries

public static void indexSpellCheckerDictionaries(java.lang.String searchEngineId,
                                 long companyId)
                                          throws SearchException

Throws:

SearchException

indexSpellCheckerDictionary

public static void indexSpellCheckerDictionary(long companyId,
                               java.util.Locale locale)
                                        throws SearchException

Throws:

SearchException

indexSpellCheckerDictionary

public static void indexSpellCheckerDictionary(java.lang.String searchEngineId,
                               long companyId,
                               java.util.Locale locale)
                                        throws SearchException

Throws:

SearchException

isIndexReadOnly

public static boolean isIndexReadOnly()

removeSearchEngine

public static SearchEngine removeSearchEngine(java.lang.String searchEngineId)

search

public static Hits search(long companyId,
          long[] groupIds,
          long userId,
          java.lang.String className,
          Query query,
          int start,
          int end)
                   throws SearchException

Deprecated. As of 6.2.0

Throws:

SearchException

search

public static Hits search(long companyId,
          long[] groupIds,
          long userId,
          java.lang.String className,
          Query query,
          Sort sort,
          int start,
          int end)
                   throws SearchException

Deprecated. As of 6.2.0

Throws:

SearchException

search

public static Hits search(long companyId,
          long[] groupIds,
          long userId,
          java.lang.String className,
          Query query,
          Sort[] sorts,
          int start,
          int end)
                   throws SearchException

Deprecated. As of 6.2.0

Throws:

SearchException

search

public static Hits search(long companyId,
          Query query,
          int start,
          int end)
                   throws SearchException

Deprecated. As of 6.2.0, replaced by search(String, long, Query, int, int)

Throws:

SearchException

search

public static Hits search(long companyId,
          Query query,
          Sort sort,
          int start,
          int end)
                   throws SearchException

Deprecated. As of 6.2.0, replaced by search(String, long, Query, Sort, int, int)

Throws:

SearchException

search

public static Hits search(long companyId,
          Query query,
          Sort[] sorts,
          int start,
          int end)
                   throws SearchException

Deprecated. As of 6.2.0, replaced by search(String, long, Query, Sort[], int, int)

Throws:

SearchException

search

public static Hits search(SearchContext searchContext,
          Query query)
                   throws SearchException

Throws:

SearchException

search

public static Hits search(java.lang.String searchEngineId,
          long companyId,
          Query query,
          int start,
          int end)
                   throws SearchException

Throws:

SearchException

search

public static Hits search(java.lang.String searchEngineId,
          long companyId,
          Query query,
          Sort sort,
          int start,
          int end)
                   throws SearchException

Throws:

SearchException

search

public static Hits search(java.lang.String searchEngineId,
          long companyId,
          Query query,
          Sort[] sorts,
          int start,
          int end)
                   throws SearchException

Throws:

SearchException

setDefaultSearchEngineId

public static void setDefaultSearchEngineId(java.lang.String defaultSearchEngineId)

setIndexReadOnly

public static void setIndexReadOnly(boolean indexReadOnly)

setSearchEngine

public static void setSearchEngine(java.lang.String searchEngineId,
                   SearchEngine searchEngine)

spellCheckKeywords

public static java.lang.String spellCheckKeywords(SearchContext searchContext)
                                           throws SearchException

Throws:

SearchException

spellCheckKeywords

public static java.util.Map<java.lang.String,java.util.List<java.lang.String>> spellCheckKeywords(SearchContext searchContext,
                                                                                  int max)
                                                                                           throws SearchException

Throws:

SearchException

suggestKeywordQueries

public static java.lang.String[] suggestKeywordQueries(SearchContext searchContext,
                                       int max)
                                                throws SearchException

Throws:

SearchException

updateDocument

public static void updateDocument(long companyId,
                  Document document)
                           throws SearchException

Deprecated. As of 6.2.0, replaced by updateDocument(String, long, Document)

Throws:

SearchException

updateDocument

@Deprecated
public static void updateDocument(java.lang.String searchEngineId,
                             long companyId,
                             Document document)
                           throws SearchException

Deprecated. As of 7.0.0, replaced by updateDocument(String, long, Document, boolean)

Throws:

SearchException

updateDocument

public static void updateDocument(java.lang.String searchEngineId,
                  long companyId,
                  Document document,
                  boolean commitImmediately)
                           throws SearchException

Throws:

SearchException

updateDocuments

public static void updateDocuments(long companyId,
                   java.util.Collection<Document> documents)
                            throws SearchException

Deprecated. As of 6.2.0, replaced by updateDocuments(String, long, Collection)

Throws:

SearchException

updateDocuments

@Deprecated
public static void updateDocuments(java.lang.String searchEngineId,
                              long companyId,
                              java.util.Collection<Document> documents)
                            throws SearchException

Deprecated. As of 7.0.0, replaced by updateDocuments(String, long, Collection, boolean)

Throws:

SearchException

updateDocuments

public static void updateDocuments(java.lang.String searchEngineId,
                   long companyId,
                   java.util.Collection<Document> documents,
                   boolean commitImmediately)
                            throws SearchException

Throws:

SearchException

updatePermissionFields

public static void updatePermissionFields(java.lang.String name,
                          java.lang.String primKey)

setExcludedEntryClassNames

public void setExcludedEntryClassNames(java.util.List<java.lang.String> excludedEntryClassNames)

setSearchEngine

public void setSearchEngine(SearchEngine searchEngine)

Deprecated. As of 6.2.0, replaced by setSearchEngine(String, SearchEngine)

setSearchPermissionChecker

public void setSearchPermissionChecker(SearchPermissionChecker searchPermissionChecker)