lumis.content.search.common
Interface IContentIndexer

All Known Implementing Classes:

ContentIndexer

public interface IContentIndexer

Provides operations on content search indexing.

Since:

4.2.0

Field Summary

static String	FIELDNAME_CONTENT_ID Name of the field used to store the content's identifier in the search index.
static String	SERVICE_INSTANCE_IDS_ATTRIBUTE_NAME The attribute name used to store the service instance identifiers in the transaction, for use when removing the content from the index.

Method Summary

DouiIndexConfig	createDouiIndexConfig(Content content) Creates a default index configuration for the given content.
void	reindexContent(Content content, Collection<String> serviceInstanceIds, DouiIndexConfig douiIndexConfig) Performs the re-indexing of the given content.
void	removeContentFromIndex(Content content, Collection<String> serviceInstanceIds, DouiIndexConfig douiIndexConfig) Removes the given content from the search index.

Field Detail

FIELDNAME_CONTENT_ID

static final String FIELDNAME_CONTENT_ID

Name of the field used to store the content's identifier in the search index.

Since:

4.2.0

See Also:

Constant Field Values

SERVICE_INSTANCE_IDS_ATTRIBUTE_NAME

static final String SERVICE_INSTANCE_IDS_ATTRIBUTE_NAME

The attribute name used to store the service instance identifiers in the transaction, for use when removing the content from the index.

Since:

4.2.0

See Also:

Constant Field Values

Method Detail

createDouiIndexConfig

DouiIndexConfig createDouiIndexConfig(Content content)
                                      throws PortalException

Creates a default index configuration for the given content.

Parameters:

content - the content.

Returns:

the index configuration.

Throws:

PortalException

Since:

4.2.0

removeContentFromIndex

void removeContentFromIndex(Content content,
                            Collection<String> serviceInstanceIds,
                            DouiIndexConfig douiIndexConfig)
                            throws PortalException

Removes the given content from the search index.

Parameters:

content - the content.

serviceInstanceIds - the identifiers of the service instances whose indices the content will be removed from.

douiIndexConfig - indexing configuration.

Throws:

PortalException

Since:

4.2.0

reindexContent

void reindexContent(Content content,
                    Collection<String> serviceInstanceIds,
                    DouiIndexConfig douiIndexConfig)
                    throws PortalException

Performs the re-indexing of the given content.

Parameters:

content - the content.

serviceInstanceIds - the identifiers of the service instances whose indices the content will be removed from.

douiIndexConfig - indexing configuration.

Throws:

PortalException

Since:

4.2.0