Liferay 7.0-ce-m6

com.liferay.portal.kernel.search
Class SearchEngineUtil

java.lang.Object
  extended by com.liferay.portal.kernel.search.SearchEngineUtil

public class SearchEngineUtil
extends Object


Field Summary
static String GENERIC_ENGINE_ID
           
static String SYSTEM_ENGINE_ID
           
 
Method Summary
static void addDocument(String searchEngineId, long companyId, Document document)
          Deprecated. As of 7.0.0, replaced by addDocument(String, long, Document, boolean)
static void addDocument(String searchEngineId, long companyId, Document document, boolean commitImmediately)
           
static void addDocuments(String searchEngineId, long companyId, Collection<Document> documents)
          Deprecated. As of 7.0.0, replaced by addDocuments(String, long, Collection, boolean)
static void addDocuments(String searchEngineId, long companyId, Collection<Document> documents, boolean commitImmediately)
           
static void backup(long companyId, String backupName)
           
static String backup(long companyId, String searchEngineId, String backupName)
           
static void backup(String backupName)
           
static void deleteDocument(String searchEngineId, long companyId, String uid)
          Deprecated. As of 7.0.0, replaced by deleteDocument(String, long, String, boolean)
static void deleteDocument(String searchEngineId, long companyId, String uid, boolean commitImmediately)
           
static void deleteDocuments(String searchEngineId, long companyId, Collection<String> uids)
          Deprecated. As of 7.0.0, replaced by deleteDocuments(String, long, Collection, boolean)
static void deleteDocuments(String searchEngineId, long companyId, Collection<String> uids, boolean commitImmediately)
           
static void deleteEntityDocuments(String searchEngineId, long companyId, String className, boolean commitImmediately)
           
static void deletePortletDocuments(String searchEngineId, long companyId, String portletId)
          Deprecated. As of 7.0.0, replaced by deleteEntityDocuments(String, long, String, boolean)
static String getDefaultSearchEngineId()
           
static String[] getEntryClassNames()
           
static String getQueryString(SearchContext searchContext, Query query)
           
static SearchEngine getSearchEngine(String searchEngineId)
           
static String getSearchEngineId(Collection<Document> documents)
           
static String getSearchEngineId(Document document)
           
static Set<String> getSearchEngineIds()
           
static SearchEngine getSearchEngineSilent(String searchEngineId)
           
static SearchPermissionChecker getSearchPermissionChecker()
           
static String getSearchReaderDestinationName(String searchEngineId)
           
static String getSearchWriterDestinationName(String searchEngineId)
           
static void indexKeyword(long companyId, String querySuggestion, float weight, String keywordType, Locale locale)
           
static void indexKeyword(String searchEngineId, long companyId, String querySuggestion, float weight, String keywordType, Locale locale)
           
static void indexQuerySuggestionDictionaries(long companyId)
           
static void indexQuerySuggestionDictionaries(String searchEngineId, long companyId)
           
static void indexQuerySuggestionDictionary(long companyId, Locale locale)
           
static void indexQuerySuggestionDictionary(String searchEngineId, long companyId, Locale locale)
           
static void indexSpellCheckerDictionaries(long companyId)
           
static void indexSpellCheckerDictionaries(String searchEngineId, long companyId)
           
static void indexSpellCheckerDictionary(long companyId, Locale locale)
           
static void indexSpellCheckerDictionary(String searchEngineId, long companyId, Locale locale)
           
static void initialize(long companyId)
           
static boolean isIndexReadOnly()
           
static void partiallyUpdateDocument(String searchEngineId, long companyId, Document document, boolean commitImmediately)
           
static void partiallyUpdateDocuments(String searchEngineId, long companyId, Collection<Document> documents, boolean commitImmediately)
           
static void removeBackup(long companyId, String backupName)
           
static void removeBackup(String backupName)
           
static void removeCompany(long companyId)
           
static SearchEngine removeSearchEngine(String searchEngineId)
           
static void restore(long companyId, String backupName)
           
