com.arangodb.util

Class ShortestPathOptions

java.lang.Object

com.arangodb.util.ShortestPathOptions

public class ShortestPathOptions
extends Object

Constructor Summary

Constructors

Constructor and Description
ShortestPathOptions()

Method Summary

Modifier and Type	Method and Description
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.
List<String>	getEndVertexCollectionRestriction() One or multiple vertex collection names.
Boolean	getIncludeData() Get include data
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	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	setEndVertexCollectionRestriction(List<String> endVertexCollectionRestriction) One or multiple vertex collection names.
ShortestPathOptions	setIncludeData(Boolean includeData) set include data to be compatible with older versions of AnrangoDB
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.

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

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

getIncludeData

public Boolean getIncludeData()

Get include data

Returns:

returns true, if the return values are compatible with older versions of AnrangoDB

setIncludeData

public ShortestPathOptions setIncludeData(Boolean includeData)

set include data to be compatible with older versions of AnrangoDB

Parameters:

includeData -

Since:

ArangoDB 2.6