Package com.c8db.internal

Class C8EdgeCollectionImpl

java.lang.Object

com.c8db.internal.C8Executeable<E>

com.c8db.internal.InternalC8EdgeCollection<C8DBImpl,C8DatabaseImpl,C8GraphImpl,C8ExecutorSync>

com.c8db.internal.C8EdgeCollectionImpl

All Implemented Interfaces:

C8EdgeCollection, C8SerializationAccessor

public class C8EdgeCollectionImpl
extends InternalC8EdgeCollection<C8DBImpl,C8DatabaseImpl,C8GraphImpl,C8ExecutorSync>
implements C8EdgeCollection

Field Summary

Fields inherited from class com.c8db.internal.C8Executeable

context, executor, util

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	C8EdgeCollectionImpl(C8GraphImpl graph, String name)

Method Summary

Modifier and Type	Method	Description
void	deleteEdge(String key)	Removes a edge
void	deleteEdge(String key, EdgeDeleteOptions options)	Removes a edge
<T> T	getEdge(String key, Class<T> type)	Fetches an existing edge
<T> T	getEdge(String key, Class<T> type, GraphDocumentReadOptions options)	Fetches an existing edge
<T> EdgeEntity	insertEdge(T value)	Creates a new edge in the collection
<T> EdgeEntity	insertEdge(T value, EdgeCreateOptions options)	Creates a new edge in the collection
<T> EdgeUpdateEntity	replaceEdge(String key, T value)	Replaces the edge with key with the one in the body, provided there is such a edge and no precondition is violated
<T> EdgeUpdateEntity	replaceEdge(String key, T value, EdgeReplaceOptions options)	Replaces the edge with key with the one in the body, provided there is such a edge and no precondition is violated
<T> EdgeUpdateEntity	updateEdge(String key, T value)	Partially updates the edge identified by document-key.
<T> EdgeUpdateEntity	updateEdge(String key, T value, EdgeUpdateOptions options)	Partially updates the edge identified by document-key.

Methods inherited from class com.c8db.internal.InternalC8EdgeCollection

deleteEdgeRequest, getEdgeRequest, getEdgeResponseDeserializer, graph, insertEdgeRequest, insertEdgeResponseDeserializer, name, replaceEdgeRequest, replaceEdgeResponseDeserializer, updateEdgeRequest, updateEdgeResponseDeserializer

Methods inherited from class com.c8db.internal.C8Executeable

createPath, executor, request, util, util

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.c8db.C8EdgeCollection

graph, name

Methods inherited from interface com.c8db.C8SerializationAccessor

util, util

Constructor Detail

C8EdgeCollectionImpl

protected C8EdgeCollectionImpl(C8GraphImpl graph,
                               String name)

Method Detail

insertEdge

public <T> EdgeEntity insertEdge(T value)
                          throws C8DBException

Description copied from interface: C8EdgeCollection

Creates a new edge in the collection

Specified by:

insertEdge in interface C8EdgeCollection

Parameters:

value - A representation of a single edge (POJO, VPackSlice or String for JSON)

Returns:

information about the edge

Throws:

C8DBException

insertEdge

public <T> EdgeEntity insertEdge(T value,
                                 EdgeCreateOptions options)
                          throws C8DBException

Description copied from interface: C8EdgeCollection

Creates a new edge in the collection

Specified by:

insertEdge in interface C8EdgeCollection

Parameters:

value - A representation of a single edge (POJO, VPackSlice or String for JSON)

options - Additional options, can be null

Returns:

information about the edge

Throws:

C8DBException

See Also:

API Documentation

getEdge

public <T> T getEdge(String key,
                     Class<T> type)
              throws C8DBException

Description copied from interface: C8EdgeCollection

Fetches an existing edge

Specified by:

getEdge in interface C8EdgeCollection

Parameters:

key - The key of the edge

type - The type of the edge-document (POJO class, VPackSlice or String for JSON)

Returns:

the edge identified by the key

Throws:

C8DBException

See Also:

API Documentation

getEdge

public <T> T getEdge(String key,
                     Class<T> type,
                     GraphDocumentReadOptions options)
              throws C8DBException

Description copied from interface: C8EdgeCollection

Fetches an existing edge

Specified by:

getEdge in interface C8EdgeCollection

Parameters:

key - The key of the edge

type - The type of the edge-document (POJO class, VPackSlice or String for JSON)

options - Additional options, can be null

Returns:

the edge identified by the key

Throws:

C8DBException

See Also:

API Documentation

replaceEdge

public <T> EdgeUpdateEntity replaceEdge(String key,
                                        T value)
                                 throws C8DBException

Description copied from interface: C8EdgeCollection

Replaces the edge with key with the one in the body, provided there is such a edge and no precondition is violated

Specified by:

replaceEdge in interface C8EdgeCollection

Type Parameters:

T - The type of the edge-document (POJO class, VPackSlice or String for JSON)

Parameters:

key - The key of the edge

Returns:

information about the edge

Throws:

C8DBException

See Also:

API Documentation

replaceEdge

public <T> EdgeUpdateEntity replaceEdge(String key,
                                        T value,
                                        EdgeReplaceOptions options)
                                 throws C8DBException

Description copied from interface: C8EdgeCollection

Replaces the edge with key with the one in the body, provided there is such a edge and no precondition is violated

Specified by:

replaceEdge in interface C8EdgeCollection

Type Parameters:

T - The type of the edge-document (POJO class, VPackSlice or String for JSON)

Parameters:

key - The key of the edge

options - Additional options, can be null

Returns:

information about the edge

Throws:

C8DBException

See Also:

API Documentation

updateEdge

public <T> EdgeUpdateEntity updateEdge(String key,
                                       T value)
                                throws C8DBException

Description copied from interface: C8EdgeCollection

Partially updates the edge identified by document-key. The value must contain a document with the attributes to patch (the patch document). All attributes from the patch document will be added to the existing document if they do not yet exist, and overwritten in the existing document if they do exist there.

Specified by:

updateEdge in interface C8EdgeCollection

Type Parameters:

T - The type of the edge-document (POJO class, VPackSlice or String for JSON)

Parameters:

key - The key of the edge

Returns:

information about the edge

Throws:

C8DBException

See Also:

API Documentation

updateEdge

public <T> EdgeUpdateEntity updateEdge(String key,
                                       T value,
                                       EdgeUpdateOptions options)
                                throws C8DBException

Description copied from interface: C8EdgeCollection

Partially updates the edge identified by document-key. The value must contain a document with the attributes to patch (the patch document). All attributes from the patch document will be added to the existing document if they do not yet exist, and overwritten in the existing document if they do exist there.

Specified by:

updateEdge in interface C8EdgeCollection

Type Parameters:

T - The type of the edge-document (POJO class, VPackSlice or String for JSON)

Parameters:

key - The key of the edge

options - Additional options, can be null

Returns:

information about the edge

Throws:

C8DBException

See Also:

API Documentation

deleteEdge

public void deleteEdge(String key)
                throws C8DBException

Description copied from interface: C8EdgeCollection

Removes a edge

Specified by:

deleteEdge in interface C8EdgeCollection

Parameters:

key - The key of the edge

Throws:

C8DBException

See Also:

API Documentation

deleteEdge

public void deleteEdge(String key,
                       EdgeDeleteOptions options)
                throws C8DBException

Description copied from interface: C8EdgeCollection

Removes a edge

Specified by:

deleteEdge in interface C8EdgeCollection

Parameters:

key - The key of the edge

options - Additional options, can be null

Throws:

C8DBException

See Also:

API Documentation