org.apache.jackrabbit.core.query.lucene

Class JahiaNodeIndexer

java.lang.Object

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

org.apache.jackrabbit.core.query.lucene.JahiaNodeIndexer

Direct Known Subclasses:

JahiaTranslationNodeIndexer

public class JahiaNodeIndexer
extends org.apache.jackrabbit.core.query.lucene.NodeIndexer

Creates a lucene Document object from a Node and use Jahia sepecific definitions for index creation.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACL_UUID
static String	CHECK_VISIBILITY
static String	FACET_HIERARCHY
static String	FACET_PREFIX Prefix for all field names that are facet indexed by property name.
protected org.apache.jackrabbit.core.HierarchyManager	hierarchyMgr The hierarchy manager
static String	INVALID_LANGUAGES
static org.apache.jackrabbit.spi.Name	J_ACE_GRANT
static org.apache.jackrabbit.spi.Name	J_ACE_PRINCIPAL
static org.apache.jackrabbit.spi.Name	J_ACE_ROLES
static org.apache.jackrabbit.spi.Name	J_ACL
static org.apache.jackrabbit.spi.Name	J_ACL_INHERITED
static org.apache.jackrabbit.spi.Name	J_INVALID_LANGUAGES
static org.apache.jackrabbit.spi.Name	J_PUBLISHED
static org.apache.jackrabbit.spi.Name	J_VISIBILITY
protected static org.slf4j.Logger	logger The logger instance for this class.
protected javax.jcr.NamespaceRegistry	namespaceRegistry The persistent namespace registry
protected NodeTypeRegistry	nodeTypeRegistry The persistent node type registry
static String	PUBLISHED
protected boolean	supportSpellchecking If set to true the fulltext field is also stored with site/locale suffix
static String	TRANSLATED_NODE_PARENT
static String	TRANSLATION_LANGUAGE

Fields inherited from class org.apache.jackrabbit.core.query.lucene.NodeIndexer

DEFAULT_BOOST, doNotUseInExcerpt, indexFormatVersion, indexingConfig, mappings, node, resolver, stateProvider, supportHighlighting

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	JahiaNodeIndexer(org.apache.jackrabbit.core.state.NodeState node, org.apache.jackrabbit.core.state.ItemStateManager stateProvider, org.apache.jackrabbit.core.query.lucene.NamespaceMappings mappings, Executor executor, org.apache.tika.parser.Parser parser, org.apache.jackrabbit.core.query.QueryHandlerContext context, NodeTypeRegistry typeRegistry, javax.jcr.NamespaceRegistry nameRegistry)

Method Summary

