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

Class LuceneDocumentMaker

java.lang.Object

org.apache.jackrabbit.oak.plugins.index.search.spi.editor.FulltextDocumentMaker<org.apache.lucene.document.Document>

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

All Implemented Interfaces:

org.apache.jackrabbit.oak.plugins.index.search.spi.editor.DocumentMaker<org.apache.lucene.document.Document>

public class LuceneDocumentMaker
extends org.apache.jackrabbit.oak.plugins.index.search.spi.editor.FulltextDocumentMaker<org.apache.lucene.document.Document>

Field Summary

Fields inherited from class org.apache.jackrabbit.oak.plugins.index.search.spi.editor.FulltextDocumentMaker

definition, indexingRule, path

Constructor Summary

Constructors

Constructor and Description
LuceneDocumentMaker(@Nullable org.apache.jackrabbit.oak.plugins.index.search.spi.binary.FulltextBinaryTextExtractor textExtractor, @Nullable FacetsConfigProvider facetsConfigProvider, @Nullable IndexAugmentorFactory augmentorFactory, org.apache.jackrabbit.oak.plugins.index.search.IndexDefinition definition, org.apache.jackrabbit.oak.plugins.index.search.IndexDefinition.IndexingRule indexingRule, String path)
LuceneDocumentMaker(org.apache.jackrabbit.oak.plugins.index.search.IndexDefinition definition, org.apache.jackrabbit.oak.plugins.index.search.IndexDefinition.IndexingRule indexingRule, String path)

Method Summary

Modifier and Type	Method and Description
protected boolean	addBinary(org.apache.lucene.document.Document doc, String path, List<String> binaryValues)
protected boolean	augmentCustomFields(String path, org.apache.lucene.document.Document doc, org.apache.jackrabbit.oak.spi.state.NodeState document)
protected org.apache.lucene.document.Document	finalizeDoc(org.apache.lucene.document.Document doc, boolean dirty, boolean facet)
protected void	indexAggregateValue(org.apache.lucene.document.Document doc, org.apache.jackrabbit.oak.plugins.index.search.Aggregate.NodeIncludeResult result, String value, org.apache.jackrabbit.oak.plugins.index.search.PropertyDefinition pd)
protected void	indexAnalyzedProperty(org.apache.lucene.document.Document doc, String pname, String value, org.apache.jackrabbit.oak.plugins.index.search.PropertyDefinition pd)
protected void	indexAncestors(org.apache.lucene.document.Document doc, String path)
protected boolean	indexFacetProperty(org.apache.lucene.document.Document doc, int tag, org.apache.jackrabbit.oak.api.PropertyState property, String pname)
protected void	indexFulltextValue(org.apache.lucene.document.Document doc, String value)
protected void	indexNodeName(org.apache.lucene.document.Document doc, String value)
protected void	indexNotNullProperty(org.apache.lucene.document.Document doc, org.apache.jackrabbit.oak.plugins.index.search.PropertyDefinition pd)
protected void	indexNullProperty(org.apache.lucene.document.Document doc, org.apache.jackrabbit.oak.plugins.index.search.PropertyDefinition pd)
protected void	indexSimilarityBinaries(org.apache.lucene.document.Document doc, org.apache.jackrabbit.oak.plugins.index.search.PropertyDefinition pd, org.apache.jackrabbit.oak.api.Blob blob)
protected void	indexSimilarityStrings(org.apache.lucene.document.Document doc, org.apache.jackrabbit.oak.plugins.index.search.PropertyDefinition pd, String value)
protected void	indexSpellcheckValue(org.apache.lucene.document.Document doc, String value)
protected void	indexSuggestValue(org.apache.lucene.document.Document doc, String value)
protected boolean	indexTypedProperty(org.apache.lucene.document.Document doc, org.apache.jackrabbit.oak.api.PropertyState property, String pname, org.apache.jackrabbit.oak.plugins.index.search.PropertyDefinition pd)
protected boolean	indexTypeOrderedFields(org.apache.lucene.document.Document doc, String pname, int tag, org.apache.jackrabbit.oak.api.PropertyState property, org.apache.jackrabbit.oak.plugins.index.search.PropertyDefinition pd)
protected org.apache.lucene.document.Document	initDoc()
protected boolean	isFacetingEnabled()

