org.apache.jackrabbit.core.query.lucene
Class NodeIndexer

java.lang.Object
  org.apache.jackrabbit.core.query.lucene.NodeIndexer

public class NodeIndexer
extends Object

Creates a lucene Document object from a Node.

Field Summary

protected static float	DEFAULT_BOOST The default boost for a lucene field: 1.0f.
protected TextExtractor	extractor Content extractor.
protected IndexFormatVersion	indexFormatVersion Indicates index format for this node indexer.
protected IndexingConfiguration	indexingConfig The indexing configuration or null if none is available.
protected NamespaceMappings	mappings Namespace mappings to use for indexing.
protected NodeState	node The NodeState of the node to index
protected NamePathResolver	resolver Name and Path resolver.
protected ItemStateManager	stateProvider The persistent item state provider
protected boolean	supportHighlighting If set to true the fulltext field is stored and and a term vector is created with offset information.

Constructor Summary

NodeIndexer(NodeState node, ItemStateManager stateProvider, NamespaceMappings mappings, TextExtractor extractor)
Creates a new node indexer.

Method Summary

protected void	addBinaryValue(org.apache.lucene.document.Document doc, String fieldName, Object internalValue) Adds the binary value to the document as the named field.
protected void	addBooleanValue(org.apache.lucene.document.Document doc, String fieldName, Object internalValue) Adds the string representation of the boolean value to the document as the named field.
protected void	addCalendarValue(org.apache.lucene.document.Document doc, String fieldName, Object internalValue) Adds the calendar value to the document as the named field.
protected void	addDoubleValue(org.apache.lucene.document.Document doc, String fieldName, Object internalValue) Adds the double value to the document as the named field.
protected void	addLongValue(org.apache.lucene.document.Document doc, String fieldName, Object internalValue) Adds the long value to the document as the named field.
protected void	addNameValue(org.apache.lucene.document.Document doc, String fieldName, Object internalValue) Adds the name value to the document as the named field.
protected void	addPathValue(org.apache.lucene.document.Document doc, String fieldName, Object internalValue) Adds the path value to the document as the named field.
protected void	addReferenceValue(org.apache.lucene.document.Document doc, String fieldName, Object internalValue) Adds the reference value to the document as the named field.
protected void	addStringValue(org.apache.lucene.document.Document doc, String fieldName, Object internalValue) Deprecated. Use addStringValue(Document, String, Object, boolean) instead.
protected void	addStringValue(org.apache.lucene.document.Document doc, String fieldName, Object internalValue, boolean tokenized) Adds the string value to the document both as the named field and optionally for full text indexing if tokenized is true.
protected void	addStringValue(org.apache.lucene.document.Document doc, String fieldName, Object internalValue, boolean tokenized, boolean includeInNodeIndex, float boost) Adds the string value to the document both as the named field and optionally for full text indexing if tokenized is true.
protected org.apache.lucene.document.Document	createDoc() Creates a lucene Document.
protected org.apache.lucene.document.Field	createFieldWithoutNorms(String fieldName, String internalValue, boolean store) Creates a field of name fieldName with the value of internalValue.
protected org.apache.lucene.document.Field	createFulltextField(Reader value) Creates a fulltext field for the reader value.
protected org.apache.lucene.document.Field	createFulltextField(String value) Creates a fulltext field for the string value.
protected float	getNodeBoost()
NodeId	getNodeId() Returns the NodeId of the indexed node.
protected float	getPropertyBoost(Name propertyName) Returns the boost value for the given property name.
protected InternalValue	getValue(Name name) Utility method that extracts the first value of the named property of the current node.
protected boolean	isIncludedInNodeIndex(Name propertyName) Returns true if the property with the given name should also be added to the node scope index.
protected boolean	isIndexed(Name propertyName) Returns true if the property with the given name should be indexed.
void	setIndexFormatVersion(IndexFormatVersion indexFormatVersion) Sets the index format version
void	setIndexingConfiguration(IndexingConfiguration config) Sets the indexing configuration for this node indexer.
void	setSupportHighlighting(boolean b) If set to true additional information is stored in the index to support highlighting using the rep:excerpt pseudo property.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_BOOST

