org.neo4j.kernel.Expansion Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2002-2015 "Neo Technology,"
 * Network Engine for Objects in Lund AB [http://neotechnology.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.kernel;

import org.neo4j.function.Predicate;
import org.neo4j.graphdb.Direction;
import org.neo4j.graphdb.Expander;
import org.neo4j.graphdb.Node;
import org.neo4j.graphdb.Relationship;
import org.neo4j.graphdb.RelationshipType;
import org.neo4j.helpers.Pair;

// Tentative Expansion API
interface Expansion extends Iterable
{
    Expander expander();

    Expansion nodes();

    Expansion relationships();

    Expansion> pairs();

    Expansion including( RelationshipType type );

    Expansion including( RelationshipType type, Direction direction );

    Expansion excluding( RelationshipType type );

    /**
     * @deprecated use {@link #filterNodes(Predicate)} instead
     */
    @Deprecated
    Expansion filterNodes( org.neo4j.helpers.Predicate filter );

    Expansion filterNodes( Predicate filter );

    /**
     * @deprecated use {@link #filterRelationships(Predicate)} instead
     */
    @Deprecated
    Expansion filterRelationships( org.neo4j.helpers.Predicate filter );

    Expansion filterRelationships( Predicate filter );

    boolean isEmpty();

    T getSingle();
}