oracle.pgx.api

Class PgxCollection<E extends PgxEntity<ID>,ID>

java.lang.Object

oracle.pgx.api.internal.ApiObject

oracle.pgx.api.Destroyable

oracle.pgx.api.PgxManagedObject

oracle.pgx.api.PgxCollection<E,ID>

Type Parameters:

E - the element type

ID - the ID type of the element type

All Implemented Interfaces:

java.lang.AutoCloseable, java.lang.Iterable<E>

Direct Known Subclasses:

EdgeCollection, VertexCollection

public abstract class PgxCollection<E extends PgxEntity<ID>,ID>
extends PgxManagedObject
implements java.lang.Iterable<E>

A collection vertices/edges.

Method Summary

Modifier and Type	Method and Description
void	add(E entity) Adds one element to this collection.
void	addAll(java.util.Collection<E> source) Blocking version of addAllAsync(Collection).
void	addAll(E[] elements) Blocking version of addAllAsync(PgxEntity[]).
abstract void	addAll(ID... ids)
PgxFuture<java.lang.Void>	addAllAsync(java.util.Collection<E> source) Add vertices/edges to an existing vertex/edge collection
PgxFuture<java.lang.Void>	addAllAsync(E[] elements) Add vertices/edges to an existing vertex/edge collection
void	clear() Blocking version of clearAsync().
PgxFuture<java.lang.Void>	clearAsync() Clear an existing vertex/edge collection
PgxCollection<E,ID>	clone()
PgxCollection<E,ID>	clone(java.lang.String newName) Blocking version of clone(String).
PgxFuture<PgxCollection<E,ID>>	cloneAsync() Convenience method around cloneAsync(String) passing name as null Clone an existing vertex/edge collection.
PgxFuture<PgxCollection<E,ID>>	cloneAsync(java.lang.String newName) Clone an existing vertex/edge collection.
boolean	contains(E element) Blocking version of containsAsync(PgxEntity).
PgxFuture<java.lang.Boolean>	containsAsync(E element) Returns true if this collection contains the specified element.
CollectionType	getCollectionType() Gets the collection type.
EntityType	getElementType() Gets the element type.
PgxGraph	getGraph() Gets the graph.
abstract IdType	getIdType() Gets the ID type of the element type.
java.lang.String	getName()
boolean	isMutable() Blocking version of isMutableAsync().
PgxFuture<java.lang.Boolean>	isMutableAsync() Checks whether an existing vertex/edge collection is mutable
java.util.Iterator<E>	iterator() Blocking version of iteratorAsync().
PgxFuture<java.util.Iterator<E>>	iteratorAsync() Gets an Iterator over the collection.
void	removeAll(java.util.Collection<E> source) Blocking version of removeAllAsync(Collection).
abstract void	removeAll(ID... ids)
PgxFuture<java.lang.Void>	removeAllAsync(java.util.Collection<E> source) Remove vertices/edges from an existing vertex/edge collection
int	size() Blocking version of sizeAsync().
PgxFuture<java.lang.Integer>	sizeAsync() Gets the number of elements in this collection
PgxCollection<E,ID>	toMutable() Blocking version of toMutableAsync().
PgxCollection<E,ID>	toMutable(java.lang.String newName) Blocking version of toMutableAsync(String).
PgxFuture<PgxCollection<E,ID>>	toMutableAsync() Create a mutable copy of an existing vertex/edge collection Convenience method around toMutableAsync(String) passing name as null
PgxFuture<PgxCollection<E,ID>>	toMutableAsync(java.lang.String newName) Create a mutable copy of an existing vertex/edge collection
java.lang.String	toString()

Methods inherited from class oracle.pgx.api.PgxManagedObject

equals, hashCode

Methods inherited from class oracle.pgx.api.Destroyable

close, destroy, destroyAsync

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

add

public void add(E entity)
         throws java.util.concurrent.ExecutionException,
                java.lang.InterruptedException

Adds one element to this collection.

Parameters:

entity - the entity

Throws:

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

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

addAll

public void addAll(java.util.Collection<E> source)
            throws java.util.concurrent.ExecutionException,
                   java.lang.InterruptedException

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

addAll

public void addAll(E[] elements)
            throws java.util.concurrent.ExecutionException,
                   java.lang.InterruptedException

Blocking version of addAllAsync(PgxEntity[]). Calls addAllAsync(PgxEntity[]) 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.

addAll

public abstract void addAll(ID... ids)
                     throws java.util.concurrent.ExecutionException,
                            java.lang.InterruptedException

Throws:

java.util.concurrent.ExecutionException

java.lang.InterruptedException

addAllAsync

public PgxFuture<java.lang.Void> addAllAsync(java.util.Collection<E> source)

Add vertices/edges to an existing vertex/edge collection

Parameters:

source - vertices/edges to add

addAllAsync

public PgxFuture<java.lang.Void> addAllAsync(E[] elements)

Add vertices/edges to an existing vertex/edge collection

Parameters:

elements - vertices/edges to add

clear

public void clear()
           throws java.util.concurrent.ExecutionException,
                  java.lang.InterruptedException

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

clearAsync

public PgxFuture<java.lang.Void> clearAsync()

Clear an existing vertex/edge collection

clone

public PgxCollection<E,ID> clone()

Overrides:

clone in class java.lang.Object

clone

public PgxCollection<E,ID> clone(java.lang.String newName)
                          throws java.lang.InterruptedException,
                                 java.util.concurrent.ExecutionException

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

Throws:

java.util.concurrent.ExecutionException

java.lang.InterruptedException

cloneAsync

public PgxFuture<PgxCollection<E,ID>> cloneAsync()

Convenience method around cloneAsync(String) passing name as null
Clone an existing vertex/edge collection.

Returns:

the cloned collection

cloneAsync

public PgxFuture<PgxCollection<E,ID>> cloneAsync(java.lang.String newName)

Clone an existing vertex/edge collection.

Parameters:

newName - name of the new collection

Returns:

the cloned collection

contains

public boolean contains(E element)
                 throws java.util.concurrent.ExecutionException,
                        java.lang.InterruptedException

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

Throws:

java.util.concurrent.ExecutionException

java.lang.InterruptedException

containsAsync

public PgxFuture<java.lang.Boolean> containsAsync(E element)

Returns true if this collection contains the specified element.

Parameters:

element - element whose presence in this collection is to be tested

Returns:

true if this collection contains the specified element

getCollectionType

public CollectionType getCollectionType()

Gets the collection type.

Returns:

the collection type

getElementType

public EntityType getElementType()

Gets the element type.

Returns:

the element type

getGraph

public PgxGraph getGraph()

Gets the graph.

Returns:

the graph this PgxCollection is bound to

getIdType

public abstract IdType getIdType()

Gets the ID type of the element type.

Returns:

the ID type of the element type.

getName

public java.lang.String getName()

Specified by:

getName in class PgxManagedObject

Returns:

the name identifying this managed object

isMutable

public boolean isMutable()
                  throws java.util.concurrent.ExecutionException,
                         java.lang.InterruptedException

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

isMutableAsync

public PgxFuture<java.lang.Boolean> isMutableAsync()

Checks whether an existing vertex/edge collection is mutable

Returns:

true if the collection is mutable, false if it is immutable

iterator

public java.util.Iterator<E> iterator()

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

Specified by:

iterator in interface java.lang.Iterable<E extends PgxEntity<ID>>

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.

iteratorAsync

public PgxFuture<java.util.Iterator<E>> iteratorAsync()

Gets an Iterator over the collection.

Returns:

an Iterator over the collection

removeAll

public void removeAll(java.util.Collection<E> source)
               throws java.util.concurrent.ExecutionException,
                      java.lang.InterruptedException

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

removeAll

public abstract void removeAll(ID... ids)
                        throws java.util.concurrent.ExecutionException,
                               java.lang.InterruptedException

Throws:

java.util.concurrent.ExecutionException

java.lang.InterruptedException

removeAllAsync

public PgxFuture<java.lang.Void> removeAllAsync(java.util.Collection<E> source)

Remove vertices/edges from an existing vertex/edge collection

Parameters:

source - vertices/edges to remove

size

public int size()
         throws java.util.concurrent.ExecutionException,
                java.lang.InterruptedException

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

sizeAsync

public PgxFuture<java.lang.Integer> sizeAsync()

Gets the number of elements in this collection

Returns:

number of elements in this collection

toMutable

public PgxCollection<E,ID> toMutable()
                              throws java.util.concurrent.ExecutionException,
                                     java.lang.InterruptedException

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

toMutable

public PgxCollection<E,ID> toMutable(java.lang.String newName)
                              throws java.util.concurrent.ExecutionException,
                                     java.lang.InterruptedException

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

toMutableAsync

public PgxFuture<PgxCollection<E,ID>> toMutableAsync()

Create a mutable copy of an existing vertex/edge collection
Convenience method around toMutableAsync(String) passing name as null

Returns:

the mutable copy

toMutableAsync

public PgxFuture<PgxCollection<E,ID>> toMutableAsync(java.lang.String newName)

Create a mutable copy of an existing vertex/edge collection

Parameters:

newName - name of the new collection

Returns:

the mutable copy

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object