ShortestPathOptions (arangodb-java-driver 2.6.11 API)

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

All Implemented Interfaces:: OptionsInterface

public class ShortestPathOptions
extends AbstractOptions
implements OptionsInterface

Constructor Summary

Constructors
Constructor and Description

ShortestPathOptions()

Constructors
Constructor and Description
`ShortestPathOptions()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAlgorithm()` The algorithm to calculate the shortest paths.
`Long`	`getDefaultWeight()` Only used with the option weight.
`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.
`List<String>`	`getStartVertexCollectionRestriction()` One or multiple vertex collection names.
`String`	`getWeight()` The name of the attribute of the edges containing the length as a string.
`ShortestPathOptions`	`setAlgorithm(String algorithm)` The algorithm to calculate the shortest paths.
`ShortestPathOptions`	`setDefaultWeight(Long defaultWeight)` Only used with the option weight.
`ShortestPathOptions`	`setDirection(Direction direction)` The direction of the edges as a string.
`ShortestPathOptions`	`setEdgeCollectionRestriction(List<String> edgeCollectionRestriction)` One or multiple edge collection names.
`ShortestPathOptions`	`setEdgeExamples(Object edgeExamples)` A filter example for the edges
`ShortestPathOptions`	`setEndVertexCollectionRestriction(List<String> endVertexCollectionRestriction)` One or multiple vertex collection names.
`ShortestPathOptions`	`setStartVertexCollectionRestriction(List<String> startVertexCollectionRestriction)` One or multiple vertex collection names.
`ShortestPathOptions`	`setWeight(String weight)` The name of the attribute of the edges containing the length as a string.
`Map<String,Object>`	`toMap()` Returns a map of the options

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
  - ShortestPathOptions
```
public ShortestPathOptions()
```
- 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 ShortestPathOptions 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 ShortestPathOptions 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 ShortestPathOptions 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 ShortestPathOptions 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 ShortestPathOptions setEdgeExamples(Object edgeExamples)
```
    A filter example for the edges
    
    Parameters:
    
    edgeExamples -
    
    Returns:
    
    this
  - getAlgorithm
```
public String getAlgorithm()
```
    The algorithm to calculate the shortest paths. If both start and end vertex examples are empty Floyd-Warshall is used, otherwise the default is Dijkstra.
    
    Returns:
    
    The algorithm to calculate the shortest paths.
  - setAlgorithm
```
public ShortestPathOptions setAlgorithm(String algorithm)
```
    The algorithm to calculate the shortest paths. If both start and end vertex examples are empty Floyd-Warshall is used, otherwise the default is Dijkstra.
    
    Parameters:
    
    algorithm -
    
    Returns:
    
    this
  - getWeight
```
public String getWeight()
```
    The name of the attribute of the edges containing the length as a string.
    
    Returns:
    
    The name of the attribute
  - setWeight
```
public ShortestPathOptions setWeight(String weight)
```
    The name of the attribute of the edges containing the length as a string.
    
    Parameters:
    
    weight -
    
    Returns:
    
    this
  - getDefaultWeight
```
public Long getDefaultWeight()
```
    Only used with the option weight. If an edge does not have the attribute named as defined in option weight this default is used as length. If no default is supplied the default would be positive Infinity so the path could not be calculated.
    
    Returns:
    
    a default weight
  - setDefaultWeight
```
public ShortestPathOptions setDefaultWeight(Long defaultWeight)
```
    Only used with the option weight. If an edge does not have the attribute named as defined in option weight this default is used as length. If no default is supplied the default would be positive Infinity so the path could not be calculated.
    
    Parameters:
    
    defaultWeight -
    
    Returns:
    
    this
  - toMap
```
public Map<String,Object> toMap()
```
    Returns a map of the options
    
    Specified by:
    
    toMap in interface OptionsInterface
    
    Returns:
    
    a map

Class ShortestPathOptions

Constructor Summary

Method Summary

Methods inherited from class com.arangodb.util.AbstractOptions

Methods inherited from class java.lang.Object

Constructor Detail

ShortestPathOptions

Method Detail

getDirection

setDirection

getEdgeCollectionRestriction

setEdgeCollectionRestriction

getStartVertexCollectionRestriction

setStartVertexCollectionRestriction

getEndVertexCollectionRestriction

setEndVertexCollectionRestriction

getEdgeExamples

setEdgeExamples

getAlgorithm

setAlgorithm

getWeight

setWeight

getDefaultWeight

setDefaultWeight

toMap