org.neo4j.storageengine.api.RelationshipItem Maven / Gradle / Ivy

Go to download
/*
 * Copyright (c) 2002-2016 "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.storageengine.api;

/**
 * Represents a single relationship from a cursor.
 */
public interface RelationshipItem
        extends EntityItem
{
    /**
     * @return relationship type for current relationship
     */
    int type();

    /**
     * @return start node of this relationship
     */
    long startNode();

    /**
     * @return end node of this relationship
     */
    long endNode();

    /**
     *
     * @param nodeId of the node you are not interested in
     * @return end node if start node is passed in, start node if end node is passed
     */
    long otherNode( long nodeId );
}