org.apache.jackrabbit.oak.plugins.index.property.PropertyIndex Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.jackrabbit.oak.plugins.index.property;
import static com.google.common.base.Preconditions.checkState;
import static org.apache.jackrabbit.oak.plugins.index.IndexConstants.INDEX_CONTENT_NODE_NAME;
import static org.apache.jackrabbit.oak.plugins.index.IndexConstants.INDEX_DEFINITIONS_NAME;
import static org.apache.jackrabbit.oak.plugins.index.IndexConstants.TYPE_PROPERTY_NAME;
import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;
import java.util.HashSet;
import java.util.Set;
import org.apache.jackrabbit.oak.api.PropertyValue;
import org.apache.jackrabbit.oak.api.Type;
import org.apache.jackrabbit.oak.spi.mount.MountInfoProvider;
import org.apache.jackrabbit.oak.spi.query.Cursor;
import org.apache.jackrabbit.oak.spi.query.Filter;
import org.apache.jackrabbit.oak.spi.query.QueryIndex;
import org.apache.jackrabbit.oak.spi.state.ChildNodeEntry;
import org.apache.jackrabbit.oak.spi.state.NodeState;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.google.common.base.Charsets;
/**
* Provides a QueryIndex that does lookups against a property index
*
*
* To define a property index on a subtree you have to add an oak:index node.
*
* Next (as a child node) follows the index definition node that:
*
* - must be of type
oak:QueryIndexDefinition
* - must have the
type property set to property
* - contains the
propertyNames property that indicates what property will be stored in the index
*
*
*
* Optionally you can specify
*
* - a uniqueness constraint on a property index by setting the
unique flag to true
* - that the property index only applies to a certain node type by setting the
declaringNodeTypes property
*
*
*
* Notes:
*
* -
propertyNames can be a list of properties, and it is optional.in case it is missing, the node name will be used as a property name reference value
* -
reindex is a property that when set to true, triggers a full content reindex.
*
*
*
*
*
* {
* NodeBuilder index = root.child("oak:index");
* index.child("uuid")
* .setProperty("jcr:primaryType", "oak:QueryIndexDefinition", Type.NAME)
* .setProperty("type", "property")
* .setProperty("propertyNames", "jcr:uuid")
* .setProperty("declaringNodeTypes", "mix:referenceable")
* .setProperty("unique", true)
* .setProperty("reindex", true);
* }
*
*
*
* @see QueryIndex
* @see PropertyIndexLookup
*/
class PropertyIndex implements QueryIndex {
private static final String PROPERTY = "property";
// TODO the max string length should be removed, or made configurable
private static final int MAX_STRING_LENGTH = 100;
/**
* name used when the indexed value is an empty string
*/
private static final String EMPTY_TOKEN = ":";
private static final Logger LOG = LoggerFactory.getLogger(PropertyIndex.class);
private final MountInfoProvider mountInfoProvider;
/**
* Cached property index plan
*/
private PropertyIndexPlan plan;
PropertyIndex(MountInfoProvider mountInfoProvider) {
this.mountInfoProvider = mountInfoProvider;
}
static Set encode(PropertyValue value) {
if (value == null) {
return null;
}
Set values = new HashSet();
for (String v : value.getValue(Type.STRINGS)) {
try {
if (v.length() > MAX_STRING_LENGTH) {
v = v.substring(0, MAX_STRING_LENGTH);
}
if (v.isEmpty()) {
v = EMPTY_TOKEN;
} else {
v = URLEncoder.encode(v, Charsets.UTF_8.name());
}
values.add(v);
} catch (UnsupportedEncodingException e) {
throw new IllegalStateException("UTF-8 is unsupported", e);
}
}
return values;
}
private PropertyIndexPlan getPlan(NodeState root, Filter filter) {
// Reuse cached plan if the filter is the same (which should always be the case). The filter is compared as a
// string because it would not be possible to use its equals method since the preparing flag would be different
// and creating a separate isSimilar method is not worth the effort since it would not be used anymore once the
// PropertyIndex has been refactored to an AdvancedQueryIndex (which will make the plan cache obsolete).
PropertyIndexPlan plan = this.plan;
if (plan != null && plan.getFilter().toString().equals(filter.toString())) {
return plan;
} else {
plan = createPlan(root, filter, mountInfoProvider);
this.plan = plan;
return plan;
}
}
private static PropertyIndexPlan createPlan(NodeState root, Filter filter,
MountInfoProvider mountInfoProvider) {
PropertyIndexPlan bestPlan = null;
// TODO support indexes on a path
// currently, only indexes on the root node are supported
NodeState state = root.getChildNode(INDEX_DEFINITIONS_NAME);
for (ChildNodeEntry entry : state.getChildNodeEntries()) {
NodeState definition = entry.getNodeState();
if (PROPERTY.equals(definition.getString(TYPE_PROPERTY_NAME))
&& definition.hasChildNode(INDEX_CONTENT_NODE_NAME)) {
PropertyIndexPlan plan = new PropertyIndexPlan(
entry.getName(), root, definition, filter, mountInfoProvider);
if (plan.getCost() != Double.POSITIVE_INFINITY) {
LOG.debug("property cost for {} is {}",
plan.getName(), plan.getCost());
if (bestPlan == null || plan.getCost() < bestPlan.getCost()) {
bestPlan = plan;
// Stop comparing if the costs are the minimum
if (plan.getCost() == PropertyIndexPlan.COST_OVERHEAD) {
break;
}
}
}
}
}
return bestPlan;
}
//--------------------------------------------------------< QueryIndex >--
@Override
public double getMinimumCost() {
return PropertyIndexPlan.COST_OVERHEAD;
}
@Override
public String getIndexName() {
return PROPERTY;
}
@Override
public double getCost(Filter filter, NodeState root) {
if (filter.getFullTextConstraint() != null) {
// not an appropriate index for full-text search
return Double.POSITIVE_INFINITY;
}
if (filter.containsNativeConstraint()) {
// not an appropriate index for native search
return Double.POSITIVE_INFINITY;
}
if (filter.getPropertyRestrictions().isEmpty()) {
// not an appropriate index for no property restrictions & selector constraints
return Double.POSITIVE_INFINITY;
}
PropertyIndexPlan plan = getPlan(root, filter);
if (plan != null) {
return plan.getCost();
} else {
return Double.POSITIVE_INFINITY;
}
}
@Override
public Cursor query(Filter filter, NodeState root) {
PropertyIndexPlan plan = getPlan(root, filter);
checkState(plan != null,
"Property index is used even when no index"
+ " is available for filter " + filter);
return plan.execute();
}
@Override
public String getPlan(Filter filter, NodeState root) {
PropertyIndexPlan plan = getPlan(root, filter);
if (plan != null) {
return plan.toString();
} else {
return "property index not applicable";
}
}
}