Skip to content

Commit

Permalink
Address comments
Browse files Browse the repository at this point in the history
  • Loading branch information
tb06904 committed Aug 30, 2023
1 parent 2d8876f commit c6babbd
Showing 1 changed file with 22 additions and 2 deletions.
24 changes: 22 additions & 2 deletions docs/reference/operations-guide/accumulo.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ graph TD
3(3, count=2) -- count=4 --> 4
```

---

## GetElementsBetweenSets

!!! warning "Deprecated"
Expand Down Expand Up @@ -216,13 +218,15 @@ Gets edges that exist between 2 sets and entities in the first set. [Javadoc](ht
Edge[source=1,destination=2,directed=true,matchedVertex=SOURCE,group=edge,properties=Properties[count=<java.lang.Integer>3]]
```

---

## GetElementsBetweenSetsPairs

Returns all the edges that exist between two Sets of Entities.
Given a [`Pair`](http://gchq.github.io/Gaffer/uk/gov/gchq/gaffer/commonutil/pair/Pair.html) containing two sets of [`EntityIds`](https://gchq.github.io/Gaffer/uk/gov/gchq/gaffer/data/element/id/EntityId.html), this returns all edges that exist between the two sets of Entities. Also returns [`Entities`](https://gchq.github.io/Gaffer/uk/gov/gchq/gaffer/data/element/Entity.html) from the first set.

This operation has been introduced as a replacement to the `GetElementsBetweenSets` operation as that could not be used in operation chains due to it requiring two inputs. Instead this operation requires a single [`Pair`](http://gchq.github.io/Gaffer/uk/gov/gchq/gaffer/commonutil/pair/Pair.html) input containing two Sets which have the Entity IDs you wish to get the edges between. [Javadoc](https://gchq.github.io/Gaffer/uk/gov/gchq/gaffer/accumulostore/operation/impl/GetElementsBetweenSetsPairs.html)

??? example "Example getting edges between a Set of node 1 and a Set of node 2 and 4"
??? example "Example getting edges between a `Set` of node 1 and a `Set` of node 2 and 4"

=== "Java"

Expand Down Expand Up @@ -285,6 +289,7 @@ This operation has been introduced as a replacement to the `GetElementsBetweenSe
``` java
Entity[vertex=1,group=entity,properties=Properties[count=<java.lang.Integer>3]]
Edge[source=1,destination=2,directed=true,matchedVertex=SOURCE,group=edge,properties=Properties[count=<java.lang.Integer>3]]
Edge[source=1,destination=4,directed=true,matchedVertex=SOURCE,group=edge,properties=Properties[count=<java.lang.Integer>1]]
```

=== "JSON"
Expand All @@ -309,10 +314,23 @@ This operation has been introduced as a replacement to the `GetElementsBetweenSe
"properties": {
"count": 3
}
},
{
"class": "uk.gov.gchq.gaffer.data.element.Edge",
"group": "edge",
"source": 1,
"destination": 4,
"directed": true,
"matchedVertex": "SOURCE",
"properties": {
"count": 1
}
}
]
```

---

## GetElementsWithinSet

Gets edges with both vertices in a given set and entities with vertices in a given set. [Javadoc](https://gchq.github.io/Gaffer/uk/gov/gchq/gaffer/accumulostore/operation/impl/GetElementsWithinSet.html)
Expand Down Expand Up @@ -506,6 +524,8 @@ Gets edges with both vertices in a given set and entities with vertices in a giv
Edge[source=1,destination=2,directed=true,matchedVertex=SOURCE,group=edge,properties=Properties[count=<java.lang.Integer>3]]
```

---

## GetElementsInRanges

Gets elements that have vertices within a given range. [Javadoc](https://gchq.github.io/Gaffer/uk/gov/gchq/gaffer/accumulostore/operation/impl/GetElementsInRanges.html)
Expand Down

0 comments on commit c6babbd

Please sign in to comment.