oracle.pgx.api

Class GraphEntityCollection<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>

oracle.pgx.api.GraphEntityCollection<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>, oracle.pgx.common.IdentifiableCollection

Direct Known Subclasses:

EdgeCollection, VertexCollection

public abstract class GraphEntityCollection<E extends PgxEntity<ID>,ID>
extends PgxCollection<E,ID>

A collection of vertices/edges.

Method Summary

Modifier and Type	Method and Description
void	addAll(PgxEntity[] elements) Adds elements of a PgxEntity array to this collection.
PgxFuture<java.lang.Void>	addAllAsync(java.util.Collection<E> source)
void	addAllById(java.util.Collection<ID> source) Blocking version of addAllByIdAsync(Collection).
abstract void	addAllById(ID... ids) Replaces addAll(Object[]).
PgxFuture<java.lang.Void>	addAllByIdAsync(java.util.Collection<ID> source) Adds vertices/edges to an existing collection using their assiated IDs
PgxFuture<java.lang.Void>	addAllElementsAsync(java.util.Collection<E> source) Adds elements to an existing collection.
PgxFuture<java.lang.Boolean>	containsAsync(E element) Returns true if this collection contains the specified element.
PgxFuture<java.lang.Void>	removeAllAsync(java.util.Collection<E> source)
void	removeAllById(java.util.Collection<ID> source) Blocking version of removeAllByIdAsync(Collection).
abstract void	removeAllById(ID... ids) Replaces removeAll(Object[]).
PgxFuture<java.lang.Void>	removeAllByIdAsync(java.util.Collection<ID> source) Removes vertices/edges from an existing vertex/edge collection using their assiated IDs
PgxFuture<java.lang.Void>	removeAllElementsAsync(java.util.Collection<E> source) Removes elements from an existing collection.

Methods inherited from class oracle.pgx.api.PgxCollection

add, addAll, addAll, addAllAsync, addAllElements, clear, clearAsync, clone, clone, cloneAsync, cloneAsync, contains, destroyAsync, getCollectionType, getContentType, getGraph, getId, getIdType, getName, isMutable, isMutableAsync, iterator, iteratorAsync, remove, removeAll, removeAll, removeAllElements, size, sizeAsync, stream, toMutable, toMutable, toMutableAsync, toMutableAsync, toString

Methods inherited from class oracle.pgx.api.PgxManagedObject

equals, hashCode

Methods inherited from class oracle.pgx.api.Destroyable

close, destroy

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

addAll

public void addAll(PgxEntity[] elements)

Description copied from class: PgxCollection

Adds elements of a PgxEntity array to this collection.

Specified by:

addAll in class PgxCollection<E extends PgxEntity<ID>,ID>

Parameters:

elements - the PgxEntity array containing the elements to add

addAllAsync

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

Specified by:

addAllAsync in class PgxCollection<E extends PgxEntity<ID>,ID>

Parameters:

source - elements to add

addAllById

public void addAllById(java.util.Collection<ID> source)

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

addAllById

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

Replaces addAll(Object[]).

Parameters:

ids - elements to add

Throws:

java.util.concurrent.ExecutionException

java.lang.InterruptedException

addAllByIdAsync

public PgxFuture<java.lang.Void> addAllByIdAsync(java.util.Collection<ID> source)

Adds vertices/edges to an existing collection using their assiated IDs

Parameters:

source - collection of IDs of the elements to add

addAllElementsAsync

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

Description copied from class: PgxCollection

Adds elements to an existing collection. Replaces PgxCollection.addAllAsync(Collection).

Specified by:

addAllElementsAsync in class PgxCollection<E extends PgxEntity<ID>,ID>

Parameters:

source - elements to add

containsAsync

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

Description copied from class: PgxCollection

Returns true if this collection contains the specified element.

Specified by:

containsAsync in class PgxCollection<E extends PgxEntity<ID>,ID>

Parameters:

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

Returns:

true if this collection contains the specified element

removeAllAsync

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

Specified by:

removeAllAsync in class PgxCollection<E extends PgxEntity<ID>,ID>

Parameters:

source - elements to remove

removeAllById

public void removeAllById(java.util.Collection<ID> source)

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

removeAllById

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

Replaces removeAll(Object[]).

Parameters:

ids - elements to remove

Throws:

java.util.concurrent.ExecutionException

java.lang.InterruptedException

removeAllByIdAsync

public PgxFuture<java.lang.Void> removeAllByIdAsync(java.util.Collection<ID> source)

Removes vertices/edges from an existing vertex/edge collection using their assiated IDs

Parameters:

source - collection of IDs of the elements to remove

removeAllElementsAsync

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

Description copied from class: PgxCollection

Removes elements from an existing collection. Replaces PgxCollection.removeAllAsync(Collection).

Specified by:

removeAllElementsAsync in class PgxCollection<E extends PgxEntity<ID>,ID>

Parameters:

source - elements to remove