10000 Merge branch 'master' of https://github.com/arangodb/arangodb-java-dr… · anderick/arangodb-java-driver@7007a58 · GitHub
[go: up one dir, main page]
Skip to content

Commit 7007a58

Browse files
scottashtonscottashton
committed
2 parents 5fd8764 + 0371287 commit 7007a58

File tree

1 file changed

+60
-27
lines changed

1 file changed

+60
-27
lines changed

‎src/main/java/com/arangodb/ArangoDriver.java

Lines changed: 60 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -2335,7 +2335,7 @@ public ReplicationApplierStateEntity getReplicationApplierState() throws ArangoE
23352335
* Returns a GraphsEntity containing all graph as GraphEntity object of the
23362336
* default database.
23372337
*
2338-
* @return GraphsEntity
2338+
* @return GraphsEntity Object containing all graphs of the database.
23392339
* @throws ArangoException
23402340
*/
23412341
public GraphsEntity getGraphs() throws ArangoException {
@@ -2346,7 +2346,7 @@ public GraphsEntity getGraphs() throws ArangoException {
23462346
* Creates a list of the names of all available graphs of the default
23472347
* database.
23482348
*
2349-
* @return List<String>
2349+
* @return List<String> All graph names of the database.
23502350
* @throws ArangoException
23512351
*/
23522352
public List<String> getGraphList() throws ArangoException {
@@ -2357,10 +2357,14 @@ public List<String> getGraphList() throws ArangoException {
23572357
* Creates a graph.
23582358
*
23592359
* @param graphName
2360+
* The name of the graph to be created.
23602361
* @param edgeDefinitions
2362+
* List of the graphs edge definitions.
23612363
* @param orphanCollections
2364+
* List of the graphs orphan collections.
23622365
* @param waitForSync
2363-
* @return GraphEntity
2366+
* Wait for sync.
2367+
* @return GraphEntity The new graph.
23642368
* @throws ArangoException
23652369
*/
23662370
public GraphEntity createGraph(
@@ -2375,8 +2379,10 @@ public GraphEntity createGraph(
23752379
* Creates an empty graph.
23762380
*
23772381
* @param graphName
2382+
* The name of the graph to be created.
23782383
* @param waitForSync
2379-
* @return GraphEntity
2384+
* Wait for sync.
2385+
* @return GraphEntity The new graph.
23802386
* @throws ArangoException
23812387
*/
23822388
public GraphEntity createGraph(String graphName, Boolean waitForSync) throws ArangoException {
@@ -2388,7 +2394,8 @@ public GraphEntity createGraph(String graphName, Boolean waitForSync) throws Ara
23882394
* collections.
23892395
*
23902396
* @param graphName
2391-
* @return GraphEntity
2397+
* The name of the graph.
2398+
* @return GraphEntity The graph.
23922399
* @throws ArangoException
23932400
*/
23942401
public GraphEntity getGraph(String graphName) throws ArangoException {
@@ -2400,6 +2407,8 @@ public GraphEntity getGraph(String graphName) throws ArangoException {
24002407
* dropped.
24012408
*
24022409
* @param graphName
2410+
* Name of the graph to be deleted.
2411+
* @return DeletedEntity
24032412
* @throws ArangoException
24042413
*/
24052414
public DeletedEntity deleteGraph(String graphName) throws ArangoException {
@@ -2411,7 +2420,9 @@ public DeletedEntity deleteGraph(String graphName) throws ArangoException {
24112420
* the graph will be dropped, if they are not used in another graph.
24122421
*
24132422
* @param graphName
2423+
* Name of the graph to be deleted.
24142424
* @param dropCollections
2425+
* Indicates if the collections of the graph will be dropped
24152426
* @throws ArangoException
24162427
*/
24172428
public void deleteGraph(String graphName, Boolean dropCollections) throws ArangoException {
@@ -2423,7 +2434,8 @@ public void deleteGraph(String graphName, Boolean dropCollections) throws Arango
24232434
* graphs edgeDefinitions (in "from", "to", and "orphanCollections")
24242435
*
24252436
* @param graphName
2426-
* @return List<String>
2437+
* The graph name.
2438+
* @return List<String> List of the names of the vertex collections
24272439
* @throws ArangoException
24282440
*/
24292441
public List<String> graphGetVertexCollections(String graphName) throws ArangoException {
@@ -2435,8 +2447,11 @@ public List<String> graphGetVertexCollections(String graphName) throws ArangoExc
24352447
* collection, if it is not used in any other graph.
24362448
*
24372449
* @param graphName
2450+
* The graph name.
24382451
* @param collectionName
2452+
* The name of the vertex collection to be removed from the graph.
24392453
* @param dropCollection
2454+
* Indicates if the collection will be dropped
24402455
* @throws ArangoException
24412456
*/
24422457
public DeletedEntity graphDeleteVertexCollection(String graphName, String collectionName, Boolean dropCollection)
@@ -2448,8 +2463,10 @@ public DeletedEntity graphDeleteVertexCollection(String graphName, String collec
24482463
* Creates a vertex collection
24492464
*
24502465
* @param graphName
2466+
* The graph name.
24512467
* @param collectionName
2452-
* @return GraphEntity
2468+
* The name of the collection to be created.
2469+
* @return GraphEntity The graph, including the new collection.
24532470
* @throws ArangoException
24542471
*/
24552472
public GraphEntity graphCreateVertexCollection(String graphName, String collectionName) throws ArangoException {
@@ -2461,7 +2478,9 @@ public GraphEntity graphCreateVertexCollection(String graphName, String collecti
24612478
* graphs edgeDefinitions
24622479
*
24632480
* @param graphName
2464-
* @return List<String>
2481+
* The graph name.
2482+
* @return List<String> List of the names of all edge collections of the
2483+
* graph.
24652484
* @throws ArangoException
24662485
*/
24672486
public List<String> graphGetEdgeCollections(String graphName) throws ArangoException {
@@ -2472,8 +2491,10 @@ public List<String> graphGetEdgeCollections(String graphName) throws ArangoExcep
24722491
* Adds a new edge definition to an existing graph
24732492
*
24742493
* @param graphName
2494+
* The graph name.
24752495
* @param edgeDefinition
2476-
* @return GraphEntity
2496+
* The edge definition to be added.
2497+
* @return GraphEntity The graph, including the new edge definition.
24772498
* @throws ArangoException
24782499
*/
24792500
public GraphEntity graphCreateEdgeDefinition(String graphName, EdgeDefinitionEntity edgeDefinition)
@@ -2487,9 +2508,13 @@ public GraphEntity graphCreateEdgeDefinition(String graphName, EdgeDefinitionEnt
24872508
* well.
24882509
*
24892510
* @param graphName
2511+
* The name of the graph.
24902512
* @param edgeCollectionName
2513+
* The name of the edge collection of the edge definition that has to
2514+
* be replaced.
24912515
* @param edgeDefinition
2492-
* @return GraphEntity
2516+
* The new edge definition.
2517+
* @return GraphEntity The graph, including the changed edge definition.
24932518
* @throws ArangoException
24942519
*/
24952520
public GraphEntity graphReplaceEdgeDefinition(
@@ -2504,8 +2529,11 @@ public GraphEntity graphReplaceEdgeDefinition(
25042529
* collections is dropped as well as long as it is not used in other graphs.
25052530
*
25062531
* @param graphName
2532+
* The name of the graph.
25072533
* @param edgeCollectionName
2508-
* @return
2534+
* The name of edge collection of the edge definition which has to be
2535+
* deleted.
2536+
* @return The graph, excluding the deleted edge definition.
25092537
*/
25102538
public GraphEntity graphDeleteEdgeDefinition(String graphName, String edgeCollectionName, Boolean dropCollection)
25112539
throws ArangoException {
@@ -2517,9 +2545,13 @@ public GraphEntity graphDeleteEdgeDefinition(String graphName, String edgeCollec
25172545
* the given collection.
25182546
*
25192547
* @param graphName
2548+
* The name of the graph.
25202549
* @param vertex
2550+
* The vertex object to be stored
25212551
* @param waitForSync
2522-
* @return <T> DocumentEntity<T>
2552+
* Wait for sync.
2553+
* @return <T> DocumentEntity<T> The resulting DocumentEntity containing the
2554+
* vertex document.
25232555
* @throws ArangoException
25242556
*/
25252557
public <T> DocumentEntity<T>
@@ -3122,21 +3154,22 @@ public <T> CursorEntity<T> graphGetEdgesByExampleMap(
31223154
return result;
31233155
}
31243156

3125-
public <T, S> CursorEntity<EdgeEntity<T>> graphGetEdgesByExampleObject1(
3126-
String graphName,
3127-
Class<T> clazzT,
3128-
S vertexExample) throws ArangoException {
3129-
validateCollectionName(graphName);
3130-
String query = "for i in graph_edges(@graphName, @vertexExample) return i";
3131-
3132-
Map<String, Object> bindVars = new MapBuilder().put("graphName", graphName).put("vertexExample", vertexExample)
3133-
.get();
3134-
3135-
// CursorEntity<EdgeEntity<T>> result = this.executeQuery(query, bindVars,
3136-
// clazzT, true, 20);
3137-
3138-
return null;
3139-
}
3157+
// public <T, S> CursorEntity<EdgeEntity<T>> graphGetEdgesByExampleObject1(
3158+
// String graphName,
3159+
// Class<T> clazzT,
3160+
// S vertexExample) throws ArangoException {
3161+
// validateCollectionName(graphName);
3162+
// String query = "for i in graph_edges(@graphName, @vertexExample) return i";
3163+
//
3164+
// Map<String, Object> bindVars = new MapBuilder().put("graphName",
3165+
// graphName).put("vertexExample", vertexExample)
3166+
// .get();
3167+
//
3168+
// CursorEntity<EdgeEntity<T>> result = this.executeQuery(query, bindVars,
3169+
// EdgeEntity<T>.class, true, 20);
3170+
//
3171+
// return null;
3172+
// }
31403173

31413174
// public <T> CursorEntity<EdgeEntity<T>> graphGetEdgesWithData(
31423175
// String graphName,

0 commit comments

Comments
 (0)
0