oracle.pgx.api

Class PgxVertex<ID>

java.lang.Object

oracle.pgx.api.internal.ApiObject

oracle.pgx.api.PgxEntity<ID>

oracle.pgx.api.PgxVertex<ID>

Type Parameters:

ID - the vertex ID type

public class PgxVertex<ID>
extends PgxEntity<ID>

A vertex of a PgxGraph.

Method Summary

Modifier and Type	Method and Description
long	getDegree() Convenience method that calls getOutDegree().
PgxFuture<java.lang.Long>	getDegreeAsync() Returns the degree of this vertex by calling getOutDegreeAsync().
long	getInDegree() Blocking version of getInDegreeAsync().
PgxFuture<java.lang.Long>	getInDegreeAsync() Returns the inDegree of this vertex, i.e., the number of incoming edges of this vertex.
java.util.Collection<PgxEdge>	getInEdges() Blocking version of getInEdges().
PgxFuture<java.util.Collection<PgxEdge>>	getInEdgesAsync() Returns all incoming edges of this vertex.
java.util.Collection<PgxVertex<ID>>	getInNeighbors() Blocking version of getInNeighborsAsync() .
PgxFuture<java.util.Collection<PgxVertex<ID>>>	getInNeighborsAsync() Returns all incoming neighbors of this vertex, i.e., all vertices that have an edge to this vertex.
java.util.Set<java.lang.String>	getLabels() Blocking version of getLabelsAsync().
PgxFuture<java.util.Set<java.lang.String>>	getLabelsAsync() Gets the labels
java.util.Collection<PgxVertex<ID>>	getNeighbors(Direction direction) Convenience method for getNeighbors(Direction, boolean) that keeps all duplicates.
java.util.Collection<PgxVertex<ID>>	getNeighbors(Direction direction, boolean removeDuplicates) Blocking version of getNeighborsAsync(Direction, boolean) .
PgxFuture<java.util.Collection<PgxVertex<ID>>>	getNeighborsAsync(Direction direction, boolean removeDuplicates) Returns all neighbors of this vertex, i.e., all vertices that are connected to this vertex.
long	getOutDegree() Blocking version of getOutDegreeAsync().
PgxFuture<java.lang.Long>	getOutDegreeAsync() Returns the outDegree of this vertex, i.e., the number of outgoing edges of this vertex.
java.util.Collection<PgxEdge>	getOutEdges() Blocking version of getOutEdges().
PgxFuture<java.util.Collection<PgxEdge>>	getOutEdgesAsync() Returns all outgoing edges of this vertex.
java.util.Collection<PgxVertex<ID>>	getOutNeighbors() Blocking version of getOutNeighborsAsync().
PgxFuture<java.util.Collection<PgxVertex<ID>>>	getOutNeighborsAsync() Returns all outgoing neighbors of this vertex, i.e., all nodes this vertex has an edge to.

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

getDegree

public long getDegree()
               throws java.util.concurrent.ExecutionException,
                      java.lang.InterruptedException

Convenience method that calls getOutDegree().

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.

getDegreeAsync

public PgxFuture<java.lang.Long> getDegreeAsync()

Returns the degree of this vertex by calling getOutDegreeAsync().

getInDegree

public long getInDegree()
                 throws java.util.concurrent.ExecutionException,
                        java.lang.InterruptedException

Blocking version of getInDegreeAsync(). Calls getInDegreeAsync() 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.

getInDegreeAsync

public PgxFuture<java.lang.Long> getInDegreeAsync()

Returns the inDegree of this vertex, i.e., the number of incoming edges of this vertex.

getInEdges

public java.util.Collection<PgxEdge> getInEdges()
                                         throws java.util.concurrent.ExecutionException,
                                                java.lang.InterruptedException

Blocking version of getInEdges(). Calls getInEdges() 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.

getInEdgesAsync

public PgxFuture<java.util.Collection<PgxEdge>> getInEdgesAsync()