Modifier and Type	Method and Description
protected void	addAclUuid(org.apache.lucene.document.Document doc)
protected void	addBinaryValue(org.apache.lucene.document.Document doc, String fieldName, org.apache.jackrabbit.core.value.InternalValue internalValue)
protected void	addBooleanValue(org.apache.lucene.document.Document doc, String fieldName, Object internalValue)
protected void	addCalendarValue(org.apache.lucene.document.Document doc, String fieldName, Calendar internalValue)
protected void	addDoubleValue(org.apache.lucene.document.Document doc, String fieldName, double internalValue)
protected void	addFacetValue(org.apache.lucene.document.Document doc, String fieldName, Object internalValue) Adds the value to the document both as faceted field which will be indexed with a keyword analyzer which does not modify the term.
protected void	addHierarchicalFacetValue(org.apache.lucene.document.Document doc, String fieldName, Object internalValue) Adds the value to the document both as faceted field which will be indexed with a keyword analyzer which does not modify the term.
protected void	addLongValue(org.apache.lucene.document.Document doc, String fieldName, long internalValue)
protected void	addNameValue(org.apache.lucene.document.Document doc, String fieldName, org.apache.jackrabbit.spi.Name internalValue)
protected void	addParentChildRelation(org.apache.lucene.document.Document doc, org.apache.jackrabbit.core.id.NodeId parentId)
protected void	addReferenceValue(org.apache.lucene.document.Document doc, String fieldName, org.apache.jackrabbit.core.id.NodeId internalValue, boolean weak)
protected void	addStringValue(org.apache.lucene.document.Document doc, String fieldName, String internalValue, boolean tokenized, boolean includeInNodeIndex, float boost, boolean useInExcerpt) Adds the string value to the document both as the named field and optionally for full text indexing if tokenized is true.
protected void	cleanupNodeProperties(org.apache.jackrabbit.core.state.NodeState node)
org.apache.lucene.document.Document	createDoc()
protected org.apache.lucene.document.Field	createFulltextField(String fieldName, String value, boolean store) Creates a fulltext field for the string value.
static JahiaNodeIndexer	createNodeIndexer(org.apache.jackrabbit.core.state.NodeState node, org.apache.jackrabbit.core.state.ItemStateManager itemStateManager, org.apache.jackrabbit.core.query.lucene.NamespaceMappings nsMappings, Executor executor, org.apache.tika.parser.Parser parser, org.apache.jackrabbit.core.query.QueryHandlerContext context)
protected ExtendedPropertyDefinition	getExtendedPropertyDefinition(String fieldName)
protected String	getFullTextFieldName(String site)
protected JahiaIndexingConfigurationImpl	getIndexingConfig()
protected ExtendedNodeType	getNodeType()
protected float	getPropertyBoost(org.apache.jackrabbit.spi.Name propertyName) Returns the boost value for the given property name.
protected ExtendedPropertyDefinition	getPropertyDefinition(String fieldName)
protected ExtendedPropertyDefinition	getPropertyDefinitionFor(String fieldName, ExtendedNodeType nodeType, org.apache.jackrabbit.core.state.NodeState node)
protected String	getPropertyName(org.apache.jackrabbit.spi.Name name)
protected String	getTypeNameAsString()
protected static String	getTypeNameAsString(org.apache.jackrabbit.spi.Name nodeTypeName, javax.jcr.NamespaceRegistry namespaceRegistry) Convert name object to jcr-name string
boolean	isAddAclUuidInIndex() Returns true if ACL-UUID should be resolved and stored in index.
protected boolean	isIncludedInNodeIndex(org.apache.jackrabbit.spi.Name propertyName) Returns true if the property with the given name should also be added to the node scope index.
protected boolean	isIndexed(org.apache.jackrabbit.spi.Name propertyName) Returns true if the property with the given name should be indexed.
boolean	isSupportSpellchecking()
boolean	isUseOptimizedACEIndexation() Does this indexer use optimized ACE indexation.
protected String	resolveSite()
void	setAddAclUuidInIndex(boolean addAclUuidInIndex)
void	setSupportSpellchecking(boolean supportSpellchecking)
void	setUseOptimizedACEIndexation(boolean useOptimizedACEIndexation)
protected boolean	useInExcerpt(org.apache.jackrabbit.spi.Name propertyName) Returns true if the content of the property with the given name should the used to create an excerpt.

Methods inherited from class org.apache.jackrabbit.core.query.lucene.NodeIndexer

addDecimalValue, addLength, addMVPName, addNodeName, addPathValue, addPropertyName, addStringValue, addStringValue, addStringValue, addURIValue, addValue, addValueProperty, createFieldWithoutNorms, createFulltextField, createFulltextField, createFulltextField, createFulltextField, createFulltextField, getMaxExtractLength, getNodeBoost, getNodeId, getValue, isSupportedMediaType, setIndexFormatVersion, setIndexingConfiguration, setMaxExtractLength, setSupportHighlighting, throwRepositoryException

Methods inherited from class java.lang.Object

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

Field Detail

logger

protected static final org.slf4j.Logger logger

The logger instance for this class.

FACET_PREFIX

public static final String FACET_PREFIX

Prefix for all field names that are facet indexed by property name.

See Also:

Constant Field Values

TRANSLATED_NODE_PARENT

public static final String TRANSLATED_NODE_PARENT

TRANSLATION_LANGUAGE

public static final String TRANSLATION_LANGUAGE

ACL_UUID

public static final String ACL_UUID

J_ACL

public static final org.apache.jackrabbit.spi.Name J_ACL

J_ACL_INHERITED

public static final org.apache.jackrabbit.spi.Name J_ACL_INHERITED

J_ACE_PRINCIPAL

public static final org.apache.jackrabbit.spi.Name J_ACE_PRINCIPAL

J_ACE_GRANT

public static final org.apache.jackrabbit.spi.Name J_ACE_GRANT

J_ACE_ROLES

public static final org.apache.jackrabbit.spi.Name J_ACE_ROLES

CHECK_VISIBILITY

public static final String CHECK_VISIBILITY

J_VISIBILITY

public static final org.apache.jackrabbit.spi.Name J_VISIBILITY

PUBLISHED

public static final String PUBLISHED

