TraversalQueryOptions (arangodb-java-driver 3.0.3 API)

java.lang.Object
- com.arangodb.util.AbstractOptions
- - com.arangodb.util.TraversalQueryOptions

All Implemented Interfaces:: OptionsInterface

public class TraversalQueryOptions
extends AbstractOptions
implements OptionsInterface

Constructor Summary

Constructors
Constructor and Description

TraversalQueryOptions()

Constructors
Constructor and Description
`TraversalQueryOptions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Direction`	`getDirection()`
`String`	`getEdgeCollection()`
`InternalTraversalDriver.Uniqueness`	`getEdgesUniqueness()`
`String`	`getExpander()`
`String`	`getFilter()`
`String`	`getGraphName()`
`String`	`getInit()`
`InternalTraversalDriver.ItemOrder`	`getItemOrder()`
`Long`	`getMaxDepth()`
`Long`	`getMaxIterations()`
`Long`	`getMinDepth()`
`InternalTraversalDriver.Order`	`getOrder()`
`String`	`getSort()`
`String`	`getStartVertex()`
`InternalTraversalDriver.Strategy`	`getStrategy()`
`InternalTraversalDriver.Uniqueness`	`getVerticesUniqueness()`
`String`	`getVisitor()`
`TraversalQueryOptions`	`setDirection(Direction direction)` Set (optional) direction for traversal
`TraversalQueryOptions`	`setEdgeCollection(String edgeCollection)` Set (optional) name of the collection that contains the edges.
`TraversalQueryOptions`	`setEdgesUniqueness(InternalTraversalDriver.Uniqueness edgesUniqueness)` Set the (optional) uniqueness type for edges visited if set
`TraversalQueryOptions`	`setExpander(String expander)` Set an expander function.
`TraversalQueryOptions`	`setFilter(String filter)` Set a filter.
`TraversalQueryOptions`	`setGraphName(String graphName)` Set the (optional) name of the graph that contains the edges.
`TraversalQueryOptions`	`setInit(String init)` Set an initialisation function.
`TraversalQueryOptions`	`setItemOrder(InternalTraversalDriver.ItemOrder itemOrder)` Set the (optional) item iteration order
`TraversalQueryOptions`	`setMaxDepth(Long maxDepth)` Set a maximal depth.
`TraversalQueryOptions`	`setMaxIterations(Long maxIterations)` Set the (optional) maximum number of iterations in each traversal
`TraversalQueryOptions`	`setMinDepth(Long minDepth)` Set a minimal depth.
`TraversalQueryOptions`	`setOrder(InternalTraversalDriver.Order order)` Set the (optional) traversal order
`TraversalQueryOptions`	`setSort(String sort)` Set a comparison function.
`TraversalQueryOptions`	`setStartVertex(String startVertex)` Set id of the startVertex, e.g.
`TraversalQueryOptions`	`setStrategy(InternalTraversalDriver.Strategy strategy)` Set (optional) traversal strategy.
`TraversalQueryOptions`	`setVerticesUniqueness(InternalTraversalDriver.Uniqueness verticesUniqueness)` Set the (optional) uniqueness type for vertices visited if set
`TraversalQueryOptions`	`setVisitor(String visitor)` Set visitor function.
`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
  - TraversalQueryOptions
```
public TraversalQueryOptions()
```
- Method Detail
  - getGraphName
```
public String getGraphName()
```
  - setGraphName
```
public TraversalQueryOptions setGraphName(String graphName)
```
    Set the (optional) name of the graph that contains the edges. Either edgeCollection or graphName has to be given. In case both values are set the graphName is prefered.
    
    Parameters:
    
    graphName -
    
    Returns:
    
    this
  - getEdgeCollection
```
public String getEdgeCollection()
```
  - setEdgeCollection
```
public TraversalQueryOptions setEdgeCollection(String edgeCollection)
```
    Set (optional) name of the collection that contains the edges.
    
    Parameters:
    
    edgeCollection -
    
    Returns:
    
    this
  - getStartVertex
```
public String getStartVertex()
```
  - setStartVertex
```
public TraversalQueryOptions setStartVertex(String startVertex)
```
    Set id of the startVertex, e.g. "users/foo".
    
    Parameters:
    
    startVertex -
    
    Returns:
    
    this
  - getFilter
```
public String getFilter()
```
  - setFilter
```
public TraversalQueryOptions setFilter(String filter)
```
    Set a filter. (optional, default is to include all nodes): body (JavaScript code) of custom filter function function
    
    Parameters:
    
    filter -
    
    Returns:
    
    this
  - getMinDepth
```
public Long getMinDepth()
```
  - setMinDepth
```
public TraversalQueryOptions setMinDepth(Long minDepth)
```
    Set a minimal depth. (optional, ANDed with any existing filters): visits only nodes in at least the given depth
    
    Parameters:
    
    minDepth -
    
    Returns:
    
    this
  - getMaxDepth
```
public Long getMaxDepth()
```
  - setMaxDepth
```
public TraversalQueryOptions setMaxDepth(Long maxDepth)
```
    Set a maximal depth. (optional, ANDed with any existing filters): visits only nodes in at most the given depth
    
    Parameters:
    
    maxDepth -
    
    Returns:
    
    this
  - getVisitor
```
public String getVisitor()
```
  - setVisitor
```
public TraversalQueryOptions setVisitor(String visitor)
```
    Set visitor function. (optional): body (JavaScript) code of custom visitor function
    
    Parameters:
    
    visitor -
    
    Returns:
    
    this
  - getDirection
```
public Direction getDirection()
```
  - setDirection
```
public TraversalQueryOptions setDirection(Direction direction)
```
    Set (optional) direction for traversal
    
    Parameters:
    
    direction -
    
    Returns:
    
    this
  - getInit
```
public String getInit()
```
  - setInit
```
public TraversalQueryOptions setInit(String init)
```
    Set an initialisation function. (optional): body (JavaScript) code of custom result initialisation function
    
    Parameters:
    
    init -
    
    Returns:
    
    this
  - getExpander
```
public String getExpander()
```
  - setExpander
```
public TraversalQueryOptions setExpander(String expander)
```
    Set an expander function. (optional): body (JavaScript) code of custom expander function
    
    Parameters:
    
    expander -
    
    Returns:
    
    this
  - getSort
```
public String getSort()
```
  - setSort
```
public TraversalQueryOptions setSort(String sort)
```
    Set a comparison function. (optional): body (JavaScript) code of a custom comparison function
    
    Parameters:
    
    sort -
    
    Returns:
    
    this
  - getStrategy
```
public InternalTraversalDriver.Strategy getStrategy()
```
  - setStrategy
```
public TraversalQueryOptions setStrategy(InternalTraversalDriver.Strategy strategy)
```
    Set (optional) traversal strategy.
    
    Parameters:
    
    strategy -
    
    Returns:
    
    this
  - getOrder
```
public InternalTraversalDriver.Order getOrder()
```
  - setOrder
```
public TraversalQueryOptions setOrder(InternalTraversalDriver.Order order)
```
    Set the (optional) traversal order
    
    Parameters:
    
    order -
    
    Returns:
    
    this
  - getItemOrder
```
public InternalTraversalDriver.ItemOrder getItemOrder()
```
  - setItemOrder
```
public TraversalQueryOptions setItemOrder(InternalTraversalDriver.ItemOrder itemOrder)
```
    Set the (optional) item iteration order
    
    Parameters:
    
    itemOrder -
    
    Returns:
    
    this
  - getVerticesUniqueness
```
public InternalTraversalDriver.Uniqueness getVerticesUniqueness()
```
  - setVerticesUniqueness
```
public TraversalQueryOptions setVerticesUniqueness(InternalTraversalDriver.Uniqueness verticesUniqueness)
```
    Set the (optional) uniqueness type for vertices visited if set
    
    Parameters:
    
    verticesUniqueness -
    
    Returns:
    
    this
  - getEdgesUniqueness
```
public InternalTraversalDriver.Uniqueness getEdgesUniqueness()
```
  - setEdgesUniqueness
```
public TraversalQueryOptions setEdgesUniqueness(InternalTraversalDriver.Uniqueness edgesUniqueness)
```
    Set the (optional) uniqueness type for edges visited if set
    
    Parameters:
    
    edgesUniqueness -
    
    Returns:
    
    this
  - getMaxIterations
```
public Long getMaxIterations()
```
  - setMaxIterations
```
public TraversalQueryOptions setMaxIterations(Long maxIterations)
```
    Set the (optional) maximum number of iterations in each traversal
    
    Parameters:
    
    maxIterations -
    
    Returns:
    
    this
  - toMap
```
public Map<String,Object> toMap()
```
    Specified by:
    
    toMap in interface OptionsInterface

Class TraversalQueryOptions

Constructor Summary

Method Summary

Methods inherited from class com.arangodb.util.AbstractOptions

Methods inherited from class java.lang.Object

Constructor Detail

TraversalQueryOptions

Method Detail

getGraphName

setGraphName

getEdgeCollection

setEdgeCollection

getStartVertex

setStartVertex

getFilter

setFilter

getMinDepth

setMinDepth

getMaxDepth

setMaxDepth

getVisitor

setVisitor

getDirection

setDirection

getInit

setInit

getExpander

setExpander

getSort

setSort

getStrategy

setStrategy

getOrder

setOrder

getItemOrder

setItemOrder

getVerticesUniqueness

setVerticesUniqueness

getEdgesUniqueness

setEdgesUniqueness

getMaxIterations

setMaxIterations

toMap