Returns all incoming edges of this vertex. This method does not guarantee any ordering in the result. This method never returns null.

getInNeighbors

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

Blocking version of getInNeighborsAsync() . Calls getInNeighborsAsync() and waits for 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.

getInNeighborsAsync

public PgxFuture<java.util.Collection<PgxVertex<ID>>> getInNeighborsAsync()

Returns all incoming neighbors of this vertex, i.e., all vertices that have an edge to this vertex. If the graph is a multi-graph and if a vertex 'A' has multiple edges to this vertex, then 'A' will appear multiple times in the result, i.e. once per edge from 'A' to this vertex. This method does not guarantee any ordering in the result. This method never returns null.

getLabels

public java.util.Set<java.lang.String> getLabels()
                                          throws java.util.concurrent.ExecutionException,
                                                 java.lang.InterruptedException

Blocking version of getLabelsAsync(). Calls getLabelsAsync() 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.

getLabelsAsync

public PgxFuture<java.util.Set<java.lang.String>> getLabelsAsync()

Gets the labels

Returns:

the vertex labels.

Throws:

java.lang.IllegalStateException - if no labels exist.

getNeighbors

public java.util.Collection<PgxVertex<ID>> getNeighbors(Direction direction)
                                                 throws java.util.concurrent.ExecutionException,
                                                        java.lang.InterruptedException

Convenience method for getNeighbors(Direction, boolean) that keeps all duplicates.

Throws:

java.util.concurrent.ExecutionException

java.lang.InterruptedException

getNeighbors

public java.util.Collection<PgxVertex<ID>> getNeighbors(Direction direction,
                                                        boolean removeDuplicates)
                                                 throws java.util.concurrent.ExecutionException,
                                                        java.lang.InterruptedException

Blocking version of getNeighborsAsync(Direction, boolean) . Calls getNeighbors(Direction, boolean) and waits for 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.

getNeighborsAsync

public PgxFuture<java.util.Collection<PgxVertex<ID>>> getNeighborsAsync(Direction direction,
                                                                        boolean removeDuplicates)

Returns all neighbors of this vertex, i.e., all vertices that are connected to this vertex.

Parameters:

removeDuplicates - If removeDuplicates is set to true, the resulting collection does not contain any duplicates. Otherwise, if this vertex is connected 'N' times to a vertex 'X', vertex 'X' also appears 'N' times in the results. This method does not guarantee any ordering in the result. This method never returns null.

getOutDegree

public long getOutDegree()
                  throws java.util.concurrent.ExecutionException,
                         java.lang.InterruptedException

Blocking version of getOutDegreeAsync(). Calls getOutDegreeAsync() 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.

getOutDegreeAsync

public PgxFuture<java.lang.Long> getOutDegreeAsync()

Returns the outDegree of this vertex, i.e., the number of outgoing edges of this vertex.

getOutEdges

public java.util.Collection<PgxEdge> getOutEdges()
                                          throws java.util.concurrent.ExecutionException,
                                                 java.lang.InterruptedException

Blocking version of getOutEdges(). Calls getOutEdges() 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.

getOutEdgesAsync

public PgxFuture<java.util.Collection<PgxEdge>> getOutEdgesAsync()

Returns all outgoing edges of this vertex. This method does not guarantee any ordering in the result. This method never returns null.

getOutNeighbors

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

Blocking version of getOutNeighborsAsync(). Calls getOutNeighborsAsync() and waits for 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.

getOutNeighborsAsync

public PgxFuture<java.util.Collection<PgxVertex<ID>>> getOutNeighborsAsync()

Returns all outgoing neighbors of this vertex, i.e., all nodes this vertex has an edge to. If the graph is a multi-graph and if the vertex has multiple edges to a vertex 'A', then 'A' will appear multiple times in the result, i.e., once per edge to 'A'. This method does not guarantee any ordering in the result. This method never returns null.