com.liferay.portal.kernel.search

Class IndexWriterHelperUtil

Object

com.liferay.portal.kernel.search.IndexWriterHelperUtil

public class IndexWriterHelperUtil
extends Object

Author:

Michael C. Han

Constructor Summary

Constructors

Constructor and Description
IndexWriterHelperUtil()

Method Summary

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

Methods inherited from class Object

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

Constructor Detail

IndexWriterHelperUtil

public IndexWriterHelperUtil()

Method Detail

addDocument

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

Throws:

SearchException

addDocuments

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

Throws:

SearchException

commit

public static void commit()
                   throws SearchException

Throws:

SearchException

commit

public static void commit(long companyId)
                   throws SearchException

Throws:

SearchException

deleteDocument

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

Throws:

SearchException

deleteDocuments

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

Throws:

SearchException

deleteEntityDocuments

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

Throws:

SearchException

getReindexTaskCount

public static int getReindexTaskCount(long groupId,
                                      boolean completed)
                               throws SearchException

Throws:

SearchException

indexKeyword

public static void indexKeyword(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

indexQuerySuggestionDictionary

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

Throws:

SearchException

indexSpellCheckerDictionaries

public static void indexSpellCheckerDictionaries(long companyId)
                                          throws SearchException

Throws:

SearchException

indexSpellCheckerDictionary

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

Throws:

SearchException

isIndexReadOnly

@Deprecated
public static boolean isIndexReadOnly()

Deprecated. As of Wilberforce (7.0.x), replaced by com.liferay.portal.search.index.IndexStatusManager#isIndexReadOnly

isIndexReadOnly

@Deprecated
public static boolean isIndexReadOnly(String className)

Deprecated. As of Judson (7.1.x), replaced by com.liferay.portal.search.index.IndexStatusManager#isIndexReadOnly( String)

partiallyUpdateDocument

public static void partiallyUpdateDocument(long companyId,
                                           Document document,
                                           boolean commitImmediately)
                                    throws SearchException

Throws:

SearchException

partiallyUpdateDocuments

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

Throws:

SearchException

reindex

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

Throws:

SearchException

reindex

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

Throws:

SearchException

setIndexReadOnly

@Deprecated
public static void setIndexReadOnly(boolean indexReadOnly)

Deprecated. As of Wilberforce (7.0.x), replaced by com.liferay.portal.search.index.IndexStatusManager#setIndexReadOnly( boolean)

setIndexReadOnly

@Deprecated
public static void setIndexReadOnly(String className,
                                                boolean indexReadOnly)

Deprecated. As of Judson (7.1.x), replaced by com.liferay.portal.search.index.IndexStatusManager#setIndexReadOnly( String, boolean)

updateDocument

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

Throws:

SearchException

updateDocuments

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

Throws:

SearchException

updatePermissionFields

public static void updatePermissionFields(String name,
                                          String primKey)