org.imixs.workflow.engine.index

Class IndexEvent

java.lang.Object

org.imixs.workflow.engine.index.IndexEvent

public class IndexEvent
extends Object

The IndexEvent provides a CDI event fired immediately before a document is indexed by the search service implementation.

An observer CDI bean can change or extend the text content to be indexed. The IndexEvent defines only one event type:

• ON_INDEX_UPDATE - is send immediately before a document will be indexed

The property 'textContent' can be updated or extended by a client.

Version:

1.0

Author:

Ralph Soika

Field Summary

Fields

Modifier and Type	Field and Description
static int	ON_INDEX_UPDATE

Constructor Summary

Constructors

Constructor and Description
IndexEvent(int eventType, ItemCollection document)

Method Summary

Modifier and Type	Method and Description
ItemCollection	getDocument() Returns the document to be indexed
int	getEventType()
String	getTextContent() Returns the textContent for the given document to be indexed.
void	setTextContent(String textContent) Update the textContent for the given document to be indexed.

Methods inherited from class java.lang.Object

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

Field Detail

ON_INDEX_UPDATE

public static final int ON_INDEX_UPDATE

See Also:

Constant Field Values

Constructor Detail

IndexEvent

public IndexEvent(int eventType,
                  ItemCollection document)

Method Detail

getTextContent

public String getTextContent()

Returns the textContent for the given document to be indexed.

Returns:

setTextContent

public void setTextContent(String textContent)

Update the textContent for the given document to be indexed.

getEventType

public int getEventType()

getDocument

public ItemCollection getDocument()

Returns the document to be indexed

Returns: