com.arangodb.util

Class GraphEdgesOptions

java.lang.Object

com.arangodb.util.AbstractOptions

com.arangodb.util.GraphEdgesOptions

All Implemented Interfaces:

OptionsInterface

public class GraphEdgesOptions
extends AbstractOptions
implements OptionsInterface

Constructor Summary

Constructors

Constructor and Description
GraphEdgesOptions()

Method Summary

Methods

Modifier and Type	Method and Description
Direction	getDirection() The direction of the edges as a string.
List<String>	getEdgeCollectionRestriction() One or multiple edge collection names.
Object	getEdgeExamples() A filter example for the edges
List<String>	getEndVertexCollectionRestriction() One or multiple vertex collection names.
Boolean	getIncludeData() Get include data
Integer	getMaxDepth() Defines the maximal length of a path from an edge to a vertex (default is 1, which means only the edges directly connected to a vertex would be returned).
Integer	getMaxIterations() the maximum number of iterations that the traversal is allowed to perform.
Integer	getMinDepth() Defines the minimal length of a path from an edge to a vertex (default is 1, which means only the edges directly connected to a vertex would be returned).
Object	getNeighborExamples() An example for the desired neighbors
List<String>	getStartVertexCollectionRestriction() One or multiple vertex collection names.
GraphEdgesOptions	setDirection(Direction direction) The direction of the edges as a string.
GraphEdgesOptions	setEdgeCollectionRestriction(List<String> edgeCollectionRestriction) One or multiple edge collection names.
GraphEdgesOptions	setEdgeExamples(Object edgeExamples) A filter example for the edges
GraphEdgesOptions	setEndVertexCollectionRestriction(List<String> endVertexCollectionRestriction) One or multiple vertex collection names.
void	setIncludeData(Boolean includeData) set include data to be compatible with older versions of AnrangoDB
GraphEdgesOptions	setMaxDepth(Integer maxDepth) Defines the maximal length of a path from an edge to a vertex (default is 1, which means only the edges directly connected to a vertex would be returned).
GraphEdgesOptions	setMaxIterations(Integer maxIterations) the maximum number of iterations that the traversal is allowed to perform.
GraphEdgesOptions	setMinDepth(Integer minDepth) Defines the minimal length of a path from an edge to a vertex (default is 1, which means only the edges directly connected to a vertex would be returned).
GraphEdgesOptions	setNeighborExamples(Object neighborExamples) An example for the desired neighbors
GraphEdgesOptions	setStartVertexCollectionRestriction(List<String> startVertexCollectionRestriction) One or multiple vertex collection names.
Map<String,Object>	toMap()

Methods inherited from class com.arangodb.util.AbstractOptions

putAttribute, putAttribute, putAttributeCollection, putAttributeToLower, putAttributeToLower

Methods inherited from class java.lang.Object

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

Constructor Detail

GraphEdgesOptions

public GraphEdgesOptions()

Method Detail

getDirection

public Direction getDirection()

The direction of the edges as a string. Possible values are outbound, inbound and any (default).

Returns:

the direction

setDirection

public GraphEdgesOptions setDirection(Direction direction)

The direction of the edges as a string. Possible values are outbound, inbound and any (default).

Parameters:

direction -

Returns:

this

getEdgeCollectionRestriction

public List<String> getEdgeCollectionRestriction()

One or multiple edge collection names. Only edges from these collections will be considered for the path.

Returns:

One or multiple edge collection names.

setEdgeCollectionRestriction

public GraphEdgesOptions setEdgeCollectionRestriction(List<String> edgeCollectionRestriction)

One or multiple edge collection names. Only edges from these collections will be considered for the path.

Parameters:

edgeCollectionRestriction -

Returns:

this

getStartVertexCollectionRestriction

public List<String> getStartVertexCollectionRestriction()

One or multiple vertex collection names. Only vertices from these collections will be considered as start vertex of a path.

Returns:

One or multiple vertex collection names.

setStartVertexCollectionRestriction

public GraphEdgesOptions setStartVertexCollectionRestriction(List<String> startVertexCollectionRestriction)

One or multiple vertex collection names. Only vertices from these collections will be considered as start vertex of a path.

Parameters:

startVertexCollectionRestriction -

Returns:

this

getEndVertexCollectionRestriction

public List<String> getEndVertexCollectionRestriction()

One or multiple vertex collection names. Only vertices from these collections will be considered as end vertex of a path.

Returns:

One or multiple vertex collection names.

setEndVertexCollectionRestriction

public GraphEdgesOptions setEndVertexCollectionRestriction(List<String> endVertexCollectionRestriction)

One or multiple vertex collection names. Only vertices from these collections will be considered as end vertex of a path.

Parameters:

endVertexCollectionRestriction -

Returns:

this

getEdgeExamples

public Object getEdgeExamples()

A filter example for the edges

Returns:

A filter example for the edges

setEdgeExamples

public GraphEdgesOptions setEdgeExamples(Object edgeExamples)

A filter example for the edges

Parameters:

edgeExamples -

Returns:

this

getNeighborExamples

public Object getNeighborExamples()

An example for the desired neighbors

Returns:

An example for the desired neighbors

setNeighborExamples

public GraphEdgesOptions setNeighborExamples(Object neighborExamples)

An example for the desired neighbors

Parameters:

neighborExamples -

Returns:

this

getMinDepth

public Integer getMinDepth()

Defines the minimal length of a path from an edge to a vertex (default is 1, which means only the edges directly connected to a vertex would be returned).

Returns:

efines the minimal length of a path

setMinDepth

public GraphEdgesOptions setMinDepth(Integer minDepth)

Defines the minimal length of a path from an edge to a vertex (default is 1, which means only the edges directly connected to a vertex would be returned).

Parameters:

minDepth -

Returns:

this

getMaxDepth

public Integer getMaxDepth()

Defines the maximal length of a path from an edge to a vertex (default is 1, which means only the edges directly connected to a vertex would be returned).

Returns:

Defines the maximal length of a path

setMaxDepth

public GraphEdgesOptions setMaxDepth(Integer maxDepth)

Defines the maximal length of a path from an edge to a vertex (default is 1, which means only the edges directly connected to a vertex would be returned).

Parameters:

maxDepth -

Returns:

this

getMaxIterations

public Integer getMaxIterations()

the maximum number of iterations that the traversal is allowed to perform. It is sensible to set this number so unbounded traversals

Returns:

the maximum number of iterations

setMaxIterations

public GraphEdgesOptions setMaxIterations(Integer maxIterations)

the maximum number of iterations that the traversal is allowed to perform. It is sensible to set this number so unbounded traversals

Parameters:

maxIterations -

Returns:

this

getIncludeData

public Boolean getIncludeData()

Get include data

Returns:

setIncludeData

public void setIncludeData(Boolean includeData)

set include data to be compatible with older versions of AnrangoDB

Parameters:

includeData -

Since:

ArangoDB 2.6

toMap

public Map<String,Object> toMap()

Specified by:

toMap in interface OptionsInterface