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

Class IndexDefinition.IndexingRule

java.lang.Object

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

Enclosing class:

IndexDefinition

public class IndexDefinition.IndexingRule
extends Object

Method Summary

Methods

Modifier and Type	Method and Description
boolean	appliesTo(String nodeTypeName)
boolean	appliesTo(org.apache.jackrabbit.oak.api.Tree state) Returns true if this rule applies to the given node state.
org.apache.jackrabbit.oak.plugins.index.lucene.Aggregate	getAggregate()
String	getBaseNodeType()
org.apache.jackrabbit.oak.plugins.index.lucene.PropertyDefinition	getConfig(String propertyName)
List<org.apache.jackrabbit.oak.plugins.index.lucene.PropertyDefinition>	getNodeScopeAnalyzedProps()
String	getNodeTypeName() Returns the name of the node type where this rule applies to.
List<org.apache.jackrabbit.oak.plugins.index.lucene.PropertyDefinition>	getNotNullCheckEnabledProperties()
List<org.apache.jackrabbit.oak.plugins.index.lucene.PropertyDefinition>	getNullCheckEnabledProperties()
boolean	includePropertyType(int type)
boolean	indexesAllNodesOfMatchingType() Flag to determine weather current index rule definition allows indexing of all node of type as covered by the current rule.
boolean	isAggregated(String nodePath)
boolean	isBasedOnNtBase()
boolean	isFulltextEnabled() Returns true if the rule has any property definition which enables evaluation of fulltext related clauses
boolean	isIndexed(String propertyName) Returns true if the property with the given name is indexed according to this rule.
boolean	isNodeFullTextIndexed() Returns true if a fulltext field for the node would be created for any node matching the current rule.
boolean	isNodeNameIndexed()
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

isIndexed

public boolean isIndexed(String propertyName)

Returns true if the property with the given name is indexed according to this rule.

Parameters:

propertyName - the name of a property.

Returns:

true if the property is indexed; false otherwise.

getNodeTypeName

public String getNodeTypeName()

Returns the name of the node type where this rule applies to.

Returns:

name of the node type.

getBaseNodeType

public String getBaseNodeType()

Returns:

name of the base node type.

getNullCheckEnabledProperties

public List<org.apache.jackrabbit.oak.plugins.index.lucene.PropertyDefinition> getNullCheckEnabledProperties()

getNotNullCheckEnabledProperties

public List<org.apache.jackrabbit.oak.plugins.index.lucene.PropertyDefinition> getNotNullCheckEnabledProperties()

getNodeScopeAnalyzedProps

public List<org.apache.jackrabbit.oak.plugins.index.lucene.PropertyDefinition> getNodeScopeAnalyzedProps()

toString

public String toString()

Overrides:

toString in class Object

isAggregated

public boolean isAggregated(String nodePath)

appliesTo

public boolean appliesTo(org.apache.jackrabbit.oak.api.Tree state)

Returns true if this rule applies to the given node state.

Parameters:

state - the state to check.

Returns:

true the rule applies to the given node; false otherwise.

appliesTo

public boolean appliesTo(String nodeTypeName)

isNodeNameIndexed

public boolean isNodeNameIndexed()

isFulltextEnabled

public boolean isFulltextEnabled()

Returns true if the rule has any property definition which enables evaluation of fulltext related clauses

isNodeFullTextIndexed

public boolean isNodeFullTextIndexed()

Returns true if a fulltext field for the node would be created for any node matching the current rule.

getConfig

@CheckForNull
public org.apache.jackrabbit.oak.plugins.index.lucene.PropertyDefinition getConfig(String propertyName)

Parameters:

propertyName - name of a property.

Returns:

the property configuration or null if this indexing rule does not contain a configuration for the given property.

includePropertyType

public boolean includePropertyType(int type)

getAggregate

public org.apache.jackrabbit.oak.plugins.index.lucene.Aggregate getAggregate()

indexesAllNodesOfMatchingType

public boolean indexesAllNodesOfMatchingType()

Flag to determine weather current index rule definition allows indexing of all node of type as covered by the current rule. For example if the rule only indexes certain property 'foo' for node type 'app:Asset' then index would only have entries for those assets where foo is defined. Such an index cannot claim that it has entries for all assets.

Returns:

true in case all matching node types are covered by this rule

isBasedOnNtBase

public boolean isBasedOnNtBase()