org.vertexium

Interface Vertex

All Superinterfaces:

Comparable, Element, VertexiumObject

public interface Vertex
extends Element

Field Summary

Fields inherited from interface org.vertexium.Element

ID_PROPERTY_NAME

Method Summary

Modifier and Type	Method and Description
int	getEdgeCount(Direction direction, Authorizations authorizations) Deprecated. Use {getEdgesSummary(Authorizations)}
Iterable<String>	getEdgeIds(Direction direction, Authorizations authorizations) Gets the connected edge ids.
Iterable<String>	getEdgeIds(Direction direction, String[] labels, Authorizations authorizations) Gets the connected edge ids.
Iterable<String>	getEdgeIds(Direction direction, String label, Authorizations authorizations) Gets the connected edge ids.
Iterable<String>	getEdgeIds(Vertex otherVertex, Direction direction, Authorizations authorizations) Gets the connected edge ids.
Iterable<String>	getEdgeIds(Vertex otherVertex, Direction direction, String[] labels, Authorizations authorizations) Gets a list of edge ids between this vertex and another vertex.
Iterable<String>	getEdgeIds(Vertex otherVertex, Direction direction, String label, Authorizations authorizations) Gets the connected edge ids.
Iterable<EdgeInfo>	getEdgeInfos(Direction direction, Authorizations authorizations) Get a list of EdgeInfo.
Iterable<EdgeInfo>	getEdgeInfos(Direction direction, String[] labels, Authorizations authorizations) Get a list of EdgeInfo.
Iterable<EdgeInfo>	getEdgeInfos(Direction direction, String label, Authorizations authorizations) Get a list of EdgeInfo.
Iterable<String>	getEdgeLabels(Direction direction, Authorizations authorizations) Deprecated. Use {getEdgesSummary(Authorizations)}
Iterable<Edge>	getEdges(Direction direction, Authorizations authorizations) Gets all edges attached to this vertex.
Iterable<Edge>	getEdges(Direction direction, FetchHints fetchHints, Authorizations authorizations) Gets all edges attached to this vertex.
Iterable<Edge>	getEdges(Direction direction, FetchHints fetchHints, Long endTime, Authorizations authorizations) Gets all edges attached to this vertex.
Iterable<Edge>	getEdges(Direction direction, String[] labels, Authorizations authorizations) Gets all edges with any of the given labels attached to this vertex.
Iterable<Edge>	getEdges(Direction direction, String[] labels, FetchHints fetchHints, Authorizations authorizations) Gets all edges with any of the given labels attached to this vertex.
Iterable<Edge>	getEdges(Direction direction, String label, Authorizations authorizations) Gets all edges with the given label attached to this vertex.
Iterable<Edge>	getEdges(Direction direction, String label, FetchHints fetchHints, Authorizations authorizations) Gets all edges with the given label attached to this vertex.
Iterable<Edge>	getEdges(Vertex otherVertex, Direction direction, Authorizations authorizations) Gets all edges between this vertex and another vertex.
Iterable<Edge>	getEdges(Vertex otherVertex, Direction direction, FetchHints fetchHints, Authorizations authorizations) Gets all edges between this vertex and another vertex.
Iterable<Edge>	getEdges(Vertex otherVertex, Direction direction, String[] labels, Authorizations authorizations) Gets all edges between this vertex and another vertex matching any of the given labels.
Iterable<Edge>	getEdges(Vertex otherVertex, Direction direction, String[] labels, FetchHints fetchHints, Authorizations authorizations) Gets all edges between this vertex and another vertex matching any of the given labels.
Iterable<Edge>	getEdges(Vertex otherVertex, Direction direction, String label, Authorizations authorizations) Gets all edges between this vertex and another vertex matching the given label.
Iterable<Edge>	getEdges(Vertex otherVertex, Direction direction, String label, FetchHints fetchHints, Authorizations authorizations) Gets all edges between this vertex and another vertex matching the given label.
EdgesSummary	getEdgesSummary(Authorizations authorizations) Gets edge summary information
Iterable<EdgeVertexPair>	getEdgeVertexPairs(Direction direction, Authorizations authorizations) Gets all edge/vertex pairs attached to this vertex.
Iterable<EdgeVertexPair>	getEdgeVertexPairs(Direction direction, FetchHints fetchHints, Authorizations authorizations) Gets all edge/vertex pairs attached to this vertex.
Iterable<EdgeVertexPair>	getEdgeVertexPairs(Direction direction, FetchHints fetchHints, Long endTime, Authorizations authorizations) Gets all edge/vertex pairs attached to this vertex.
Iterable<EdgeVertexPair>	getEdgeVertexPairs(Direction direction, String[] labels, Authorizations authorizations) Gets all edge/vertex pairs with any of the given labels attached to this vertex.
Iterable<EdgeVertexPair>	getEdgeVertexPairs(Direction direction, String[] labels, FetchHints fetchHints, Authorizations authorizations) Gets all edge/vertex pairs with any of the given labels attached to this vertex.
Iterable<EdgeVertexPair>	getEdgeVertexPairs(Direction direction, String label, Authorizations authorizations) Gets all edge/vertex pairs with the given label attached to this vertex.
Iterable<EdgeVertexPair>	getEdgeVertexPairs(Direction direction, String label, FetchHints fetchHints, Authorizations authorizations) Gets all edge/vertex pairs with the given label attached to this vertex.
Iterable<String>	getVertexIds(Direction direction, Authorizations authorizations) Gets vertex ids of connected vertices.
Iterable<String>	getVertexIds(Direction direction, String[] labels, Authorizations authorizations) Gets vertex ids of connected vertices.
Iterable<String>	getVertexIds(Direction direction, String label, Authorizations authorizations) Gets vertex ids of connected vertices.
Iterable<Vertex>	getVertices(Direction direction, Authorizations authorizations) Similar to getEdges but gets the vertices on the other side of the edges attached to this vertex.
Iterable<Vertex>	getVertices(Direction direction, FetchHints fetchHints, Authorizations authorizations) Similar to getEdges but gets the vertices on the other side of the edges attached to this vertex.
Iterable<Vertex>	getVertices(Direction direction, String[] labels, Authorizations authorizations) Similar to getEdges but gets the vertices on the other side of the edges attached to this vertex that have any of the given labels.
Iterable<Vertex>	getVertices(Direction direction, String[] labels, FetchHints fetchHints, Authorizations authorizations) Similar to getEdges but gets the vertices on the other side of the edges attached to this vertex that have any of the given labels.
Iterable<Vertex>	getVertices(Direction direction, String label, Authorizations authorizations) Similar to getEdges but gets the vertices on the other side of the edges attached to this vertex that have the given label.
Iterable<Vertex>	getVertices(Direction direction, String label, FetchHints fetchHints, Authorizations authorizations) Similar to getEdges but gets the vertices on the other side of the edges attached to this vertex that have the given label.
ExistingElementMutation<Vertex>	prepareMutation() Prepares a mutation to allow changing multiple property values at the same time.
VertexQuery	query(Authorizations authorizations) Creates a query to query the edges and vertices attached to this vertex.
VertexQuery	query(String queryString, Authorizations authorizations) Creates a query to query the edges and vertices attached to this vertex.