Methods inherited from class org.apache.jackrabbit.oak.plugins.index.search.spi.editor.FulltextDocumentMaker

getIndexName, includePropertyValue, includePropertyValue, makeDocument, makeDocument

Methods inherited from class java.lang.Object

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

Constructor Detail

LuceneDocumentMaker

public LuceneDocumentMaker(org.apache.jackrabbit.oak.plugins.index.search.IndexDefinition definition,
                           org.apache.jackrabbit.oak.plugins.index.search.IndexDefinition.IndexingRule indexingRule,
                           String path)

LuceneDocumentMaker

public LuceneDocumentMaker(@Nullable
                           @Nullable org.apache.jackrabbit.oak.plugins.index.search.spi.binary.FulltextBinaryTextExtractor textExtractor,
                           @Nullable
                           @Nullable FacetsConfigProvider facetsConfigProvider,
                           @Nullable
                           @Nullable IndexAugmentorFactory augmentorFactory,
                           org.apache.jackrabbit.oak.plugins.index.search.IndexDefinition definition,
                           org.apache.jackrabbit.oak.plugins.index.search.IndexDefinition.IndexingRule indexingRule,
                           String path)

Method Detail

indexAnalyzedProperty

protected void indexAnalyzedProperty(org.apache.lucene.document.Document doc,
                                     String pname,
                                     String value,
                                     org.apache.jackrabbit.oak.plugins.index.search.PropertyDefinition pd)

Specified by:

indexAnalyzedProperty in class org.apache.jackrabbit.oak.plugins.index.search.spi.editor.FulltextDocumentMaker<org.apache.lucene.document.Document>

indexSuggestValue

protected void indexSuggestValue(org.apache.lucene.document.Document doc,
                                 String value)

Specified by:

indexSuggestValue in class org.apache.jackrabbit.oak.plugins.index.search.spi.editor.FulltextDocumentMaker<org.apache.lucene.document.Document>

indexSpellcheckValue

protected void indexSpellcheckValue(org.apache.lucene.document.Document doc,
                                    String value)

Specified by:

indexSpellcheckValue in class org.apache.jackrabbit.oak.plugins.index.search.spi.editor.FulltextDocumentMaker<org.apache.lucene.document.Document>

indexFulltextValue

protected void indexFulltextValue(org.apache.lucene.document.Document doc,
                                  String value)

Specified by:

indexFulltextValue in class org.apache.jackrabbit.oak.plugins.index.search.spi.editor.FulltextDocumentMaker<org.apache.lucene.document.Document>

indexAncestors

protected void indexAncestors(org.apache.lucene.document.Document doc,
                              String path)

Specified by:

indexAncestors in class org.apache.jackrabbit.oak.plugins.index.search.spi.editor.FulltextDocumentMaker<org.apache.lucene.document.Document>

indexTypedProperty

protected boolean indexTypedProperty(org.apache.lucene.document.Document doc,
                                     org.apache.jackrabbit.oak.api.PropertyState property,
                                     String pname,
                                     org.apache.jackrabbit.oak.plugins.index.search.PropertyDefinition pd)

Specified by:

indexTypedProperty in class org.apache.jackrabbit.oak.plugins.index.search.spi.editor.FulltextDocumentMaker<org.apache.lucene.document.Document>

indexNotNullProperty

protected void indexNotNullProperty(org.apache.lucene.document.Document doc,
                                    org.apache.jackrabbit.oak.plugins.index.search.PropertyDefinition pd)

Specified by:

indexNotNullProperty in class org.apache.jackrabbit.oak.plugins.index.search.spi.editor.FulltextDocumentMaker<org.apache.lucene.document.Document>

indexNullProperty

protected void indexNullProperty(org.apache.lucene.document.Document doc,
                                 org.apache.jackrabbit.oak.plugins.index.search.PropertyDefinition pd)

Specified by:

indexNullProperty in class org.apache.jackrabbit.oak.plugins.index.search.spi.editor.FulltextDocumentMaker<org.apache.lucene.document.Document>

addBinary