J_PUBLISHED

public static final org.apache.jackrabbit.spi.Name J_PUBLISHED

FACET_HIERARCHY

public static final String FACET_HIERARCHY

J_INVALID_LANGUAGES

public static final org.apache.jackrabbit.spi.Name J_INVALID_LANGUAGES

INVALID_LANGUAGES

public static final String INVALID_LANGUAGES

nodeTypeRegistry

protected final NodeTypeRegistry nodeTypeRegistry

The persistent node type registry

namespaceRegistry

protected final javax.jcr.NamespaceRegistry namespaceRegistry

The persistent namespace registry

hierarchyMgr

protected final org.apache.jackrabbit.core.HierarchyManager hierarchyMgr

The hierarchy manager

supportSpellchecking

protected boolean supportSpellchecking

If set to true the fulltext field is also stored with site/locale suffix

Constructor Detail

JahiaNodeIndexer

protected JahiaNodeIndexer(org.apache.jackrabbit.core.state.NodeState node,
                           org.apache.jackrabbit.core.state.ItemStateManager stateProvider,
                           org.apache.jackrabbit.core.query.lucene.NamespaceMappings mappings,
                           Executor executor,
                           org.apache.tika.parser.Parser parser,
                           org.apache.jackrabbit.core.query.QueryHandlerContext context,
                           NodeTypeRegistry typeRegistry,
                           javax.jcr.NamespaceRegistry nameRegistry)

Method Detail

getTypeNameAsString

protected String getTypeNameAsString()
                              throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

getTypeNameAsString

protected static String getTypeNameAsString(org.apache.jackrabbit.spi.Name nodeTypeName,
                                            javax.jcr.NamespaceRegistry namespaceRegistry)
                                     throws javax.jcr.RepositoryException

Convert name object to jcr-name string

Parameters:

nodeTypeName - the name

namespaceRegistry - the namespace registry

Returns:

Throws:

javax.jcr.RepositoryException - in case of JCR-related errors

useInExcerpt

protected boolean useInExcerpt(org.apache.jackrabbit.spi.Name propertyName)

Returns true if the content of the property with the given name should the used to create an excerpt.

Overrides:

useInExcerpt in class org.apache.jackrabbit.core.query.lucene.NodeIndexer

Parameters:

propertyName - the name of a property.

Returns:

true if it should be used to create an excerpt; false otherwise.

getPropertyName

protected String getPropertyName(org.apache.jackrabbit.spi.Name name)

resolveSite

protected String resolveSite()

getNodeType

protected ExtendedNodeType getNodeType()

getExtendedPropertyDefinition

protected ExtendedPropertyDefinition getExtendedPropertyDefinition(String fieldName)

getPropertyDefinition

protected ExtendedPropertyDefinition getPropertyDefinition(String fieldName)
                                                    throws javax.jcr.RepositoryException,
                                                           org.apache.jackrabbit.core.state.ItemStateException

Throws:

javax.jcr.RepositoryException

org.apache.jackrabbit.core.state.ItemStateException

getPropertyDefinitionFor

protected ExtendedPropertyDefinition getPropertyDefinitionFor(String fieldName,
                                                              ExtendedNodeType nodeType,
                                                              org.apache.jackrabbit.core.state.NodeState node)
                                                       throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

getPropertyBoost

protected float getPropertyBoost(org.apache.jackrabbit.spi.Name propertyName)

Returns the boost value for the given property name.

Overrides:

getPropertyBoost in class org.apache.jackrabbit.core.query.lucene.NodeIndexer

Parameters:

propertyName - the name of a property.

Returns:

the boost value for the given property name.

isIncludedInNodeIndex

protected boolean isIncludedInNodeIndex(org.apache.jackrabbit.spi.Name propertyName)

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

Overrides:

isIncludedInNodeIndex in class org.apache.jackrabbit.core.query.lucene.NodeIndexer

Parameters:

propertyName - the name of a property.

Returns:

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

isIndexed

protected boolean isIndexed(org.apache.jackrabbit.spi.Name propertyName)

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

Overrides:

isIndexed in class org.apache.jackrabbit.core.query.lucene.NodeIndexer

Parameters:

propertyName - name of a property.

Returns:

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

addStringValue

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

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

The Jahia specific functionality is to strip off HTML markup from richtext fields.

Overrides:

addStringValue in class org.apache.jackrabbit.core.query.lucene.NodeIndexer

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.