Methods inherited from interface org.vertexium.Element

addPropertyValue, addPropertyValue, compareTo, deleteProperties, deleteProperty, deleteProperty, deleteProperty, getAuthorizations, getExtendedData, getExtendedDataTableNames, getFetchHints, getGraph, getHiddenVisibilities, getHistoricalPropertyValues, getHistoricalPropertyValues, getHistoricalPropertyValues, getHistoricalPropertyValues, getId, getTimestamp, getVisibility, isHidden, markPropertyHidden, markPropertyHidden, markPropertyHidden, markPropertyHidden, markPropertyVisible, markPropertyVisible, markPropertyVisible, markPropertyVisible, setProperty, setProperty, softDeleteProperties, softDeleteProperty, softDeleteProperty

Methods inherited from interface org.vertexium.VertexiumObject

getProperties, getProperties, getProperties, getProperty, getProperty, getProperty, getProperty, getPropertyValue, getPropertyValue, getPropertyValue, getPropertyValue, getPropertyValues, getPropertyValues

Method Detail

getEdges

Iterable<Edge> getEdges(Direction direction,
                        Authorizations authorizations)

Gets all edges attached to this vertex.

Parameters:

direction - The side of the edge that this vertex is attached to.

authorizations - The authorizations used to find the edges.

Returns:

An Iterable of edges.

getEdges

Iterable<Edge> getEdges(Direction direction,
                        FetchHints fetchHints,
                        Authorizations authorizations)

Gets all edges attached to this vertex.

Parameters:

direction - The side of the edge that this vertex is attached to.

fetchHints - Hint on what should be fetched from the datastore.

authorizations - The authorizations used to find the edges.

Returns:

An Iterable of edges.

getEdges

Iterable<Edge> getEdges(Direction direction,
                        FetchHints fetchHints,
                        Long endTime,
                        Authorizations authorizations)

Gets all edges attached to this vertex.

Parameters:

direction - The side of the edge that this vertex is attached to.

fetchHints - Hint on what should be fetched from the datastore.

endTime - Include all changes made up until the point in time.

authorizations - The authorizations used to find the edges.

Returns:

An Iterable of edges.

getEdgeIds

Iterable<String> getEdgeIds(Direction direction,
                            Authorizations authorizations)

Gets the connected edge ids.

Parameters:

direction - The side of the edge that this vertex is attached to.

authorizations - The authorizations used to find the edges.

Returns:

An Iterable of edge ids

getEdges

Iterable<Edge> getEdges(Direction direction,
                        String label,
                        Authorizations authorizations)

Gets all edges with the given label attached to this vertex.

Parameters:

direction - The side of the edge that this vertex is attached to.

label - The edge label to search for.

authorizations - The authorizations used to find the edges.

Returns:

An Iterable of edges.

getEdges

Iterable<Edge> getEdges(Direction direction,
                        String label,
                        FetchHints fetchHints,
                        Authorizations authorizations)

Gets all edges with the given label attached to this vertex.

Parameters:

direction - The side of the edge that this vertex is attached to.

label - The edge label to search for.

fetchHints - Hint on what should be fetched from the datastore.

authorizations - The authorizations used to find the edges.

Returns:

An Iterable of edges.

getEdgeIds

Iterable<String> getEdgeIds(Direction direction,
                            String label,
                            Authorizations authorizations)

Gets the connected edge ids.

Parameters:

direction - The side of the edge that this vertex is attached to.

label - The edge label to search for.

authorizations - The authorizations used to find the edges.

Returns:

An Iterable of edge ids

getEdges

Iterable<Edge> getEdges(Direction direction,
                        String[] labels,
                        Authorizations authorizations)

Gets all edges with any of the given labels attached to this vertex.

Parameters:

direction - The side of the edge that this vertex is attached to.

labels - An array of edge labels to search for.

authorizations - The authorizations used to find the edges.

Returns:

An Iterable of edges.

getEdges

Iterable<Edge> getEdges(Direction direction,
                        String[] labels,
                        FetchHints fetchHints,
                        Authorizations authorizations)

Gets all edges with any of the given labels attached to this vertex.

Parameters:

direction - The side of the edge that this vertex is attached to.

labels - An array of edge labels to search for.

fetchHints - Hint on what should be fetched from the datastore.

authorizations - The authorizations used to find the edges.

Returns:

An Iterable of edges.

getEdgeIds

Iterable<String> getEdgeIds(Direction direction,
                            String[] labels,
                            Authorizations authorizations)

Gets the connected edge ids.

Parameters:

direction - The side of the edge that this vertex is attached to.

labels - An array of edge labels to search for.

authorizations - The authorizations used to find the edges.

Returns:

An Iterable of edge ids

getEdges

Iterable<Edge> getEdges(Vertex otherVertex,
                        Direction direction,
                        Authorizations authorizations)

Gets all edges between this vertex and another vertex.

Parameters:

otherVertex - The other vertex.

direction - The direction of edges to find relative to this vertex.

authorizations - The authorizations used to find the edges.

Returns:

An Iterable of edges.

getEdges

Iterable<Edge> getEdges(Vertex otherVertex,
                        Direction direction,
                        FetchHints fetchHints,
                        Authorizations authorizations)

Gets all edges between this vertex and another vertex.

Parameters:

otherVertex - The other vertex.

direction - The direction of edges to find relative to this vertex.

fetchHints - Hint on what should be fetched from the datastore.

authorizations - The authorizations used to find the edges.

Returns:

An Iterable of edges.

getEdgeIds