protected static final float DEFAULT_BOOST

The default boost for a lucene field: 1.0f.

See Also:

Constant Field Values

node

protected final NodeState node

The NodeState of the node to index

stateProvider

protected final ItemStateManager stateProvider

The persistent item state provider

mappings

protected final NamespaceMappings mappings

Namespace mappings to use for indexing. This is the internal namespace mapping.

resolver

protected final NamePathResolver resolver

Name and Path resolver.

extractor

protected final TextExtractor extractor

Content extractor.

indexingConfig

protected IndexingConfiguration indexingConfig

The indexing configuration or null if none is available.

supportHighlighting

protected boolean supportHighlighting

If set to true the fulltext field is stored and and a term vector is created with offset information.

indexFormatVersion

protected IndexFormatVersion indexFormatVersion

Indicates index format for this node indexer.

Constructor Detail

NodeIndexer

public NodeIndexer(NodeState node,
                   ItemStateManager stateProvider,
                   NamespaceMappings mappings,
                   TextExtractor extractor)

Creates a new node indexer.

Parameters:

node - the node state to index.

stateProvider - the persistent item state manager to retrieve properties.

mappings - internal namespace mappings.

extractor - content extractor

Method Detail

getNodeId

public NodeId getNodeId()

Returns the NodeId of the indexed node.

Returns:

the NodeId of the indexed node.

setSupportHighlighting

public void setSupportHighlighting(boolean b)

If set to true additional information is stored in the index to support highlighting using the rep:excerpt pseudo property.

Parameters:

b - true to enable highlighting support.

setIndexFormatVersion

public void setIndexFormatVersion(IndexFormatVersion indexFormatVersion)

Sets the index format version

Parameters:

indexFormatVersion - the index format version

setIndexingConfiguration

public void setIndexingConfiguration(IndexingConfiguration config)

Sets the indexing configuration for this node indexer.

Parameters:

config - the indexing configuration.

createDoc

protected org.apache.lucene.document.Document createDoc()
                                                 throws RepositoryException

Creates a lucene Document.

Returns:

the lucene Document with the index layout.

Throws:

RepositoryException - if an error occurs while reading property values from the ItemStateProvider.

addBinaryValue

protected void addBinaryValue(org.apache.lucene.document.Document doc,
                              String fieldName,
                              Object internalValue)

Adds the binary value to the document as the named field.

This implementation checks if this node is of type nt:resource and if that is the case, tries to extract text from the binary property using the extractor.

Parameters:

doc - The document to which to add the field

fieldName - The name of the field to add

internalValue - The value for the field to add to the document.

getValue

protected InternalValue getValue(Name name)
                          throws ItemStateException

Utility method that extracts the first value of the named property of the current node. Returns null if the property does not exist or contains no values.

Parameters:

name - property name

Returns:

value of the named property, or null

Throws:

ItemStateException - if the property can not be accessed

addBooleanValue

protected void addBooleanValue(org.apache.lucene.document.Document doc,
                               String fieldName,
                               Object internalValue)

Adds the string representation of the boolean value to the document as the named field.

Parameters:

doc - The document to which to add the field

fieldName - The name of the field to add

internalValue - The value for the field to add to the document.

createFieldWithoutNorms

protected org.apache.lucene.document.Field createFieldWithoutNorms(String fieldName,
                                                                   String internalValue,
                                                                   boolean store)

Creates a field of name fieldName with the value of internalValue. The created field is indexed without norms.

Parameters:

fieldName - The name of the field to add

internalValue - The value for the field to add to the document.

store - true if the value should be stored, false otherwise

addCalendarValue

protected void addCalendarValue(org.apache.lucene.document.Document doc,
                                String fieldName,
                                Object internalValue)

Adds the calendar value to the document as the named field. The calendar value is converted to an indexable string value using the DateField class.

Parameters:

doc - The document to which to add the field

fieldName - The name of the field to add

internalValue - The value for the field to add to the document.

addDoubleValue

protected void addDoubleValue(org.apache.lucene.document.Document doc,
                              String fieldName,
                              Object internalValue)

Adds the double value to the document as the named field. The double value is converted to an indexable string value using the DoubleField class.