useInExcerpt - If true the string may show up in an excerpt.

getFullTextFieldName

protected String getFullTextFieldName(String site)

addFacetValue

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

Adds the value to the document both as faceted field which will be indexed with a keyword analyzer which does not modify the term.

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.

addHierarchicalFacetValue

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

Adds the value to the document both as faceted field which will be indexed with a keyword analyzer which does not modify the term.

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 fieldName,
                                                               String value,
                                                               boolean store)

Creates a fulltext field for the string value.

Parameters:

value - the string value.

store - if the value of the field should be stored.

Returns:

a lucene field.

isSupportSpellchecking

public boolean isSupportSpellchecking()

setSupportSpellchecking

public void setSupportSpellchecking(boolean supportSpellchecking)

addCalendarValue

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

Overrides:

addCalendarValue in class org.apache.jackrabbit.core.query.lucene.NodeIndexer

addBinaryValue

protected void addBinaryValue(org.apache.lucene.document.Document doc,
                              String fieldName,
                              org.apache.jackrabbit.core.value.InternalValue internalValue)

Overrides:

addBinaryValue in class org.apache.jackrabbit.core.query.lucene.NodeIndexer

addBooleanValue

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

Overrides:

addBooleanValue in class org.apache.jackrabbit.core.query.lucene.NodeIndexer

addDoubleValue

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

Overrides:

addDoubleValue in class org.apache.jackrabbit.core.query.lucene.NodeIndexer

addLongValue

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

Overrides:

addLongValue in class org.apache.jackrabbit.core.query.lucene.NodeIndexer

addReferenceValue

protected void addReferenceValue(org.apache.lucene.document.Document doc,
                                 String fieldName,
                                 org.apache.jackrabbit.core.id.NodeId internalValue,
                                 boolean weak)

Overrides:

addReferenceValue in class org.apache.jackrabbit.core.query.lucene.NodeIndexer

addNameValue

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

Overrides:

addNameValue in class org.apache.jackrabbit.core.query.lucene.NodeIndexer

createDoc

public org.apache.lucene.document.Document createDoc()
                                              throws javax.jcr.RepositoryException

Overrides:

createDoc in class org.apache.jackrabbit.core.query.lucene.NodeIndexer

Throws:

javax.jcr.RepositoryException

addParentChildRelation

protected void addParentChildRelation(org.apache.lucene.document.Document doc,
                                      org.apache.jackrabbit.core.id.NodeId parentId)
                               throws org.apache.jackrabbit.core.state.ItemStateException

Overrides:

addParentChildRelation in class org.apache.jackrabbit.core.query.lucene.NodeIndexer

Throws:

org.apache.jackrabbit.core.state.ItemStateException

cleanupNodeProperties

protected void cleanupNodeProperties(org.apache.jackrabbit.core.state.NodeState node)

getIndexingConfig

protected JahiaIndexingConfigurationImpl getIndexingConfig()

addAclUuid

protected void addAclUuid(org.apache.lucene.document.Document doc)
                   throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException

isAddAclUuidInIndex

public boolean isAddAclUuidInIndex()

Returns true if ACL-UUID should be resolved and stored in index. This can have a negative effect on performance, when setting rights on a node, which has a large subtree using the same rights, as all these nodes will need to be reindexed. On the other side the advantage is that the queries are faster, as the user rights are resolved faster.

Returns:

Returns true if ACL-UUID should be resolved and stored in index.

setAddAclUuidInIndex

public void setAddAclUuidInIndex(boolean addAclUuidInIndex)

isUseOptimizedACEIndexation

public boolean isUseOptimizedACEIndexation()

Does this indexer use optimized ACE indexation. Set by the JahiaSearchIndex based on a list of node types allowing this optimization.

Returns:

setUseOptimizedACEIndexation

public void setUseOptimizedACEIndexation(boolean useOptimizedACEIndexation)

createNodeIndexer

public static JahiaNodeIndexer createNodeIndexer(org.apache.jackrabbit.core.state.NodeState node,
                                                 org.apache.jackrabbit.core.state.ItemStateManager itemStateManager,
                                                 org.apache.jackrabbit.core.query.lucene.NamespaceMappings nsMappings,
                                                 Executor executor,
                                                 org.apache.tika.parser.Parser parser,
                                                 org.apache.jackrabbit.core.query.QueryHandlerContext context)
                                          throws javax.jcr.RepositoryException

Throws:

javax.jcr.RepositoryException