public class SearchEngineUtil
extends java.lang.Object
| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
GENERIC_ENGINE_ID |
static java.lang.String |
SYSTEM_ENGINE_ID |
| Modifier and Type | Method and Description |
|---|---|
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(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 |
backup(long companyId,
java.lang.String backupName) |
static java.lang.String |
backup(long companyId,
java.lang.String searchEngineId,
java.lang.String backupName) |
static void |
backup(java.lang.String backupName) |
static void |
commit(java.lang.String searchEngineId) |
static void |
commit(java.lang.String searchEngineId,
long companyId) |
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(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 |
deleteEntityDocuments(java.lang.String searchEngineId,
long companyId,
java.lang.String className,
boolean commitImmediately) |
static void |
deletePortletDocuments(java.lang.String searchEngineId,
long companyId,
java.lang.String portletId)
Deprecated.
As of 7.0.0, replaced by
deleteEntityDocuments(String, long, String, boolean) |
static void |
flushQueuedSearchEngine() |
static void |
flushQueuedSearchEngine(java.lang.String searchEngineId) |
static java.lang.String |
getDefaultSearchEngineId() |
static java.lang.String[] |
getEntryClassNames() |
static java.lang.String |
getQueryString(SearchContext searchContext,
Query query) |
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 void |
initialize(long companyId) |
static boolean |
isIndexReadOnly() |
static void |
partiallyUpdateDocument(java.lang.String searchEngineId,
long companyId,
Document document,
boolean commitImmediately) |
static void |
partiallyUpdateDocuments(java.lang.String searchEngineId,
long companyId,
java.util.Collection<Document> documents,
boolean commitImmediately) |
static void |
removeBackup(long companyId,
java.lang.String backupName) |
static void |
removeBackup(java.lang.String backupName) |
static void |
removeCompany(long companyId) |
static SearchEngine |
removeSearchEngine(java.lang.String searchEngineId) |
static void |
restore(long companyId,
java.lang.String backupName) |
static void |
restore(java.lang.String backupName) |
static Hits |
search(SearchContext searchContext,
Query query) |
static Hits |
search(java.lang.String searchEngineId,
long companyId,
Query query,
int start,
int end)
Deprecated.
As of 7.0.0, replaced by
search(SearchContext,
Query) |
static Hits |
search(java.lang.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(java.lang.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) |
protected static void |
setCommitImmediately(SearchContext searchContext,
boolean commitImmediately) |
static void |
setDefaultSearchEngineId(java.lang.String defaultSearchEngineId) |
void |
setExcludedEntryClassNames(java.util.List<java.lang.String> excludedEntryClassNames) |
static void |
setIndexReadOnly(boolean indexReadOnly) |
void |
setQueueCapacity(int queueCapacity) |
static void |
setSearchEngine(java.lang.String searchEngineId,
SearchEngine searchEngine) |
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(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(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) |
public static final java.lang.String GENERIC_ENGINE_ID
public static final java.lang.String SYSTEM_ENGINE_ID
@Deprecated
public static void addDocument(java.lang.String searchEngineId,
long companyId,
Document document)
throws SearchException
addDocument(String, long,
Document, boolean)SearchExceptionpublic static void addDocument(java.lang.String searchEngineId,
long companyId,
Document document,
boolean commitImmediately)
throws SearchException
SearchException@Deprecated
public static void addDocuments(java.lang.String searchEngineId,
long companyId,
java.util.Collection<Document> documents)
throws SearchException
addDocuments(String, long,
Collection, boolean)SearchExceptionpublic static void addDocuments(java.lang.String searchEngineId,
long companyId,
java.util.Collection<Document> documents,
boolean commitImmediately)
throws SearchException
SearchExceptionpublic static void backup(long companyId,
java.lang.String backupName)
throws SearchException
SearchExceptionpublic static java.lang.String backup(long companyId,
java.lang.String searchEngineId,
java.lang.String backupName)
throws SearchException
SearchExceptionpublic static void backup(java.lang.String backupName)
throws SearchException
SearchExceptionpublic static void commit(java.lang.String searchEngineId)
throws SearchException
SearchExceptionpublic static void commit(java.lang.String searchEngineId,
long companyId)
throws SearchException
SearchException@Deprecated
public static void deleteDocument(java.lang.String searchEngineId,
long companyId,
java.lang.String uid)
throws SearchException
deleteDocument(String, long,
String, boolean)SearchExceptionpublic static void deleteDocument(java.lang.String searchEngineId,
long companyId,
java.lang.String uid,
boolean commitImmediately)
throws SearchException
SearchException@Deprecated
public static void deleteDocuments(java.lang.String searchEngineId,
long companyId,
java.util.Collection<java.lang.String> uids)
throws SearchException
deleteDocuments(String,
long, Collection, boolean)SearchExceptionpublic static void deleteDocuments(java.lang.String searchEngineId,
long companyId,
java.util.Collection<java.lang.String> uids,
boolean commitImmediately)
throws SearchException
SearchExceptionpublic static void deleteEntityDocuments(java.lang.String searchEngineId,
long companyId,
java.lang.String className,
boolean commitImmediately)
throws SearchException
SearchException@Deprecated
public static void deletePortletDocuments(java.lang.String searchEngineId,
long companyId,
java.lang.String portletId)
throws SearchException
deleteEntityDocuments(String, long, String, boolean)SearchExceptionpublic static void flushQueuedSearchEngine()
public static void flushQueuedSearchEngine(java.lang.String searchEngineId)
public static java.lang.String getDefaultSearchEngineId()
public static java.lang.String[] getEntryClassNames()
public static java.lang.String getQueryString(SearchContext searchContext, Query query)
public static SearchEngine getSearchEngine(java.lang.String searchEngineId)
public static java.lang.String getSearchEngineId(java.util.Collection<Document> documents)
public static java.lang.String getSearchEngineId(Document document)
public static java.util.Set<java.lang.String> getSearchEngineIds()
public static SearchEngine getSearchEngineSilent(java.lang.String searchEngineId)
public static SearchPermissionChecker getSearchPermissionChecker()
public static java.lang.String getSearchReaderDestinationName(java.lang.String searchEngineId)
public static java.lang.String getSearchWriterDestinationName(java.lang.String searchEngineId)
public static void indexKeyword(long companyId,
java.lang.String querySuggestion,
float weight,
java.lang.String keywordType,
java.util.Locale locale)
throws SearchException
SearchExceptionpublic 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
SearchExceptionpublic static void indexQuerySuggestionDictionaries(long companyId)
throws SearchException
SearchExceptionpublic static void indexQuerySuggestionDictionaries(java.lang.String searchEngineId,
long companyId)
throws SearchException
SearchExceptionpublic static void indexQuerySuggestionDictionary(long companyId,
java.util.Locale locale)
throws SearchException
SearchExceptionpublic static void indexQuerySuggestionDictionary(java.lang.String searchEngineId,
long companyId,
java.util.Locale locale)
throws SearchException
SearchExceptionpublic static void indexSpellCheckerDictionaries(long companyId)
throws SearchException
SearchExceptionpublic static void indexSpellCheckerDictionaries(java.lang.String searchEngineId,
long companyId)
throws SearchException
SearchExceptionpublic static void indexSpellCheckerDictionary(long companyId,
java.util.Locale locale)
throws SearchException
SearchExceptionpublic static void indexSpellCheckerDictionary(java.lang.String searchEngineId,
long companyId,
java.util.Locale locale)
throws SearchException
SearchExceptionpublic static void initialize(long companyId)
public static boolean isIndexReadOnly()
public static void partiallyUpdateDocument(java.lang.String searchEngineId,
long companyId,
Document document,
boolean commitImmediately)
throws SearchException
SearchExceptionpublic static void partiallyUpdateDocuments(java.lang.String searchEngineId,
long companyId,
java.util.Collection<Document> documents,
boolean commitImmediately)
throws SearchException
SearchExceptionpublic static void removeBackup(long companyId,
java.lang.String backupName)
throws SearchException
SearchExceptionpublic static void removeBackup(java.lang.String backupName)
throws SearchException
SearchExceptionpublic static void removeCompany(long companyId)
public static SearchEngine removeSearchEngine(java.lang.String searchEngineId)
public static void restore(long companyId,
java.lang.String backupName)
throws SearchException
SearchExceptionpublic static void restore(java.lang.String backupName)
throws SearchException
SearchExceptionpublic static Hits search(SearchContext searchContext, Query query) throws SearchException
SearchException@Deprecated public static Hits search(java.lang.String searchEngineId, long companyId, Query query, int start, int end) throws SearchException
search(SearchContext,
Query)SearchException@Deprecated public static Hits search(java.lang.String searchEngineId, long companyId, Query query, Sort sort, int start, int end) throws SearchException
search(SearchContext,
Query)SearchException@Deprecated public static Hits search(java.lang.String searchEngineId, long companyId, Query query, Sort[] sorts, int start, int end) throws SearchException
search(SearchContext,
Query)SearchExceptionpublic static long searchCount(SearchContext searchContext, Query query) throws SearchException
SearchExceptionpublic static void setDefaultSearchEngineId(java.lang.String defaultSearchEngineId)
public static void setIndexReadOnly(boolean indexReadOnly)
public static void setSearchEngine(java.lang.String searchEngineId,
SearchEngine searchEngine)
public static java.lang.String spellCheckKeywords(SearchContext searchContext) throws SearchException
SearchExceptionpublic static java.util.Map<java.lang.String,java.util.List<java.lang.String>> spellCheckKeywords(SearchContext searchContext, int max) throws SearchException
SearchExceptionpublic static java.lang.String[] suggestKeywordQueries(SearchContext searchContext, int max) throws SearchException
SearchException@Deprecated
public static void updateDocument(java.lang.String searchEngineId,
long companyId,
Document document)
throws SearchException
updateDocument(String, long,
Document, boolean)SearchExceptionpublic static void updateDocument(java.lang.String searchEngineId,
long companyId,
Document document,
boolean commitImmediately)
throws SearchException
SearchException@Deprecated
public static void updateDocuments(java.lang.String searchEngineId,
long companyId,
java.util.Collection<Document> documents)
throws SearchException
updateDocuments(String,
long, Collection, boolean)SearchExceptionpublic static void updateDocuments(java.lang.String searchEngineId,
long companyId,
java.util.Collection<Document> documents,
boolean commitImmediately)
throws SearchException
SearchExceptionpublic static void updatePermissionFields(java.lang.String name,
java.lang.String primKey)
public void setExcludedEntryClassNames(java.util.List<java.lang.String> excludedEntryClassNames)
public void setQueueCapacity(int queueCapacity)
protected static void setCommitImmediately(SearchContext searchContext, boolean commitImmediately)