diff --git oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/FieldNames.java oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/FieldNames.java index c2cbd7b..6907101 100644 --- oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/FieldNames.java +++ oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/FieldNames.java @@ -87,6 +87,11 @@ public final class FieldNames { public static final String NOT_NULL_PROPS = ":notNullProps"; /** + * Name of the field that contains the node name + */ + public static final String NODE_NAME = ":nodeName"; + + /** * Used to select only the PATH field from the lucene documents */ public static final Set PATH_SELECTOR = new HashSet( diff --git oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/IndexDefinition.java oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/IndexDefinition.java index 7d191c4..422c4f3 100644 --- oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/IndexDefinition.java +++ oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/IndexDefinition.java @@ -568,6 +568,7 @@ class IndexDefinition implements Aggregate.AggregateMapper{ private final List nullCheckEnabledProperties; private final List notNullCheckEnabledProperties; private final boolean indexesAllNodesOfMatchingType; + private final boolean nodeNameIndexed; final float boost; final boolean inherited; @@ -579,6 +580,7 @@ class IndexDefinition implements Aggregate.AggregateMapper{ final Aggregate propAggregate; + IndexingRule(String nodeTypeName, NodeState config) { this.nodeTypeName = nodeTypeName; this.baseNodeType = nodeTypeName; @@ -600,6 +602,7 @@ class IndexDefinition implements Aggregate.AggregateMapper{ this.fulltextEnabled = aggregate.hasNodeAggregates() || hasAnyFullTextEnabledProperty(); this.propertyIndexEnabled = hasAnyPropertyIndexConfigured(); this.indexesAllNodesOfMatchingType = allMatchingNodeByTypeIndexed(); + this.nodeNameIndexed = getOptionalValue(config, LuceneIndexConstants.INDEX_NODE_NAME, false); validateRuleDefinition(); } @@ -625,6 +628,7 @@ class IndexDefinition implements Aggregate.AggregateMapper{ this.aggregate = combine(propAggregate, nodeTypeName); this.fulltextEnabled = aggregate.hasNodeAggregates() || original.fulltextEnabled; this.indexesAllNodesOfMatchingType = allMatchingNodeByTypeIndexed(); + this.nodeNameIndexed = original.nodeNameIndexed; } /** @@ -698,6 +702,10 @@ class IndexDefinition implements Aggregate.AggregateMapper{ } + public boolean isNodeNameIndexed() { + return nodeNameIndexed; + } + public boolean isFulltextEnabled() { return fulltextEnabled; } diff --git oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/IndexPlanner.java oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/IndexPlanner.java index ed26d81..31aec99 100644 --- oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/IndexPlanner.java +++ oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/IndexPlanner.java @@ -36,6 +36,7 @@ import org.apache.jackrabbit.oak.query.fulltext.FullTextExpression; import org.apache.jackrabbit.oak.query.fulltext.FullTextTerm; import org.apache.jackrabbit.oak.query.fulltext.FullTextVisitor; import org.apache.jackrabbit.oak.spi.query.Filter; +import org.apache.jackrabbit.oak.spi.query.QueryConstant; import org.apache.lucene.index.IndexReader; import org.slf4j.Logger; import org.slf4j.LoggerFactory; @@ -153,6 +154,7 @@ class IndexPlanner { boolean evalNodeTypeRestrictions = canEvalNodeTypeRestrictions(indexingRule); boolean evalPathRestrictions = canEvalPathRestrictions(indexingRule); boolean canEvalAlFullText = canEvalAllFullText(indexingRule, ft); + boolean canEvalNodeNameRestriction = canEvalNodeNameRestriction(indexingRule); if (ft != null && !canEvalAlFullText){ return null; @@ -162,7 +164,8 @@ class IndexPlanner { List sortOrder = createSortOrder(indexingRule); boolean canSort = canSortByProperty(sortOrder); - if (!indexedProps.isEmpty() || canSort || ft != null || evalPathRestrictions || evalNodeTypeRestrictions) { + if (!indexedProps.isEmpty() || canSort || ft != null + || evalPathRestrictions || evalNodeTypeRestrictions || canEvalNodeNameRestriction) { //TODO Need a way to have better cost estimate to indicate that //this index can evaluate more propertyRestrictions natively (if more props are indexed) //For now we reduce cost per entry @@ -197,6 +200,14 @@ class IndexPlanner { return null; } + private boolean canEvalNodeNameRestriction(IndexingRule indexingRule) { + PropertyRestriction pr = filter.getPropertyRestriction(QueryConstant.RESTRICTION_LOCAL_NAME); + if (pr == null){ + return false; + } + return indexingRule.isNodeNameIndexed(); + } + private static boolean canSortByProperty(List sortOrder) { if (sortOrder.isEmpty()) { return false; diff --git oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/LuceneIndexConstants.java oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/LuceneIndexConstants.java index ab077b8..a25866b 100644 --- oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/LuceneIndexConstants.java +++ oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/LuceneIndexConstants.java @@ -253,4 +253,10 @@ public interface LuceneIndexConstants { * 'IS NOT NULL' constraint */ String PROP_NOT_NULL_CHECK_ENABLED = "notNullCheckEnabled"; + + /** + * IndexRule level config to indicate that Node name should also be index + * to support fn:name() queries + */ + String INDEX_NODE_NAME = "indexNodeName"; } diff --git oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/LuceneIndexEditor.java oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/LuceneIndexEditor.java index 721b6f8..039847d 100644 --- oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/LuceneIndexEditor.java +++ oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/LuceneIndexEditor.java @@ -312,6 +312,12 @@ public class LuceneIndexEditor implements IndexEditor, Aggregate.AggregateRoot { return null; } + String name = getName(path); + if (indexingRule.isNodeNameIndexed()){ + addNodeNameField(fields, name); + dirty = true; + } + //For property index no use making an empty document if //none of the properties are indexed if(!indexingRule.isFulltextEnabled() && !dirty){ @@ -320,9 +326,8 @@ public class LuceneIndexEditor implements IndexEditor, Aggregate.AggregateRoot { Document document = new Document(); document.add(newPathField(path)); - String name = getName(path); - //TODO Possibly index nodeName without tokenization for node name based queries + if (indexingRule.isFulltextEnabled()) { document.add(newFulltextField(name)); } @@ -800,4 +805,21 @@ public class LuceneIndexEditor implements IndexEditor, Aggregate.AggregateRoot { return handler.toString(); } + + /** + * Extracts the local name of the current node ignoring any namespace prefix + * + * @param name node name + */ + private static void addNodeNameField(List fields, String name) { + //TODO Need to check if it covers all cases + int colon = name.indexOf(':'); + String value = colon < 0 ? name : name.substring(colon + 1); + + //For now just add a single term. Later we can look into using different analyzer + //to analyze the node name and add multiple terms. Like add multiple terms for a + //cameCase file name to allow faster like search + fields.add(new StringField(FieldNames.NODE_NAME, value, Field.Store.NO)); + } + } diff --git oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/LucenePropertyIndex.java oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/LucenePropertyIndex.java index 60e24d1..f8b59c9 100644 --- oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/LucenePropertyIndex.java +++ oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/LucenePropertyIndex.java @@ -60,6 +60,7 @@ import org.apache.jackrabbit.oak.spi.query.Filter; import org.apache.jackrabbit.oak.spi.query.Filter.PropertyRestriction; import org.apache.jackrabbit.oak.spi.query.IndexRow; import org.apache.jackrabbit.oak.spi.query.PropertyValues; +import org.apache.jackrabbit.oak.spi.query.QueryConstant; import org.apache.jackrabbit.oak.spi.query.QueryIndex; import org.apache.jackrabbit.oak.spi.query.QueryIndex.AdvanceFulltextQueryIndex; import org.apache.jackrabbit.oak.spi.state.NodeState; @@ -650,6 +651,14 @@ public class LucenePropertyIndex implements AdvancedQueryIndex, QueryIndex, Nati } } + if (QueryConstant.RESTRICTION_LOCAL_NAME.equals(name)){ + Query q = createNodeNameQuery(pr); + if (q != null) { + qs.add(q); + } + continue; + } + PropertyDefinition pd = planResult.getPropDefn(pr); if (pd == null) { continue; @@ -854,6 +863,21 @@ public class LucenePropertyIndex implements AdvancedQueryIndex, QueryIndex, Nati throw new IllegalStateException("PropertyRestriction not handled " + pr + " for index " + defn ); } + private static Query createNodeNameQuery(PropertyRestriction pr) { + String first = pr.first != null ? pr.first.getValue(STRING) : null; + if (pr.first != null && pr.first.equals(pr.last) && pr.firstIncluding + && pr.lastIncluding) { + // [property]=[value] + return new TermQuery(new Term(FieldNames.NODE_NAME, first)); + } + + if (pr.isLike) { + return createLikeQuery(FieldNames.NODE_NAME, first); + } + + throw new IllegalStateException("For nodeName queries only EQUALS and LIKE are supported "+pr); + } + private static void addReferenceConstraint(String uuid, List qs, IndexReader reader) { if (reader == null) { diff --git oak-lucene/src/test/java/org/apache/jackrabbit/oak/plugins/index/lucene/LuceneIndexTest.java oak-lucene/src/test/java/org/apache/jackrabbit/oak/plugins/index/lucene/LuceneIndexTest.java index 0d028f7..3df526b 100644 --- oak-lucene/src/test/java/org/apache/jackrabbit/oak/plugins/index/lucene/LuceneIndexTest.java +++ oak-lucene/src/test/java/org/apache/jackrabbit/oak/plugins/index/lucene/LuceneIndexTest.java @@ -37,6 +37,7 @@ import static junit.framework.Assert.assertFalse; import static junit.framework.Assert.assertTrue; import static org.apache.jackrabbit.JcrConstants.JCR_SYSTEM; import static org.apache.jackrabbit.JcrConstants.NT_BASE; +import static org.apache.jackrabbit.JcrConstants.NT_FILE; import static org.apache.jackrabbit.oak.plugins.index.IndexConstants.INDEX_DEFINITIONS_NAME; import static org.apache.jackrabbit.oak.plugins.index.IndexConstants.REINDEX_PROPERTY_NAME; import static org.apache.jackrabbit.oak.plugins.index.lucene.LuceneIndexConstants.ANALYZERS; @@ -59,6 +60,7 @@ import static org.apache.jackrabbit.oak.spi.query.QueryIndex.IndexPlan; import com.google.common.base.Function; import org.apache.commons.io.FileUtils; +import org.apache.jackrabbit.JcrConstants; import org.apache.jackrabbit.oak.api.Type; import org.apache.jackrabbit.oak.plugins.index.IndexConstants; import org.apache.jackrabbit.oak.plugins.index.IndexUpdateProvider; @@ -77,6 +79,7 @@ import org.apache.jackrabbit.oak.spi.query.Cursor; import org.apache.jackrabbit.oak.spi.query.Filter; import org.apache.jackrabbit.oak.spi.query.IndexRow; import org.apache.jackrabbit.oak.spi.query.PropertyValues; +import org.apache.jackrabbit.oak.spi.query.QueryConstant; import org.apache.jackrabbit.oak.spi.state.NodeBuilder; import org.apache.jackrabbit.oak.spi.state.NodeState; import org.apache.jackrabbit.oak.spi.state.NodeStore; @@ -373,6 +376,38 @@ public class LuceneIndexTest { assertFilter(filter, queryIndex, indexed, ImmutableList.of("/a/b", "/a/b/c")); } + @Test + public void nodeNameIndex() throws Exception{ + NodeBuilder index = newLucenePropertyIndexDefinition(builder.child(INDEX_DEFINITIONS_NAME), + "lucene", ImmutableSet.of("foo"), null); + NodeBuilder rules = index.child(INDEX_RULES); + NodeBuilder ruleNode = rules.child(NT_FILE); + ruleNode.setProperty(LuceneIndexConstants.INDEX_NODE_NAME, true); + + NodeState before = builder.getNodeState(); + createNodeWithType(builder, "foo", NT_FILE); + createNodeWithType(builder, "camelCase", NT_FILE); + NodeState after = builder.getNodeState(); + + NodeState indexed = HOOK.processCommit(before, after,CommitInfo.EMPTY); + + IndexTracker tracker = new IndexTracker(); + tracker.update(indexed); + AdvancedQueryIndex queryIndex = new LucenePropertyIndex(tracker); + + FilterImpl filter = createFilter(NT_FILE); + filter.restrictProperty(QueryConstant.RESTRICTION_LOCAL_NAME, Operator.EQUAL, PropertyValues.newString("foo")); + assertFilter(filter, queryIndex, indexed, ImmutableList.of("/foo")); + + filter = createFilter(NT_FILE); + filter.restrictProperty(QueryConstant.RESTRICTION_LOCAL_NAME, Operator.LIKE, PropertyValues.newString("camelCase")); + assertFilter(filter, queryIndex, indexed, ImmutableList.of("/camelCase")); + + filter = createFilter(NT_FILE); + filter.restrictProperty(QueryConstant.RESTRICTION_LOCAL_NAME, Operator.LIKE, PropertyValues.newString("camel%")); + assertFilter(filter, queryIndex, indexed, ImmutableList.of("/camelCase")); + } + private FilterImpl createTestFilter(){ FilterImpl filter = createFilter(NT_BASE); filter.restrictProperty("foo", Operator.EQUAL, PropertyValues.newString("bar")); diff --git oak-lucene/src/test/java/org/apache/jackrabbit/oak/plugins/index/lucene/LucenePropertyIndexTest.java oak-lucene/src/test/java/org/apache/jackrabbit/oak/plugins/index/lucene/LucenePropertyIndexTest.java index 57e2297..1ec4351 100644 --- oak-lucene/src/test/java/org/apache/jackrabbit/oak/plugins/index/lucene/LucenePropertyIndexTest.java +++ oak-lucene/src/test/java/org/apache/jackrabbit/oak/plugins/index/lucene/LucenePropertyIndexTest.java @@ -305,6 +305,33 @@ public class LucenePropertyIndexTest extends AbstractQueryTest { } @Test + public void nodeName() throws Exception{ + Tree idx = createIndex("test1", of("propa", "propb")); + Tree rules = idx.addChild(LuceneIndexConstants.INDEX_RULES); + rules.setOrderableChildren(true); + Tree rule = rules.addChild("nt:base"); + rule.setProperty(LuceneIndexConstants.INDEX_NODE_NAME, true); + root.commit(); + + Tree test = root.getTree("/"); + test.addChild("foo"); + test.addChild("camelCase"); + test.addChild("test").addChild("bar"); + root.commit(); + + String propabQuery = "select [jcr:path] from [nt:base] where LOCALNAME() = 'foo'"; + assertThat(explain(propabQuery), containsString("lucene:test1(/oak:index/test1) :nodeName:foo")); + assertQuery(propabQuery, asList("/foo")); + assertQuery("select [jcr:path] from [nt:base] where LOCALNAME() = 'bar'", asList("/test/bar")); + assertQuery("select [jcr:path] from [nt:base] where LOCALNAME() LIKE 'foo'", asList("/foo")); + assertQuery("select [jcr:path] from [nt:base] where LOCALNAME() LIKE 'camel%'", asList("/camelCase")); + + assertQuery("select [jcr:path] from [nt:base] where NAME() = 'bar'", asList("/test/bar")); + assertQuery("select [jcr:path] from [nt:base] where NAME() LIKE 'foo'", asList("/foo")); + assertQuery("select [jcr:path] from [nt:base] where NAME() LIKE 'camel%'", asList("/camelCase")); + } + + @Test public void emptyIndex() throws Exception{ Tree idx = createIndex("test1", of("propa", "propb")); idx.addChild(PROP_NODE).addChild("propa");