static void restore(String backupName)
           
static Hits search(SearchContext searchContext, Query query)
           
static Hits search(String searchEngineId, long companyId, Query query, int start, int end)
          Deprecated. As of 7.0.0, replaced by 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 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 search(SearchContext, Query)
static long searchCount(SearchContext searchContext, Query query)
           
static void setDefaultSearchEngineId(String defaultSearchEngineId)
           
 void setExcludedEntryClassNames(List<String> excludedEntryClassNames)
           
static void setIndexReadOnly(boolean indexReadOnly)
           
static void setSearchEngine(String searchEngineId, SearchEngine searchEngine)
           
 void setSearchPermissionChecker(SearchPermissionChecker searchPermissionChecker)
           
static String spellCheckKeywords(SearchContext searchContext)
           
static Map<String,List<String>> spellCheckKeywords(SearchContext searchContext, int max)
           
static String[] suggestKeywordQueries(SearchContext searchContext, int max)
           
static void updateDocument(String searchEngineId, long companyId, Document document)
          Deprecated. As of 7.0.0, replaced by updateDocument(String, long, Document, boolean)
static void updateDocument(String searchEngineId, long companyId, Document document, boolean commitImmediately)
           
static void updateDocuments(String searchEngineId, long companyId, Collection<Document> documents)
          Deprecated. As of 7.0.0, replaced by updateDocuments(String, long, Collection, boolean)
static void updateDocuments(String searchEngineId, long companyId, Collection<Document> documents, boolean commitImmediately)
           
static void updatePermissionFields(String name, String primKey)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

GENERIC_ENGINE_ID

public static final String GENERIC_ENGINE_ID
See Also:
Constant Field Values

SYSTEM_ENGINE_ID

public static final String SYSTEM_ENGINE_ID
See Also:
Constant Field Values
Method Detail

addDocument