Iterable<String> getEdgeIds(Vertex otherVertex,
                            Direction direction,
                            Authorizations authorizations)

Gets the connected edge ids.

Parameters:

otherVertex - The other vertex.

direction - The direction of edges to find relative to this vertex.

authorizations - The authorizations used to find the edges.

Returns:

An Iterable of edge ids

getEdges

Iterable<Edge> getEdges(Vertex otherVertex,
                        Direction direction,
                        String label,
                        Authorizations authorizations)

Gets all edges between this vertex and another vertex matching the given label.

Parameters:

otherVertex - The other vertex.

direction - The direction of edges to find relative to this vertex.

label - The edge label to search for.

authorizations - The authorizations used to find the edges.

Returns:

An Iterable of edges.

getEdges

Iterable<Edge> getEdges(Vertex otherVertex,
                        Direction direction,
                        String label,
                        FetchHints fetchHints,
                        Authorizations authorizations)

Gets all edges between this vertex and another vertex matching the given label.

Parameters:

otherVertex - The other vertex.

direction - The direction of edges to find relative to this vertex.

label - The edge label to search for.

fetchHints - Hint on what should be fetched from the datastore.

authorizations - The authorizations used to find the edges.

Returns:

An Iterable of edges.

getEdgeIds

Iterable<String> getEdgeIds(Vertex otherVertex,
                            Direction direction,
                            String label,
                            Authorizations authorizations)

Gets the connected edge ids.

Parameters:

otherVertex - The other vertex.

direction - The direction of edges to find relative to this vertex.

label - The edge label to search for.

authorizations - The authorizations used to find the edges.

Returns:

An Iterable of edge ids

getEdges

Iterable<Edge> getEdges(Vertex otherVertex,
                        Direction direction,
                        String[] labels,
                        Authorizations authorizations)

Gets all edges between this vertex and another vertex matching any of the given labels.

Parameters:

otherVertex - The other vertex.

direction - The direction of edges to find relative to this vertex.

labels - An array of edge labels to search for.

authorizations - The authorizations used to find the edges.

Returns:

An Iterable of edges.

getEdges

Iterable<Edge> getEdges(Vertex otherVertex,
                        Direction direction,
                        String[] labels,
                        FetchHints fetchHints,
                        Authorizations authorizations)

Gets all edges between this vertex and another vertex matching any of the given labels.

Parameters:

otherVertex - The other vertex.

direction - The direction of edges to find relative to this vertex.

labels - An array of edge labels to search for.

fetchHints - Hint on what should be fetched from the datastore.

authorizations - The authorizations used to find the edges.

Returns:

An Iterable of edges.

getEdgeIds

Iterable<String> getEdgeIds(Vertex otherVertex,
                            Direction direction,
                            String[] labels,
                            Authorizations authorizations)

Gets a list of edge ids between this vertex and another vertex.

Parameters:

otherVertex - The other vertex to find edges on.

direction - The direction of the edge.

labels - The labels to search for.

authorizations - The authorizations used to find the edges.

Returns:

An Iterable of edge ids.

getEdgeCount

@Deprecated
int getEdgeCount(Direction direction,
                             Authorizations authorizations)

Deprecated. Use {getEdgesSummary(Authorizations)}

Gets count of edges on this vertex.

Parameters:

direction - The direction of the edges to get a count on.

authorizations - The authorizations used to find the edges.

Returns:

The count of edges.

getEdgeLabels

@Deprecated
Iterable<String> getEdgeLabels(Direction direction,
                                           Authorizations authorizations)

Deprecated. Use {getEdgesSummary(Authorizations)}

Gets a list of edge labels.

Parameters:

direction - The direction of the edge.

authorizations - The authorizations used to find the edges.

Returns:

An Iterable of edge labels.

getEdgesSummary

EdgesSummary getEdgesSummary(Authorizations authorizations)

Gets edge summary information

Parameters:

authorizations - The authorizations used to get the edges summary

Returns:

The edges summary

getEdgeInfos

Iterable<EdgeInfo> getEdgeInfos(Direction direction,
                                Authorizations authorizations)

Get a list of EdgeInfo.

Parameters:

direction - The direction of the edge.

authorizations - The authorizations used to find the edges.

Returns:

An Iterable of EdgeInfo.

getEdgeInfos

