org.neo4j.graphdb.traversal.PathEvaluator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of neo4j-graphdb-api Show documentation
Graph Database API for Neo4j.
There is a newer version: 5.25.1
/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [http://neo4j.com]
 *
 * This file is part of Neo4j.
 *
 * Neo4j is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see .
 */
package org.neo4j.graphdb.traversal;

import org.neo4j.annotations.api.PublicApi;
import org.neo4j.graphdb.Path;

/**
 * A PathEvaluator controls what's to be returned from a traversal and also how
 * pruning is done. It looks at a {@link Path} and {@link BranchState}and decides
 * whether or not it should be included in the traversal result. It also decides
 * whether the traverser should continue down that path or if it should be pruned
 * so that the traverser won't continue down that path.
 *
 * @param  type of state each branch holds.
 * @see Evaluation
 * @see Evaluators
 * @see TraversalDescription#evaluator(PathEvaluator)
 */
@PublicApi
public interface PathEvaluator extends Evaluator
{
    /**
     * Evaluates a {@link Path} and returns an {@link Evaluation} containing
     * information about whether or not to include it in the traversal result,
     * i.e return it from the {@link Traverser}. And also whether or not to
     * continue traversing down that {@code path} or if it instead should be
     * pruned so that the traverser won't continue down that branch represented
     * by {@code path}.
     *
     * @param path the {@link Path} to evaluate.
     * @param state the state of this branch in the current traversal.
     * @return an {@link Evaluation} containing information about whether or not
     * to return it from the {@link Traverser} and whether or not to continue
     * down that path.
     */
    Evaluation evaluate( Path path, BranchState state );

    /**
     * Adapter for {@link PathEvaluator}.
     * @param  the type of the state object
     */
    abstract class Adapter implements PathEvaluator
    {
        @Override
        @SuppressWarnings( "unchecked" )
        public Evaluation evaluate( Path path )
        {
            return evaluate( path, BranchState.NO_STATE );
        }
    }
}