org.apache.jackrabbit.oak.plugins.observation.filter.Selectors Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of oak-core Show documentation
There is a newer version: 1.62.0
/*
 * 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.observation.filter;

import static org.apache.jackrabbit.oak.plugins.memory.EmptyNodeState.MISSING_NODE;

import javax.annotation.CheckForNull;
import javax.annotation.Nonnull;

import org.apache.jackrabbit.oak.api.PropertyState;
import org.apache.jackrabbit.oak.plugins.observation.filter.UniversalFilter.Selector;
import org.apache.jackrabbit.oak.spi.state.NodeState;

/**
 * Common {@code Selector} implementations
 */
public final class Selectors {

    /**
     * A selector returning the node for which a call back on {@link EventFilter} was
     * called or a non existing node in the case of a property call back.
     */
    public static final Selector THIS = new ThisSelector();

    /**
     * A selector returning the parent node of the item for which a call back
     * on {@link EventFilter} was called.
     */
    public static final Selector PARENT = new ParentSelector();

    /**
     * A selector returning the node at {@code relPath} relative to
     * {@link #THIS}
     * @param relPath  relative path
     * @return  selector for {@code relPath} from {@code THIS}
     */
    @Nonnull
    public static Selector fromThis(@Nonnull String relPath) {
        return new RelativePathSelector(relPath, THIS);
    }

    /**
     * A selector returning the node at {@code relPath} relative to
     * {@link #PARENT}
     * @param relPath  relative path
     * @return  selector for {@code relPath} from {@code PARENT}
     */
    @Nonnull
    public static Selector fromParent(@Nonnull String relPath) {
        return new RelativePathSelector(relPath, PARENT);
    }

    private Selectors() {
    }

    private static class ThisSelector implements Selector {
        @Override
        public NodeState select(@Nonnull UniversalFilter filter,
                @CheckForNull PropertyState before, @CheckForNull PropertyState after) {
            return MISSING_NODE;
        }

        @Override
        public NodeState select(@Nonnull UniversalFilter filter, @Nonnull String name,
                @Nonnull NodeState before, @Nonnull NodeState after) {
            return after.exists()
                    ? after
                    : before;
        }
    }

    private static class ParentSelector implements Selector {
        @Override
        public NodeState select(@Nonnull UniversalFilter filter,
                @CheckForNull PropertyState before, @CheckForNull PropertyState after) {
            return after != null
                    ? filter.getAfterState()
                    : filter.getBeforeState();
        }

        @Override
        public NodeState select(@Nonnull UniversalFilter filter, @Nonnull String name,
                @Nonnull NodeState before, @Nonnull NodeState after) {
            return after.exists()
                    ? filter.getAfterState()
                    : filter.getBeforeState();
        }
    }
}