Iterable<EdgeInfo> getEdgeInfos(Direction direction,
                                String label,
                                Authorizations authorizations)

Get a list of EdgeInfo.

Parameters:

direction - The direction of the edge.

label - The label of edges to traverse to find the edge infos.

authorizations - The authorizations used to find the edges.

Returns:

An Iterable of EdgeInfo.

getEdgeInfos

Iterable<EdgeInfo> getEdgeInfos(Direction direction,
                                String[] labels,
                                Authorizations authorizations)

Get a list of EdgeInfo.

Parameters:

direction - The direction of the edge.

labels - The labels of edges to traverse to find the edge infos.

authorizations - The authorizations used to find the edges.

Returns:

An Iterable of EdgeInfo.

getVertices

Iterable<Vertex> getVertices(Direction direction,
                             Authorizations authorizations)

Similar to getEdges but gets the vertices on the other side of the edges attached to this vertex.

Parameters:

direction - The direction relative to this vertex.

authorizations - The authorizations used to find the vertices.

Returns:

An Iterable of vertices.

getVertices

Iterable<Vertex> getVertices(Direction direction,
                             FetchHints fetchHints,
                             Authorizations authorizations)

Similar to getEdges but gets the vertices on the other side of the edges attached to this vertex.

Parameters:

direction - The direction relative to this vertex.

fetchHints - Hint on what should be fetched from the datastore.

authorizations - The authorizations used to find the vertices.

Returns:

An Iterable of vertices.

getVertices

Iterable<Vertex> getVertices(Direction direction,
                             String label,
                             Authorizations authorizations)

Similar to getEdges but gets the vertices on the other side of the edges attached to this vertex that have the given label.

Parameters:

direction - The direction relative to this vertex.

label - The label of edges to traverse to find the vertices.

authorizations - The authorizations used to find the vertices.

Returns:

An Iterable of vertices.

getVertices

Iterable<Vertex> getVertices(Direction direction,
                             String label,
                             FetchHints fetchHints,
                             Authorizations authorizations)

Similar to getEdges but gets the vertices on the other side of the edges attached to this vertex that have the given label.

Parameters:

direction - The direction relative to this vertex.

label - The label of edges to traverse to find the vertices.

fetchHints - Hint on what should be fetched from the datastore.

authorizations - The authorizations used to find the vertices.

Returns:

An Iterable of vertices.

getVertices

Iterable<Vertex> getVertices(Direction direction,
                             String[] labels,
                             Authorizations authorizations)

Similar to getEdges but gets the vertices on the other side of the edges attached to this vertex that have any of the given labels.

Parameters:

direction - The direction relative to this vertex.

labels - The labels of edges to traverse to find the vertices.

authorizations - The authorizations used to find the vertices.

Returns:

An Iterable of vertices.

getVertices

Iterable<Vertex> getVertices(Direction direction,
                             String[] labels,
                             FetchHints fetchHints,
                             Authorizations authorizations)

Similar to getEdges but gets the vertices on the other side of the edges attached to this vertex that have any of the given labels.

Parameters:

direction - The direction relative to this vertex.

labels - The labels of edges to traverse to find the vertices.

fetchHints - Hint on what should be fetched from the datastore.

authorizations - The authorizations used to find the vertices.

Returns:

An Iterable of vertices.

getVertexIds

Iterable<String> getVertexIds(Direction direction,
                              String label,
                              Authorizations authorizations)

Gets vertex ids of connected vertices.

Parameters:

direction - The direction relative to this vertex.

label - The label of edges to traverse to find the vertices.

authorizations - The authorizations used to find the vertices.

Returns:

An Iterable of vertex ids.

getVertexIds

Iterable<String> getVertexIds(Direction direction,
                              String[] labels,
                              Authorizations authorizations)

Gets vertex ids of connected vertices.

Parameters:

direction - The direction relative to this vertex.

labels - The labels of edges to traverse to find the vertices.

authorizations - The authorizations used to find the vertices.

Returns:

An Iterable of vertex ids.

getVertexIds

Iterable<String> getVertexIds(Direction direction,
                              Authorizations authorizations)

Gets vertex ids of connected vertices.

Parameters:

direction - The direction relative to this vertex.

authorizations - The authorizations used to find the vertices.

Returns:

An Iterable of vertex ids.

