senselogic.sitevision.api.search.index

Interface IndexableContentExtractorBuilder

All Superinterfaces:

Builder<IndexableContentExtractor>

@Requireable(value="IndexableContentExtractorBuilder")
public interface IndexableContentExtractorBuilder
extends Builder<IndexableContentExtractor>

Builder for creating a IndexableContentExtractor instance.

IndexableContentExtractorBuilder has one mandatory attribute and one optional attribute:

• page (mandatory) - The page (sv:page, sv:article, sv:sitePage) that contains indexable content. Must be non-null and page must be published
• indexableUser (optional) - Determines the executing user when extracting indexable content. Default is IndexableUser.CURRENT_USER (i.e. page will be rendered by current user during extraction).

Using the IndexableContentExtractorBuilder is pretty straightforward, if you remember that it is stateful. Conceptually you would typically use it like this:

1. Get the IndexableContentExtractorBuilder
2. Set the page
3. Do build

When you have built a IndexableContentExtractorBuilder instance, you can re-use the IndexableContentExtractorBuilder to build more instances. Typically like:

1. Set the page
2. Do build

Tip! The Builder interface documentation contains more information about Builders and how to work with them and TextModuleRenderer has a code example of how this builder and its result can be used.

An instance of the Sitevision class implementing this interface can be obtained via IndexingUtil.getIndexableContentExtractorBuilder(). See IndexingUtil for how to obtain an instance of the IndexingUtil interface.

Since:

Sitevision 2026.03.1

Author:

Magnus Lövgren

Method Summary

Modifier and Type	Method and Description
IndexableContentExtractor	build() Creates a IndexableContentExtractor instance for the page of this builder.
IndexableContentExtractorBuilder	setIndexableUser(IndexableUser aIndexableUser) Sets whether to extract content as the indexer user or current user.
IndexableContentExtractorBuilder	setPage(Node aPageNode) Sets the page of this builder.

Method Detail

setPage

IndexableContentExtractorBuilder setPage(Node aPageNode)

Sets the page of this builder.

Note! Due to security reasons (potential never-ending loops) it is prohibited to create a content extractor for the currently executing page (i.e. PortletContextUtil.getCurrentPage())!

Parameters:

aPageNode - a published page node (sv:page, sv:article, sv:sitePage) where current user has READ permission, must not be null or "current page".

Returns:

this builder

setIndexableUser

IndexableContentExtractorBuilder setIndexableUser(IndexableUser aIndexableUser)

Sets whether to extract content as the indexer user or current user.

Parameters:

aIndexableUser - the indexable user. Default is IndexableUser.CURRENT_USER.

Returns:

this builder

build

IndexableContentExtractor build()
                         throws IllegalStateException

Creates a IndexableContentExtractor instance for the page of this builder.

Specified by:

build in interface Builder<IndexableContentExtractor>

Returns:

a content renderer instance

Throws:

IllegalStateException - if no page is set or if page is not published or if page is invalid (e.g. "current page") or if current user does not have READ permission on the page.