com.liferay.portal.kernel.search

Class SearchEngineUtil

Object

com.liferay.portal.kernel.search.SearchEngineHelperUtil

com.liferay.portal.kernel.search.SearchEngineUtil

Deprecated.

As of 7.0.0, replaced by IndexWriterHelperUtil, IndexSearcherHelperUtil, SearchEngineHelperUtil

@Deprecated
public class SearchEngineUtil
extends SearchEngineHelperUtil

Author:

Bruno Farache, Raymond Augé, Michael C. Han

Field Summary

Fields

Modifier and Type	Field and Description
static String	GENERIC_ENGINE_ID Deprecated. As of 7.0.0
static String	SYSTEM_ENGINE_ID Deprecated. As of 7.0.0

Constructor Summary

Constructors

Constructor and Description
SearchEngineUtil() Deprecated.

Method Summary

Modifier and Type	Method and Description
static void	addDocument(String searchEngineId, long companyId, Document document) Deprecated. As of 7.0.0, replaced by IndexWriterHelperUtil.addDocument(String, long, Document, boolean)
static void	addDocument(String searchEngineId, long companyId, Document document, boolean commitImmediately) Deprecated. As of 7.0.0, replaced by IndexWriterHelperUtil.addDocuments(String, long, Collection, boolean)
static void	addDocuments(String searchEngineId, long companyId, Collection<Document> documents) Deprecated. As of 7.0.0, replaced by IndexWriterHelperUtil.addDocuments(String, long, Collection, boolean)
static void	addDocuments(String searchEngineId, long companyId, Collection<Document> documents, boolean commitImmediately) Deprecated. As of 7.0.0, replaced by IndexWriterHelperUtil.addDocuments(String, long, Collection, boolean)
static void	commit(String searchEngineId) Deprecated. As of 7.0.0, replaced by IndexWriterHelperUtil.commit(String)
static void	commit(String searchEngineId, long companyId) Deprecated. As of 7.0.0, replaced by IndexWriterHelperUtil.commit(String, long)
static void	deleteDocument(String searchEngineId, long companyId, String uid) Deprecated. As of 7.0.0, replaced by IndexWriterHelperUtil.deleteDocument(String, long, String, boolean)
static void	deleteDocument(String searchEngineId, long companyId, String uid, boolean commitImmediately) Deprecated. As of 7.0.0, replaced by IndexWriterHelperUtil.deleteDocument(String, long, String, boolean)
static void	deleteDocuments(String searchEngineId, long companyId, Collection<String> uids) Deprecated. As of 7.0.0, replaced by IndexWriterHelperUtil.deleteDocuments(String, long, Collection, boolean)
static void	deleteDocuments(String searchEngineId, long companyId, Collection<String> uids, boolean commitImmediately) Deprecated. As of 7.0.0, replaced by IndexWriterHelperUtil.deleteDocuments(String, long, Collection, boolean)
static void	deleteEntityDocuments(String searchEngineId, long companyId, String className, boolean commitImmediately) Deprecated. As of 7.0.0, replaced by IndexWriterHelperUtil.deleteEntityDocuments(String, long, String, boolean)
static void	deletePortletDocuments(String searchEngineId, long companyId, String portletId) Deprecated. As of 7.0.0, replaced by IndexWriterHelperUtil.deleteEntityDocuments(String, long, String, boolean)
static String	getQueryString(SearchContext searchContext, Query query) Deprecated. As of 7.0.0, replaced by IndexSearcherHelperUtil.getQueryString(SearchContext, Query)
static void	indexKeyword(long companyId, String querySuggestion, float weight, String keywordType, Locale locale) Deprecated. As of 7.0.0, replaced by IndexWriterHelperUtil.indexKeyword(long, String, float, String, Locale)
static void	indexKeyword(String searchEngineId, long companyId, String querySuggestion, float weight, String keywordType, Locale locale) Deprecated. As of 7.0.0, replaced by IndexWriterHelperUtil.indexKeyword(String, long, String, float, String, Locale)
static void	indexQuerySuggestionDictionaries(long companyId) Deprecated. As of 7.0.0, replaced by IndexWriterHelperUtil.indexQuerySuggestionDictionaries(long)
static void	indexQuerySuggestionDictionaries(String searchEngineId, long companyId) Deprecated. As of 7.0.0, replaced by IndexWriterHelperUtil.indexQuerySuggestionDictionaries( String, long)
static void	indexQuerySuggestionDictionary(long companyId, Locale locale) Deprecated. As of 7.0.0, replaced by IndexWriterHelperUtil.indexQuerySuggestionDictionary(long, Locale)
static void	indexQuerySuggestionDictionary(String searchEngineId, long companyId, Locale locale) Deprecated. As of 7.0.0, replaced by IndexWriterHelperUtil.indexQuerySuggestionDictionary(String, long, Locale)
static void	indexSpellCheckerDictionaries(long companyId) Deprecated. As of 7.0.0, replaced by IndexWriterHelperUtil.indexSpellCheckerDictionaries(long)
static void	indexSpellCheckerDictionaries(String searchEngineId, long companyId) Deprecated. As of 7.0.0, replaced by IndexWriterHelperUtil.indexSpellCheckerDictionaries(String, long)
static void	indexSpellCheckerDictionary(long companyId, Locale locale) Deprecated. As of 7.0.0, replaced by IndexWriterHelperUtil.indexSpellCheckerDictionary(long, Locale)
static void	indexSpellCheckerDictionary(String searchEngineId, long companyId, Locale locale) Deprecated. As of 7.0.0, replaced by IndexWriterHelperUtil.indexSpellCheckerDictionary(String, long, Locale)
static boolean	isIndexReadOnly() Deprecated. As of 7.0.0, replaced by IndexWriterHelperUtil.isIndexReadOnly()
static void	partiallyUpdateDocument(String searchEngineId, long companyId, Document document, boolean commitImmediately) Deprecated. As of 7.0.0, replaced by IndexWriterHelperUtil.partiallyUpdateDocument(String, long, Document, boolean)
static void	partiallyUpdateDocuments(String searchEngineId, long companyId, Collection<Document> documents, boolean commitImmediately) Deprecated. As of 7.0.0, replaced by IndexWriterHelperUtil.partiallyUpdateDocuments(String, long, Collection, boolean)
static Hits	search(SearchContext searchContext, Query query) Deprecated. As of 7.0.0, replaced by IndexSearcherHelperUtil.search(SearchContext, Query)
static Hits	search(String searchEngineId, long companyId, Query query, int start, int end) Deprecated. As of 7.0.0, replaced by IndexSearcherHelperUtil.search(SearchContext, Query)
static Hits	search(String searchEngineId, long companyId, Query query, Sort[] sorts, int start, int end) Deprecated. As of 7.0.0, replaced by IndexSearcherHelperUtil.search(SearchContext, Query)
static Hits	search(String searchEngineId, long companyId, Query query, Sort sort, int start, int end) Deprecated. As of 7.0.0, replaced by IndexSearcherHelperUtil.search(SearchContext, Query)
static long	searchCount(SearchContext searchContext, Query query) Deprecated. As of 7.0.0, replaced by IndexSearcherHelperUtil.searchCount(SearchContext, Query)
static void	setIndexReadOnly(boolean readOnly) Deprecated. As of 7.0.0, replaced by IndexWriterHelperUtil.setIndexReadOnly(boolean)
static String	spellCheckKeywords(SearchContext searchContext) Deprecated. As of 7.0.0, replaced by IndexSearcherHelperUtil.spellCheckKeywords(SearchContext)
static Map<String,List<String>>	spellCheckKeywords(SearchContext searchContext, int max) Deprecated. As of 7.0.0, replaced by IndexSearcherHelperUtil.spellCheckKeywords(SearchContext, int)
static String[]	suggestKeywordQueries(SearchContext searchContext, int max) Deprecated. As of 7.0.0, replaced by IndexSearcherHelperUtil.suggestKeywordQueries(SearchContext, int)
static void	updateDocument(String searchEngineId, long companyId, Document document) Deprecated. As of 7.0.0, replaced by IndexWriterHelperUtil.updateDocument(String, long, Document, boolean)
static void	updateDocument(String searchEngineId, long companyId, Document document, boolean commitImmediately) Deprecated. As of 7.0.0, replaced by IndexWriterHelperUtil.updateDocument(String, long, Document, boolean)
static void	updateDocuments(String searchEngineId, long companyId, Collection<Document> documents) Deprecated. As of 7.0.0, replaced by IndexWriterHelperUtil.updateDocuments(String, long, Collection, boolean)
static void	updateDocuments(String searchEngineId, long companyId, Collection<Document> documents, boolean commitImmediately) Deprecated. As of 7.0.0, replaced by IndexWriterHelperUtil.updateDocuments(String, long, Collection, boolean)
static void	updatePermissionFields(String name, String primKey) Deprecated. As of 7.0.0, replaced by IndexWriterHelperUtil.updatePermissionFields(String, String)