query

VertexQuery query(Authorizations authorizations)

Creates a query to query the edges and vertices attached to this vertex.

Parameters:

authorizations - The authorizations used to find the edges and vertices.

Returns:

The query builder.

query

VertexQuery query(String queryString,
                  Authorizations authorizations)

Creates a query to query the edges and vertices attached to this vertex.

Parameters:

queryString - The string to search for.

authorizations - The authorizations used to find the edges and vertices.

Returns:

The query builder.

prepareMutation

ExistingElementMutation<Vertex> prepareMutation()

Prepares a mutation to allow changing multiple property values at the same time. This method is similar to Graph#prepareVertex(Visibility, Authorizations) in that it allows multiple properties to be changed and saved in a single mutation.

Specified by:

prepareMutation in interface Element

Returns:

The mutation builder.

getEdgeVertexPairs

Iterable<EdgeVertexPair> getEdgeVertexPairs(Direction direction,
                                            Authorizations authorizations)

Gets all edge/vertex pairs attached to this vertex.

Parameters:

direction - The side of the edge that this vertex is attached to.

authorizations - The authorizations used to find the edge/vertex pairs.

Returns:

An Iterable of edge/vertex pairs.

getEdgeVertexPairs

Iterable<EdgeVertexPair> getEdgeVertexPairs(Direction direction,
                                            FetchHints fetchHints,
                                            Authorizations authorizations)

Gets all edge/vertex pairs attached to this vertex.

Parameters:

direction - The side of the edge that this vertex is attached to.

fetchHints - Hint on what should be fetched from the datastore.

authorizations - The authorizations used to find the edge/vertex pairs.

Returns:

An Iterable of edge/vertex pairs.

getEdgeVertexPairs

Iterable<EdgeVertexPair> getEdgeVertexPairs(Direction direction,
                                            FetchHints fetchHints,
                                            Long endTime,
                                            Authorizations authorizations)

Gets all edge/vertex pairs attached to this vertex.

Parameters:

direction - The side of the edge that this vertex is attached to.

fetchHints - Hint on what should be fetched from the datastore.

endTime - Include all changes made up until the point in time.

authorizations - The authorizations used to find the edge/vertex pairs.

Returns:

An Iterable of edge/vertex pairs.

getEdgeVertexPairs

Iterable<EdgeVertexPair> getEdgeVertexPairs(Direction direction,
                                            String label,
                                            Authorizations authorizations)

Gets all edge/vertex pairs with the given label attached to this vertex.

Parameters:

direction - The side of the edge that this vertex is attached to.

label - The edge label to search for.

authorizations - The authorizations used to find the edge/vertex pairs.

Returns:

An Iterable of edge/vertex pairs.

getEdgeVertexPairs

Iterable<EdgeVertexPair> getEdgeVertexPairs(Direction direction,
                                            String label,
                                            FetchHints fetchHints,
                                            Authorizations authorizations)

Gets all edge/vertex pairs with the given label attached to this vertex.

Parameters:

direction - The side of the edge that this vertex is attached to.

label - The edge label to search for.

fetchHints - Hint on what should be fetched from the datastore.

authorizations - The authorizations used to find the edge/vertex pairs.

Returns:

An Iterable of edge/vertex pairs.

getEdgeVertexPairs

Iterable<EdgeVertexPair> getEdgeVertexPairs(Direction direction,
                                            String[] labels,
                                            Authorizations authorizations)

Gets all edge/vertex pairs with any of the given labels attached to this vertex.

Parameters:

direction - The side of the edge that this vertex is attached to.

labels - An array of edge labels to search for.

authorizations - The authorizations used to find the edge/vertex pairs.

Returns:

An Iterable of edge/vertex pairs.

getEdgeVertexPairs

Iterable<EdgeVertexPair> getEdgeVertexPairs(Direction direction,
                                            String[] labels,
                                            FetchHints fetchHints,
                                            Authorizations authorizations)

Gets all edge/vertex pairs with any of the given labels attached to this vertex.

Parameters:

direction - The side of the edge that this vertex is attached to.

labels - An array of edge labels to search for.

fetchHints - Hint on what should be fetched from the datastore.

authorizations - The authorizations used to find the edge/vertex pairs.

Returns:

An Iterable of edge/vertex pairs.