@Deprecated
public static void addDocument(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(String searchEngineId,
                               long companyId,
                               Document document,
                               boolean commitImmediately)
                        throws SearchException
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 addDocuments(String, long, Collection, boolean)

Throws:
SearchException

addDocuments

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

backup

public static void backup(long companyId,
                          String backupName)
                   throws SearchException
Throws:
SearchException

backup

public static String backup(long companyId,
                            String searchEngineId,
                            String backupName)
                     throws SearchException
Throws:
SearchException

backup

public static void backup(String backupName)
                   throws SearchException
Throws:
SearchException

deleteDocument

@Deprecated
public static void deleteDocument(String searchEngineId,
                                             long companyId,
                                             String uid)
                           throws SearchException
Deprecated. As of 7.0.0, replaced by deleteDocument(String, long, String, boolean)

Throws:
SearchException

deleteDocument

public static void deleteDocument(String searchEngineId,
                                  long companyId,
                                  String uid,
                                  boolean commitImmediately)
                           throws SearchException
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 deleteDocuments(String, long, Collection, boolean)

Throws:
SearchException

deleteDocuments

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

deleteEntityDocuments

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

deletePortletDocuments

@Deprecated
public static void deletePortletDocuments(String searchEngineId,
                                                     long companyId,
                                                     String portletId)
                                   throws SearchException
Deprecated. As of 7.0.0, replaced by deleteEntityDocuments(String, long, String, boolean)

Throws:
SearchException

getDefaultSearchEngineId

public static String getDefaultSearchEngineId()

getEntryClassNames

public static String[] getEntryClassNames()

getQueryString

public static String getQueryString(SearchContext searchContext,
                                    Query query)

getSearchEngine

public static SearchEngine getSearchEngine(String searchEngineId)

getSearchEngineId

public static String getSearchEngineId(Collection<Document> documents)

getSearchEngineId

public static String getSearchEngineId(Document document)

getSearchEngineIds

public static Set<String> getSearchEngineIds()

getSearchEngineSilent

public static SearchEngine getSearchEngineSilent(String searchEngineId)

getSearchPermissionChecker

public static SearchPermissionChecker getSearchPermissionChecker()

getSearchReaderDestinationName

public static String getSearchReaderDestinationName(String searchEngineId)

getSearchWriterDestinationName

public static String getSearchWriterDestinationName(String searchEngineId)

indexKeyword

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

indexKeyword

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

indexQuerySuggestionDictionaries

public static void indexQuerySuggestionDictionaries(long companyId)
                                             throws SearchException
Throws:
SearchException

indexQuerySuggestionDictionaries

public static void indexQuerySuggestionDictionaries(String searchEngineId,
                                                    long companyId)
                                             throws SearchException
Throws:
SearchException

indexQuerySuggestionDictionary

public static void indexQuerySuggestionDictionary(long companyId,
                                                  Locale locale)
                                           throws SearchException
Throws:
SearchException

indexQuerySuggestionDictionary

public static void indexQuerySuggestionDictionary(String searchEngineId,
                                                  long companyId,
                                                  Locale locale)
                                           throws SearchException
Throws:
SearchException

indexSpellCheckerDictionaries

public static void indexSpellCheckerDictionaries(long companyId)
                                          throws SearchException
Throws:
SearchException

indexSpellCheckerDictionaries

public static void indexSpellCheckerDictionaries(String searchEngineId,
                                                 long companyId)
                                          throws SearchException
Throws:
SearchException

indexSpellCheckerDictionary

public static void indexSpellCheckerDictionary(long companyId,
                                               Locale locale)
                                        throws SearchException
Throws:
SearchException

indexSpellCheckerDictionary

public static void indexSpellCheckerDictionary(String searchEngineId,
                                               long companyId,
                                               Locale locale)
                                        throws SearchException
Throws:
SearchException

initialize

public static void initialize(long companyId)

isIndexReadOnly

public static boolean isIndexReadOnly()

partiallyUpdateDocument

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

partiallyUpdateDocuments

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

removeBackup

public static void removeBackup(long companyId,
                                String backupName)
                         throws SearchException
Throws:
SearchException

removeBackup

public static void removeBackup(String backupName)
                         throws SearchException
Throws:
SearchException

removeCompany

public static void removeCompany(long companyId)

removeSearchEngine

public static SearchEngine removeSearchEngine(String searchEngineId)

restore

public static void restore(long companyId,
                           String backupName)
                    throws SearchException
Throws:
SearchException

restore

public static void restore(String backupName)
                    throws SearchException
Throws:
SearchException

search

public static Hits search(SearchContext searchContext,
                          Query query)
                   throws SearchException
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 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 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 search(SearchContext, Query)

Throws:
SearchException

searchCount

public static long searchCount(SearchContext searchContext,
                               Query query)
                        throws SearchException
Throws:
SearchException

setDefaultSearchEngineId

public static void setDefaultSearchEngineId(String defaultSearchEngineId)

setIndexReadOnly

public static void setIndexReadOnly(boolean indexReadOnly)

setSearchEngine

public static void setSearchEngine(String searchEngineId,
                                   SearchEngine searchEngine)

spellCheckKeywords

public static String spellCheckKeywords(SearchContext searchContext)
                                 throws SearchException
Throws:
SearchException

spellCheckKeywords

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

suggestKeywordQueries

public static String[] suggestKeywordQueries(SearchContext searchContext,
                                             int max)
                                      throws SearchException
Throws:
SearchException

updateDocument

@Deprecated
public static void updateDocument(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(String searchEngineId,
                                  long companyId,
                                  Document document,
                                  boolean commitImmediately)
                           throws SearchException
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 updateDocuments(String, long, Collection, boolean)

Throws:
SearchException

updateDocuments

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

updatePermissionFields

public static void updatePermissionFields(String name,
                                          String primKey)

setExcludedEntryClassNames

public void setExcludedEntryClassNames(List<String> excludedEntryClassNames)

setSearchPermissionChecker

public void setSearchPermissionChecker(SearchPermissionChecker searchPermissionChecker)

Liferay 7.0-ce-m6