IndexChangeAdapter.java

/*
 * ModeShape (http://www.modeshape.org)
 *
 * Licensed 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.modeshape.jcr.spi.index.provider;

import java.util.Set;
import org.modeshape.common.logging.Logger;
import org.modeshape.jcr.ExecutionContext;
import org.modeshape.jcr.cache.CachedNode.Properties;
import org.modeshape.jcr.cache.NodeKey;
import org.modeshape.jcr.cache.change.ChangeSetAdapter;
import org.modeshape.jcr.value.Name;
import org.modeshape.jcr.value.Path;

/**
 * Base class for all index-related changes.
 * 
 * @author Randall Hauch (rhauch@redhat.com)
 * @author Horia Chiorean (hchiorea@redhat.com)
 */
public abstract class IndexChangeAdapter extends ChangeSetAdapter {

    protected final String workspaceName;
    protected final ProvidedIndex<?> index;
    protected final Logger logger;

    protected IndexChangeAdapter( ExecutionContext context,
                                  String workspaceName,
                                  NodeTypePredicate predicate,
                                  ProvidedIndex<?> index ) {
        super(context, predicate);
        assert index != null;
        this.index = index;
        assert workspaceName != null;
        this.workspaceName = workspaceName;
        this.logger = Logger.getLogger(getClass());
    }

    @Override
    protected boolean includesWorkspace( String workspaceName ) {
        return this.workspaceName.equals(workspaceName);
    }

    /**
     * Reindex the specific node.
     *
     * @param workspaceName the workspace in which the node information should be available; may not be null
     * @param key the unique key for the node; may not be null
     * @param path the path of the node; may not be null
     * @param primaryType the primary type of the node; may not be null
     * @param mixinTypes the mixin types for the node; may not be null but may be empty
     * @param properties the properties of the node; may not be null but may be empty
     * @param queryable true if the node is queryable, false otherwise
     * @return {@code true} if the reindexing operation took place, or {@code false} if no reindexing was performed because
     * the {@link #predicate} failed.
     */
    protected final boolean reindex( String workspaceName,
                                     NodeKey key,
                                     Path path,
                                     Name primaryType,
                                     Set<Name> mixinTypes,
                                     Properties properties,
                                     boolean queryable ) {
        if (predicate.matchesType(primaryType, mixinTypes)) {
            reindexNode(workspaceName, key, path, primaryType, mixinTypes, properties, queryable);
            return true;
        }
        return false;
    }
    
    protected static String nodeKey( NodeKey key ) {
        return key.toString();
    }
    
    protected void clearDataFor( NodeKey key ) {
        index.remove(nodeKey(key));
    }

    @SuppressWarnings("unchecked")
    protected <T> ProvidedIndex<T> index() {
        return (ProvidedIndex<T>)index;
    }

    @Override
    protected void completeChanges() {
        index.commit();
    }

    @Override
    protected void completeWorkspaceChanges() {
        index.commit();
    }

    @Override
    public String toString() {
        return getClass().getSimpleName() + "(\"" + index.getName() + "\")";
    }
}