com.liferay.portal.kernel.search

Interface IndexWriterHelper

@ProviderType
public interface IndexWriterHelper

Author:

Michael C. Han

Method Summary

Modifier and Type	Method and Description
void	addDocument(String searchEngineId, long companyId, Document document, boolean commitImmediately)
void	addDocuments(String searchEngineId, long companyId, Collection<Document> documents, boolean commitImmediately)
void	commit(String searchEngineId)
void	commit(String searchEngineId, long companyId)
void	deleteDocument(String searchEngineId, long companyId, String uid, boolean commitImmediately)
void	deleteDocuments(String searchEngineId, long companyId, Collection<String> uids, boolean commitImmediately)
void	deleteEntityDocuments(String searchEngineId, long companyId, String className, boolean commitImmediately)
int	getReindexTaskCount(long groupId, boolean completed)
void	indexKeyword(long companyId, String querySuggestion, float weight, String keywordType, Locale locale)
void	indexKeyword(String searchEngineId, long companyId, String querySuggestion, float weight, String keywordType, Locale locale)
void	indexQuerySuggestionDictionaries(long companyId)
void	indexQuerySuggestionDictionaries(String searchEngineId, long companyId)
void	indexQuerySuggestionDictionary(long companyId, Locale locale)
void	indexQuerySuggestionDictionary(String searchEngineId, long companyId, Locale locale)
void	indexSpellCheckerDictionaries(long companyId)
void	indexSpellCheckerDictionaries(String searchEngineId, long companyId)
void	indexSpellCheckerDictionary(long companyId, Locale locale)
void	indexSpellCheckerDictionary(String searchEngineId, long companyId, Locale locale)
boolean	isIndexReadOnly() Deprecated. As of Wilberforce (7.0.x), replaced by isIndexReadOnly
void	partiallyUpdateDocument(String searchEngineId, long companyId, Document document, boolean commitImmediately)
void	partiallyUpdateDocuments(String searchEngineId, long companyId, Collection<Document> documents, boolean commitImmediately)
BackgroundTask	reindex(long userId, String jobName, long[] companyIds, Map<String,Serializable> taskContextMap)
BackgroundTask	reindex(long userId, String jobName, long[] companyIds, String className, Map<String,Serializable> taskContextMap)
void	setIndexReadOnly(boolean indexReadOnly) Deprecated. As of Wilberforce (7.0.x), replaced by setIndexReadOnly(boolean)
void	updateDocument(String searchEngineId, long companyId, Document document, boolean commitImmediately)
void	updateDocuments(String searchEngineId, long companyId, Collection<Document> documents, boolean commitImmediately)
void	updatePermissionFields(String name, String primKey)

Method Detail

addDocument

void addDocument(String searchEngineId,
                 long companyId,
                 Document document,
                 boolean commitImmediately)
          throws SearchException

Throws:

SearchException

addDocuments

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

Throws:

SearchException

commit

void commit(String searchEngineId)
     throws SearchException

Throws:

SearchException

commit

void commit(String searchEngineId,
            long companyId)
     throws SearchException

Throws:

SearchException

deleteDocument

void deleteDocument(String searchEngineId,
                    long companyId,
                    String uid,
                    boolean commitImmediately)
             throws SearchException

Throws:

SearchException

deleteDocuments

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

Throws:

SearchException

deleteEntityDocuments

void deleteEntityDocuments(String searchEngineId,
                           long companyId,
                           String className,
                           boolean commitImmediately)
                    throws SearchException

Throws:

SearchException

getReindexTaskCount

int getReindexTaskCount(long groupId,
                        boolean completed)
                 throws SearchException

Throws:

SearchException

indexKeyword

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

Throws:

SearchException

indexKeyword

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

Throws:

SearchException

indexQuerySuggestionDictionaries

void indexQuerySuggestionDictionaries(long companyId)
                               throws SearchException

Throws:

SearchException

indexQuerySuggestionDictionaries

void indexQuerySuggestionDictionaries(String searchEngineId,
                                      long companyId)
                               throws SearchException

Throws:

SearchException

indexQuerySuggestionDictionary

void indexQuerySuggestionDictionary(long companyId,
                                    Locale locale)
                             throws SearchException

Throws:

SearchException

indexQuerySuggestionDictionary

void indexQuerySuggestionDictionary(String searchEngineId,
                                    long companyId,
                                    Locale locale)
                             throws SearchException

Throws:

SearchException

indexSpellCheckerDictionaries

void indexSpellCheckerDictionaries(long companyId)
                            throws SearchException

Throws:

SearchException

indexSpellCheckerDictionaries

void indexSpellCheckerDictionaries(String searchEngineId,
                                   long companyId)
                            throws SearchException

Throws:

SearchException

indexSpellCheckerDictionary

void indexSpellCheckerDictionary(long companyId,
                                 Locale locale)
                          throws SearchException

Throws:

SearchException

indexSpellCheckerDictionary

void indexSpellCheckerDictionary(String searchEngineId,
                                 long companyId,
                                 Locale locale)
                          throws SearchException

Throws:

SearchException

isIndexReadOnly

@Deprecated
boolean isIndexReadOnly()

Deprecated. As of Wilberforce (7.0.x), replaced by isIndexReadOnly

partiallyUpdateDocument

void partiallyUpdateDocument(String searchEngineId,
                             long companyId,
                             Document document,
                             boolean commitImmediately)
                      throws SearchException

Throws:

SearchException

partiallyUpdateDocuments

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

Throws:

SearchException

reindex

BackgroundTask reindex(long userId,
                       String jobName,
                       long[] companyIds,
                       Map<String,Serializable> taskContextMap)
                throws SearchException

Throws:

SearchException

reindex

BackgroundTask reindex(long userId,
                       String jobName,
                       long[] companyIds,
                       String className,
                       Map<String,Serializable> taskContextMap)
                throws SearchException

Throws:

SearchException

setIndexReadOnly

@Deprecated
void setIndexReadOnly(boolean indexReadOnly)

Deprecated. As of Wilberforce (7.0.x), replaced by setIndexReadOnly(boolean)

updateDocument

void updateDocument(String searchEngineId,
                    long companyId,
                    Document document,
                    boolean commitImmediately)
             throws SearchException

Throws:

SearchException

updateDocuments

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

Throws:

SearchException

updatePermissionFields

void updatePermissionFields(String name,
                            String primKey)