Methods inherited from class com.liferay.portal.kernel.search.SearchEngineHelperUtil

flushQueuedSearchEngine, flushQueuedSearchEngine, getDefaultSearchEngineId, getEntryClassNames, getSearchEngine, getSearchEngineHelper, getSearchEngineId, getSearchEngineId, getSearchEngineIds, getSearchEngineSilent, getSearchPermissionChecker, getSearchReaderDestinationName, getSearchWriterDestinationName, initialize, removeCompany, removeSearchEngine, setDefaultSearchEngineId, setQueueCapacity, setSearchEngine

Methods inherited from class Object

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

Field Detail

GENERIC_ENGINE_ID

@Deprecated
public static final String GENERIC_ENGINE_ID

Deprecated. As of 7.0.0

See Also:

Constant Field Values

SYSTEM_ENGINE_ID

@Deprecated
public static final String SYSTEM_ENGINE_ID

Deprecated. As of 7.0.0

See Also:

Constant Field Values

Constructor Detail

SearchEngineUtil

public SearchEngineUtil()

Deprecated.

Method Detail

addDocument

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

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

Throws:

SearchException

addDocument

@Deprecated
public static void addDocument(String searchEngineId,
                                           long companyId,
                                           Document document,
                                           boolean commitImmediately)
                                    throws SearchException

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