protected boolean addBinary(org.apache.lucene.document.Document doc,
                            String path,
                            List<String> binaryValues)

Specified by:

addBinary in class org.apache.jackrabbit.oak.plugins.index.search.spi.editor.FulltextDocumentMaker<org.apache.lucene.document.Document>

indexFacetProperty

protected boolean indexFacetProperty(org.apache.lucene.document.Document doc,
                                     int tag,
                                     org.apache.jackrabbit.oak.api.PropertyState property,
                                     String pname)

Specified by:

indexFacetProperty in class org.apache.jackrabbit.oak.plugins.index.search.spi.editor.FulltextDocumentMaker<org.apache.lucene.document.Document>

indexAggregateValue

protected void indexAggregateValue(org.apache.lucene.document.Document doc,
                                   org.apache.jackrabbit.oak.plugins.index.search.Aggregate.NodeIncludeResult result,
                                   String value,
                                   org.apache.jackrabbit.oak.plugins.index.search.PropertyDefinition pd)

Specified by:

indexAggregateValue in class org.apache.jackrabbit.oak.plugins.index.search.spi.editor.FulltextDocumentMaker<org.apache.lucene.document.Document>

initDoc

protected org.apache.lucene.document.Document initDoc()

Specified by:

initDoc in class org.apache.jackrabbit.oak.plugins.index.search.spi.editor.FulltextDocumentMaker<org.apache.lucene.document.Document>

augmentCustomFields

protected boolean augmentCustomFields(String path,
                                      org.apache.lucene.document.Document doc,
                                      org.apache.jackrabbit.oak.spi.state.NodeState document)

Specified by:

augmentCustomFields in class org.apache.jackrabbit.oak.plugins.index.search.spi.editor.FulltextDocumentMaker<org.apache.lucene.document.Document>

finalizeDoc

protected org.apache.lucene.document.Document finalizeDoc(org.apache.lucene.document.Document doc,
                                                          boolean dirty,
                                                          boolean facet)
                                                   throws IOException

Specified by:

finalizeDoc in class org.apache.jackrabbit.oak.plugins.index.search.spi.editor.FulltextDocumentMaker<org.apache.lucene.document.Document>

Throws:

IOException

isFacetingEnabled

protected boolean isFacetingEnabled()

Specified by:

isFacetingEnabled in class org.apache.jackrabbit.oak.plugins.index.search.spi.editor.FulltextDocumentMaker<org.apache.lucene.document.Document>

indexTypeOrderedFields

protected boolean indexTypeOrderedFields(org.apache.lucene.document.Document doc,
                                         String pname,
                                         int tag,
                                         org.apache.jackrabbit.oak.api.PropertyState property,
                                         org.apache.jackrabbit.oak.plugins.index.search.PropertyDefinition pd)

Specified by:

indexTypeOrderedFields in class org.apache.jackrabbit.oak.plugins.index.search.spi.editor.FulltextDocumentMaker<org.apache.lucene.document.Document>

indexNodeName

protected void indexNodeName(org.apache.lucene.document.Document doc,
                             String value)

Specified by:

indexNodeName in class org.apache.jackrabbit.oak.plugins.index.search.spi.editor.FulltextDocumentMaker<org.apache.lucene.document.Document>

indexSimilarityStrings

protected void indexSimilarityStrings(org.apache.lucene.document.Document doc,
                                      org.apache.jackrabbit.oak.plugins.index.search.PropertyDefinition pd,
                                      String value)
                               throws IOException

Specified by:

indexSimilarityStrings in class org.apache.jackrabbit.oak.plugins.index.search.spi.editor.FulltextDocumentMaker<org.apache.lucene.document.Document>

Throws:

IOException

indexSimilarityBinaries

protected void indexSimilarityBinaries(org.apache.lucene.document.Document doc,
                                       org.apache.jackrabbit.oak.plugins.index.search.PropertyDefinition pd,
                                       org.apache.jackrabbit.oak.api.Blob blob)
                                throws IOException

Specified by:

indexSimilarityBinaries in class org.apache.jackrabbit.oak.plugins.index.search.spi.editor.FulltextDocumentMaker<org.apache.lucene.document.Document>

Throws:

IOException