Parameters:

doc - The document to which to add the field

fieldName - The name of the field to add

internalValue - The value for the field to add to the document.

addLongValue

protected void addLongValue(org.apache.lucene.document.Document doc,
                            String fieldName,
                            Object internalValue)

Adds the long value to the document as the named field. The long value is converted to an indexable string value using the LongField class.

Parameters:

doc - The document to which to add the field

fieldName - The name of the field to add

internalValue - The value for the field to add to the document.

addReferenceValue

protected void addReferenceValue(org.apache.lucene.document.Document doc,
                                 String fieldName,
                                 Object internalValue)

Adds the reference value to the document as the named field. The value's string representation is added as the reference data. Additionally the reference data is stored in the index.

Parameters:

doc - The document to which to add the field

fieldName - The name of the field to add

internalValue - The value for the field to add to the document.

addPathValue

protected void addPathValue(org.apache.lucene.document.Document doc,
                            String fieldName,
                            Object internalValue)

Adds the path value to the document as the named field. The path value is converted to an indexable string value using the name space mappings with which this class has been created.

Parameters:

doc - The document to which to add the field

fieldName - The name of the field to add

internalValue - The value for the field to add to the document.

addStringValue

protected void addStringValue(org.apache.lucene.document.Document doc,
                              String fieldName,
                              Object internalValue)

Deprecated. Use addStringValue(Document, String, Object, boolean) instead.

Adds the string value to the document both as the named field and for full text indexing.

Parameters:

doc - The document to which to add the field

fieldName - The name of the field to add

internalValue - The value for the field to add to the document.

addStringValue

protected void addStringValue(org.apache.lucene.document.Document doc,
                              String fieldName,
                              Object internalValue,
                              boolean tokenized)

Adds the string value to the document both as the named field and optionally for full text indexing if tokenized is true.

Parameters:

doc - The document to which to add the field

fieldName - The name of the field to add

internalValue - The value for the field to add to the document.

tokenized - If true the string is also tokenized and fulltext indexed.

addStringValue

protected void addStringValue(org.apache.lucene.document.Document doc,
                              String fieldName,
                              Object internalValue,
                              boolean tokenized,
                              boolean includeInNodeIndex,
                              float boost)

Adds the string value to the document both as the named field and optionally for full text indexing if tokenized is true.

Parameters:

doc - The document to which to add the field

fieldName - The name of the field to add

internalValue - The value for the field to add to the document.

tokenized - If true the string is also tokenized and fulltext indexed.

includeInNodeIndex - If true the string is also tokenized and added to the node scope fulltext index.

boost - the boost value for this string field.

addNameValue

protected void addNameValue(org.apache.lucene.document.Document doc,
                            String fieldName,
                            Object internalValue)

Adds the name value to the document as the named field. The name value is converted to an indexable string treating the internal value as a qualified name and mapping the name space using the name space mappings with which this class has been created.

Parameters:

doc - The document to which to add the field

fieldName - The name of the field to add

internalValue - The value for the field to add to the document.

createFulltextField

protected org.apache.lucene.document.Field createFulltextField(String value)

Creates a fulltext field for the string value.

Parameters:

value - the string value.

Returns:

a lucene field.

createFulltextField

protected org.apache.lucene.document.Field createFulltextField(Reader value)

Creates a fulltext field for the reader value.

Parameters:

value - the reader value.

Returns:

a lucene field.

isIndexed

protected boolean isIndexed(Name propertyName)

Returns true if the property with the given name should be indexed.

Parameters:

propertyName - name of a property.

Returns:

true if the property should be fulltext indexed; false otherwise.

isIncludedInNodeIndex

protected boolean isIncludedInNodeIndex(Name propertyName)

Returns true if the property with the given name should also be added to the node scope index.

Parameters:

propertyName - the name of a property.

Returns:

true if it should be added to the node scope index; false otherwise.

getPropertyBoost

protected float getPropertyBoost(Name propertyName)

Returns the boost value for the given property name.

Parameters:

propertyName - the name of a property.

Returns:

the boost value for the given property name.

getNodeBoost

protected float getNodeBoost()

Returns:

the boost value for this node state.