org.neo4j.jdbc.values.Relationship Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of neo4j-jdbc Show documentation

Implementation of the Neo4j JDBC driver.

There is a newer version: 6.0.1

/*
 * Copyright (c) 2023-2024 "Neo4j,"
 * Neo4j Sweden AB [https://neo4j.com]
 *
 * This file is part of Neo4j.
 *
 * Licensed 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
 *
 *     https://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.neo4j.jdbc.values;

/**
 * The Relationship interface describes the characteristics of a
 * relationship from a Neo4j graph.
 *
 * @author Neo4j Drivers Team
 * @since 6.0.0
 */
public interface Relationship extends Entity {

	/**
	 * The id of the node where this relationship starts.
	 * @return the node id
	 */
	String startNodeElementId();

	/**
	 * The id of the node where this relationship ends.
	 * @return the node id
	 */
	String endNodeElementId();

	/**
	 * Return the type of this relationship.
	 * @return the type name
	 */
	String type();

	/**
	 * Test if this relationship has the given type.
	 * @param relationshipType the give relationship type
	 * @return {@code true} if this relationship has the given relationship type otherwise
	 * {@code false}
	 */
	boolean hasType(String relationshipType);

}