Throws:

SearchException

addDocuments

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

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

Throws:

SearchException

addDocuments

@Deprecated
public static void addDocuments(String searchEngineId,
                                            long companyId,
                                            Collection<Document> documents,
                                            boolean commitImmediately)
                                     throws SearchException

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

Throws:

SearchException

commit

@Deprecated
public static void commit(String searchEngineId)
                               throws SearchException

Deprecated. As of 7.0.0, replaced by IndexWriterHelperUtil.commit(String)

Throws:

SearchException

commit

@Deprecated
public static void commit(String searchEngineId,
                                      long companyId)
                               throws SearchException

Deprecated. As of 7.0.0, replaced by IndexWriterHelperUtil.commit(String, long)

Throws:

SearchException

deleteDocument

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

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

Throws:

SearchException

deleteDocument

@Deprecated
public static void deleteDocument(String searchEngineId,
                                              long companyId,
                                              String uid,
                                              boolean commitImmediately)
                                       throws SearchException

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

Throws:

SearchException

deleteDocuments

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

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

Throws:

SearchException

deleteDocuments

@Deprecated
public static void deleteDocuments(String searchEngineId,
                                               long companyId,
                                               Collection<String> uids,
                                               boolean commitImmediately)
                                        throws SearchException

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

Throws:

SearchException

deleteEntityDocuments

@Deprecated
public static void deleteEntityDocuments(String searchEngineId,
                                                     long companyId,
                                                     String className,
                                                     boolean commitImmediately)
                                              throws SearchException

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

Throws:

SearchException

deletePortletDocuments

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

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

Throws:

SearchException

getQueryString

@Deprecated
public static String getQueryString(SearchContext searchContext,
                                                Query query)

Deprecated. As of 7.0.0, replaced by IndexSearcherHelperUtil.getQueryString(SearchContext, Query)

indexKeyword

@Deprecated
public static void indexKeyword(long companyId,
                                            String querySuggestion,
                                            float weight,
                                            String keywordType,
                                            Locale locale)
                                     throws SearchException

Deprecated. As of 7.0.0, replaced by IndexWriterHelperUtil.indexKeyword(long, String, float, String, Locale)

Throws:

SearchException

indexKeyword

@Deprecated
public static void indexKeyword(String searchEngineId,
                                            long companyId,
                                            String querySuggestion,
                                            float weight,
                                            String keywordType,
                                            Locale locale)
                                     throws SearchException

Deprecated. As of 7.0.0, replaced by IndexWriterHelperUtil.indexKeyword(String, long, String, float, String, Locale)

Throws:

SearchException

indexQuerySuggestionDictionaries

@Deprecated
public static void indexQuerySuggestionDictionaries(long companyId)
                                                         throws SearchException

Deprecated. As of 7.0.0, replaced by IndexWriterHelperUtil.indexQuerySuggestionDictionaries(long)

Throws:

SearchException

indexQuerySuggestionDictionaries

@Deprecated
public static void indexQuerySuggestionDictionaries(String searchEngineId,
                                                                long companyId)
                                                         throws SearchException

Deprecated. As of 7.0.0, replaced by IndexWriterHelperUtil.indexQuerySuggestionDictionaries( String, long)

Throws:

SearchException

indexQuerySuggestionDictionary

@Deprecated
public static void indexQuerySuggestionDictionary(long companyId,
                                                              Locale locale)
                                                       throws SearchException

Deprecated. As of 7.0.0, replaced by IndexWriterHelperUtil.indexQuerySuggestionDictionary(long, Locale)

Throws:

SearchException

indexQuerySuggestionDictionary

@Deprecated
public static void indexQuerySuggestionDictionary(String searchEngineId,
                                                              long companyId,
                                                              Locale locale)
                                                       throws SearchException

Deprecated. As of 7.0.0, replaced by IndexWriterHelperUtil.indexQuerySuggestionDictionary(String, long, Locale)

Throws:

SearchException

indexSpellCheckerDictionaries

