oracle.pgx.api

Class PgxEdge

java.lang.Object

oracle.pgx.api.internal.ApiObject

oracle.pgx.api.PgxEntity<java.lang.Long>

oracle.pgx.api.PgxEdge

public class PgxEdge
extends PgxEntity<java.lang.Long>

An edge of a PgxGraph.

Method Summary

Modifier and Type	Method and Description
<ID> PgxVertex<ID>	getDestination() Blocking version of getDestinationAsync().
<ID> PgxFuture<PgxVertex<ID>>	getDestinationAsync() Gets the destination vertex.
java.lang.String	getLabel() Blocking version of getLabelAsync().
PgxFuture<java.lang.String>	getLabelAsync() Gets the label.
<ID> PgxVertex<ID>	getSource() Blocking version of getSourceAsync().
<ID> PgxFuture<PgxVertex<ID>>	getSourceAsync() Gets the source vertex.
<ID> Pair<PgxVertex<ID>,PgxVertex<ID>>	getVertices() Blocking version of getVerticesAsync().
<ID> PgxFuture<Pair<PgxVertex<ID>,PgxVertex<ID>>>	getVerticesAsync() Gets both vertices of this edge as a pair.

Methods inherited from class oracle.pgx.api.PgxEntity

equals, getGraph, getId, getProperty, getPropertyAsync, getType, hashCode, setProperty, setPropertyAsync, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

getDestination

public <ID> PgxVertex<ID> getDestination()
                                  throws java.util.concurrent.ExecutionException,
                                         java.lang.InterruptedException

Blocking version of getDestinationAsync(). Calls getDestinationAsync() and waits for the returned PgxFuture to complete.

Throws:

java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.

java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.

getDestinationAsync

public <ID> PgxFuture<PgxVertex<ID>> getDestinationAsync()

Gets the destination vertex.

Returns:

the destination vertex.

getLabel

public java.lang.String getLabel()
                          throws java.util.concurrent.ExecutionException,
                                 java.lang.InterruptedException

Blocking version of getLabelAsync(). Calls getLabelAsync() and waits for the returned PgxFuture to complete.

Throws:

java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.

java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.

getLabelAsync

public PgxFuture<java.lang.String> getLabelAsync()

Gets the label.

Returns:

the edge label.

Throws:

java.lang.IllegalStateException - if this graph does not have any labels.

getSource

public <ID> PgxVertex<ID> getSource()
                             throws java.util.concurrent.ExecutionException,
                                    java.lang.InterruptedException

Blocking version of getSourceAsync(). Calls getSourceAsync() and waits for the returned PgxFuture to complete.

Throws:

java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.

java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.

getSourceAsync

public <ID> PgxFuture<PgxVertex<ID>> getSourceAsync()

Gets the source vertex.

Returns:

the source vertex.

getVertices

public <ID> Pair<PgxVertex<ID>,PgxVertex<ID>> getVertices()
                                                   throws java.util.concurrent.ExecutionException,
                                                          java.lang.InterruptedException

Blocking version of getVerticesAsync(). Calls getVerticesAsync() and waits for the returned the returned PgxFuture to complete.

Throws:

java.lang.InterruptedException - if the caller thread gets interrupted while waiting for completion.

java.util.concurrent.ExecutionException - if any exception occurred during asynchronous execution. The actual exception will be nested.

getVerticesAsync

public <ID> PgxFuture<Pair<PgxVertex<ID>,PgxVertex<ID>>> getVerticesAsync()

Gets both vertices of this edge as a pair. In the directed case, the first part of the pair is the source and the second one the destination vertex.

Returns:

the source and the destination vertex as a pair