oracle.pgx.api

Class ComponentCollection<ID>

java.lang.Object

oracle.pgx.api.internal.ApiObject

oracle.pgx.api.Destroyable

oracle.pgx.api.PgxManagedObject

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

oracle.pgx.api.VertexCollection<ID>

oracle.pgx.api.ComponentCollection<ID>

All Implemented Interfaces:

java.lang.AutoCloseable, java.lang.Iterable<PgxVertex<ID>>

public class ComponentCollection<ID>
extends VertexCollection<ID>

Constructor Summary

Constructors

Constructor and Description
ComponentCollection(PgxGraph graph, java.lang.String collectionNamespace, long id)

Method Summary

Modifier and Type	Method and Description
PgxFuture<java.lang.Void>	addAllAsync(java.util.Collection<PgxVertex<ID>> source) Add vertices/edges to an existing vertex/edge collection
PgxFuture<java.lang.Void>	clearAsync() Clear an existing vertex/edge collection
PgxFuture<PgxCollection<PgxVertex<ID>,ID>>	cloneAsync(java.lang.String newName) Clone an existing vertex/edge collection.
PgxFuture<java.lang.Boolean>	containsAsync(PgxVertex<ID> element) Returns true if this collection contains the specified element.
PgxFuture<java.lang.Void>	destroyAsync(boolean ignoreNotFound)
boolean	isMutable() Blocking version of PgxCollection.isMutableAsync().
PgxFuture<java.lang.Boolean>	isMutableAsync() Checks whether an existing vertex/edge collection is mutable
PgxFuture<java.lang.Void>	removeAllAsync(java.util.Collection<PgxVertex<ID>> source) Remove vertices/edges from an existing vertex/edge collection
PgxFuture<PgxCollection<PgxVertex<ID>,ID>>	toMutableAsync(java.lang.String newName) Create a mutable copy of an existing vertex/edge collection

Methods inherited from class oracle.pgx.api.VertexCollection

addAll, getIdType, removeAll

Methods inherited from class oracle.pgx.api.PgxCollection

add, addAll, addAll, addAllAsync, clear, clone, clone, cloneAsync, contains, getCollectionType, getElementType, getGraph, getName, iterator, iteratorAsync, removeAll, size, sizeAsync, toMutable, toMutable, toMutableAsync, 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

Constructor Detail

ComponentCollection

public ComponentCollection(PgxGraph graph,
                           java.lang.String collectionNamespace,
                           long id)

Method Detail

addAllAsync

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

Description copied from class: PgxCollection

Add vertices/edges to an existing vertex/edge collection

Overrides:

addAllAsync in class PgxCollection<PgxVertex<ID>,ID>

Parameters:

source - vertices/edges to add

clearAsync

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

Description copied from class: PgxCollection

Clear an existing vertex/edge collection

Overrides:

clearAsync in class PgxCollection<PgxVertex<ID>,ID>

cloneAsync

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

Description copied from class: PgxCollection

Clone an existing vertex/edge collection.

Overrides:

cloneAsync in class PgxCollection<PgxVertex<ID>,ID>

Parameters:

newName - name of the new collection

Returns:

the cloned collection

containsAsync

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

Description copied from class: PgxCollection

Returns true if this collection contains the specified element.

Overrides:

containsAsync in class PgxCollection<PgxVertex<ID>,ID>

Parameters:

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

Returns:

true if this collection contains the specified element

destroyAsync

public PgxFuture<java.lang.Void> destroyAsync(boolean ignoreNotFound)

Parameters:

ignoreNotFound - if true, do not treat the absence of this object on the server-side as an error case.

isMutable

public boolean isMutable()

Description copied from class: PgxCollection

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

Overrides:

isMutable in class PgxCollection<PgxVertex<ID>,ID>

isMutableAsync

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

Description copied from class: PgxCollection

Checks whether an existing vertex/edge collection is mutable

Overrides:

isMutableAsync in class PgxCollection<PgxVertex<ID>,ID>

Returns:

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

removeAllAsync

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

Description copied from class: PgxCollection

Remove vertices/edges from an existing vertex/edge collection

Overrides:

removeAllAsync in class PgxCollection<PgxVertex<ID>,ID>

Parameters:

source - vertices/edges to remove

toMutableAsync

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

Description copied from class: PgxCollection

Create a mutable copy of an existing vertex/edge collection

Overrides:

toMutableAsync in class PgxCollection<PgxVertex<ID>,ID>

Parameters:

newName - name of the new collection

Returns:

the mutable copy