@Deprecated
public static void indexSpellCheckerDictionaries(long companyId)
                                                      throws SearchException

Deprecated. As of 7.0.0, replaced by IndexWriterHelperUtil.indexSpellCheckerDictionaries(long)

Throws:

SearchException

indexSpellCheckerDictionaries

@Deprecated
public static void indexSpellCheckerDictionaries(String searchEngineId,
                                                             long companyId)
                                                      throws SearchException

Deprecated. As of 7.0.0, replaced by IndexWriterHelperUtil.indexSpellCheckerDictionaries(String, long)

Throws:

SearchException

indexSpellCheckerDictionary

@Deprecated
public static void indexSpellCheckerDictionary(long companyId,
                                                           Locale locale)
                                                    throws SearchException

Deprecated. As of 7.0.0, replaced by IndexWriterHelperUtil.indexSpellCheckerDictionary(long, Locale)

Throws:

SearchException

indexSpellCheckerDictionary

@Deprecated
public static void indexSpellCheckerDictionary(String searchEngineId,
                                                           long companyId,
                                                           Locale locale)
                                                    throws SearchException

Deprecated. As of 7.0.0, replaced by IndexWriterHelperUtil.indexSpellCheckerDictionary(String, long, Locale)

Throws:

SearchException

isIndexReadOnly

@Deprecated
public static boolean isIndexReadOnly()

Deprecated. As of 7.0.0, replaced by IndexWriterHelperUtil.isIndexReadOnly()

partiallyUpdateDocument

@Deprecated
public static void partiallyUpdateDocument(String searchEngineId,
                                                       long companyId,
                                                       Document document,
                                                       boolean commitImmediately)
                                                throws SearchException

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

Throws:

SearchException

partiallyUpdateDocuments

@Deprecated
public static void partiallyUpdateDocuments(String searchEngineId,
                                                        long companyId,
                                                        Collection<Document> documents,
                                                        boolean commitImmediately)
                                                 throws SearchException

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

Throws:

SearchException

search

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

Deprecated. As of 7.0.0, replaced by IndexSearcherHelperUtil.search(SearchContext, Query)

Throws:

SearchException

search

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

Deprecated. As of 7.0.0, replaced by IndexSearcherHelperUtil.search(SearchContext, Query)

Throws:

SearchException

search

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

Deprecated. As of 7.0.0, replaced by IndexSearcherHelperUtil.search(SearchContext, Query)

Throws:

SearchException

search

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

Deprecated. As of 7.0.0, replaced by IndexSearcherHelperUtil.search(SearchContext, Query)

Throws:

SearchException

searchCount

@Deprecated
public static long searchCount(SearchContext searchContext,
                                           Query query)
                                    throws SearchException

Deprecated. As of 7.0.0, replaced by IndexSearcherHelperUtil.searchCount(SearchContext, Query)

Throws:

SearchException

setIndexReadOnly

@Deprecated
public static void setIndexReadOnly(boolean readOnly)

Deprecated. As of 7.0.0, replaced by IndexWriterHelperUtil.setIndexReadOnly(boolean)

spellCheckKeywords

@Deprecated
public static String spellCheckKeywords(SearchContext searchContext)
                                             throws SearchException

Deprecated. As of 7.0.0, replaced by IndexSearcherHelperUtil.spellCheckKeywords(SearchContext)

Throws:

SearchException

spellCheckKeywords

@Deprecated
public static Map<String,List<String>> spellCheckKeywords(SearchContext searchContext,
                                                                      int max)
                                                               throws SearchException

Deprecated. As of 7.0.0, replaced by IndexSearcherHelperUtil.spellCheckKeywords(SearchContext, int)

Throws:

SearchException

suggestKeywordQueries

@Deprecated
public static String[] suggestKeywordQueries(SearchContext searchContext,
                                                         int max)
                                                  throws SearchException

Deprecated. As of 7.0.0, replaced by IndexSearcherHelperUtil.suggestKeywordQueries(SearchContext, int)

Throws:

SearchException

updateDocument

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

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

Throws:

SearchException

updateDocument

@Deprecated
public static void updateDocument(String searchEngineId,
                                              long companyId,
                                              Document document,
                                              boolean commitImmediately)
                                       throws SearchException

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

Throws:

SearchException

updateDocuments

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

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

Throws:

SearchException

updateDocuments

@Deprecated
public static void updateDocuments(String searchEngineId,
                                               long companyId,
                                               Collection<Document> documents,
                                               boolean commitImmediately)
                                        throws SearchException

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

Throws:

SearchException

updatePermissionFields

@Deprecated
public static void updatePermissionFields(String name,
                                                      String primKey)

Deprecated. As of 7.0.0, replaced by IndexWriterHelperUtil.updatePermissionFields(String, String)