org.apache.jackrabbit.oak.plugins.index.lucene.spi

Interface IndexFieldProvider

public interface IndexFieldProvider

Implementations of this interface would get callbacks while indexing documents. It's the responsibility of the implementation to exit as early as possible if it doesn't care about the document being indexed.

Field Summary

Fields

Modifier and Type	Field and Description
static IndexFieldProvider	DEFAULT Implementation which doesn't do anything useful...

Method Summary

Modifier and Type	Method and Description
@NotNull java.lang.Iterable<org.apache.lucene.document.Field>	getAugmentedFields(java.lang.String path, NodeState document, NodeState indexDefinition) This method would get called while indexing a document.
@NotNull java.util.Set<java.lang.String>	getSupportedTypes() This method is used to find which node types are supported by the implementation.

Field Detail

DEFAULT

static final IndexFieldProvider DEFAULT

Implementation which doesn't do anything useful... yet, abides with the contract.

Method Detail

getAugmentedFields

@NotNull
@NotNull java.lang.Iterable<org.apache.lucene.document.Field> getAugmentedFields(java.lang.String path,
                                                                                          NodeState document,
                                                                                          NodeState indexDefinition)

This method would get called while indexing a document.

Parameters:

path - path of the document being indexed

document - NodeState of the document being indexed

indexDefinition - NodeState of index definition

Returns:

Iterable of fields that are to be added to Document being prepared

getSupportedTypes

@NotNull
@NotNull java.util.Set<java.lang.String> getSupportedTypes()

This method is used to find which node types are supported by the implementation. Based, on the index definition being used to index the document, only those implementations would get callback to getAugmentedFields(java.lang.String, org.apache.jackrabbit.oak.spi.state.NodeState, org.apache.jackrabbit.oak.spi.state.NodeState) which declare a matching node type. Note, node types are exact matches and do not support inheritance.

Returns:

Set of types supported by the implementation