Package org.apache.tinkerpop.gremlin.process.traversal.step.util

Class WithOptions

java.lang.Object

org.apache.tinkerpop.gremlin.process.traversal.step.util.WithOptions

public class WithOptions
extends Object

Configuration options to be passed to the GraphTraversal.with(String, Object).

Author:

Daniel Kuppitz (http://gremlin.guru)

Field Summary

Fields

Modifier and Type	Field	Description
static int	all	Include all tokens.
static int	ids	Include ids (affects all Element value maps).
static final String	indexer	Configures the indexer to be used in IndexStep.
static int	keys	Include keys (affects all VertexProperty value maps).
static int	labels	Include labels (affects all Vertex and Edge value maps).
static int	list	Index items using 2-item lists.
static int	map	Index items using a LinkedHashMap.
static final String	MULTILABEL_KEY	The user-facing key for multilabel configuration used with g.with("multilabel").
static int	none	Include no tokens.
static final String	queryLanguage	Configures the query language to be used in a declarative match step.
static final String	SINGLELABEL_KEY	The user-facing key for singlelabel override used with g.with("singlelabel").
static final String	tokens	Configures the tokens to be included in value maps.
static int	values	Include values (affects all VertexProperty value maps).

Constructor Summary

Constructors

Constructor	Description
WithOptions()

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

tokens

public static final String tokens

Configures the tokens to be included in value maps.

none

public static int none

Include no tokens.

ids

public static int ids

Include ids (affects all Element value maps).

labels

public static int labels

Include labels (affects all Vertex and Edge value maps).

keys

public static int keys

Include keys (affects all VertexProperty value maps).

values

public static int values

Include values (affects all VertexProperty value maps).

all

public static int all

Include all tokens.

indexer

public static final String indexer

Configures the indexer to be used in IndexStep.

list

public static int list

Index items using 2-item lists.

map

public static int map

Index items using a LinkedHashMap.

queryLanguage

public static final String queryLanguage

Configures the query language to be used in a declarative match step.

Since:

4.0.0

See Also:

• Constant Field Values

MULTILABEL_KEY

public static final String MULTILABEL_KEY

The user-facing key for multilabel configuration used with g.with("multilabel"). This option is mutually exclusive with SINGLELABEL_KEY - configuring both on the same traversal source is rejected during traversal strategy verification.

See Also:

• Constant Field Values

SINGLELABEL_KEY

public static final String SINGLELABEL_KEY

The user-facing key for singlelabel override used with g.with("singlelabel"). Forces single-label output in valueMap/elementMap steps. This option is mutually exclusive with MULTILABEL_KEY - configuring both on the same traversal source is rejected during traversal strategy verification.

See Also:

• Constant Field Values

Constructor Details

WithOptions

public WithOptions()