com.graphaware.runtime.walk.RelationshipSelector Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of runtime Show documentation

Runtime for GraphAware Runtime Modules

There is a newer version: 4.2.0.58

/*
 * Copyright (c) 2013-2016 GraphAware
 *
 * This file is part of the GraphAware Framework.
 *
 * GraphAware Framework 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 com.graphaware.runtime.walk;

import org.neo4j.graphdb.Node;
import org.neo4j.graphdb.Relationship;

/**
 * Mechanism by which a {@link Node}'s {@link Relationship} is selected.
 * 
 * This is useful for graph walks.
 */
public interface RelationshipSelector {

    /**
     * Select a relationship of the node.
     *
     * @param node for which to select a relationship.
     * @return A {@link org.neo4j.graphdb.Relationship} of the given node, null if a relationship can't be selected
     *         for whatever reason, perhaps because the node has no (matching) relationships.
     */
    Relationship selectRelationship(Node node);
}