Package org.apache.tinkerpop.gremlin.process.traversal.strategy.verification

Class ReservedKeysVerificationStrategy

java.lang.Object

org.apache.tinkerpop.gremlin.process.traversal.strategy.AbstractTraversalStrategy<TraversalStrategy.VerificationStrategy>

org.apache.tinkerpop.gremlin.process.traversal.strategy.verification.AbstractWarningVerificationStrategy

org.apache.tinkerpop.gremlin.process.traversal.strategy.verification.ReservedKeysVerificationStrategy

All Implemented Interfaces:

Serializable, Comparable<Class<? extends TraversalStrategy>>, TraversalStrategy<TraversalStrategy.VerificationStrategy>, TraversalStrategy.VerificationStrategy

public class ReservedKeysVerificationStrategy
extends AbstractWarningVerificationStrategy

This verification strategy detects property keys that should not be used by the traversal. A term may be reserved by a particular graph implementation or as a convention given best practices.

Author:

Stephen Mallette (http://stephen.genoprime.com) * @example

  * __.addV("person").property("id", 123)           // throws an IllegalStateException
  * __.addE("knows").property("label", "green")     // throws an IllegalStateException
  * 

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ReservedKeysVerificationStrategy.Builder

Nested classes/interfaces inherited from interface org.apache.tinkerpop.gremlin.process.traversal.TraversalStrategy

TraversalStrategy.DecorationStrategy, TraversalStrategy.FinalizationStrategy, TraversalStrategy.OptimizationStrategy, TraversalStrategy.ProviderOptimizationStrategy, TraversalStrategy.VerificationStrategy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEYS

Fields inherited from class org.apache.tinkerpop.gremlin.process.traversal.strategy.verification.AbstractWarningVerificationStrategy

LOG_WARNING, logWarning, THROW_EXCEPTION, throwException

Method Summary

Modifier and Type	Method	Description
static ReservedKeysVerificationStrategy.Builder	build()
static ReservedKeysVerificationStrategy	create(org.apache.commons.configuration2.Configuration configuration)
org.apache.commons.configuration2.Configuration	getConfiguration()	Get the configuration representation of this strategy.
Set<String>	getReservedKeys()

Methods inherited from class org.apache.tinkerpop.gremlin.process.traversal.strategy.verification.AbstractWarningVerificationStrategy

apply, isLogWarning, isThrowException

Methods inherited from class org.apache.tinkerpop.gremlin.process.traversal.strategy.AbstractTraversalStrategy

equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.tinkerpop.gremlin.process.traversal.TraversalStrategy

applyPost, applyPrior

Methods inherited from interface org.apache.tinkerpop.gremlin.process.traversal.TraversalStrategy.VerificationStrategy

compareTo, getTraversalCategory

Field Details

KEYS

public static final String KEYS

See Also:

• Constant Field Values

Method Details

getReservedKeys

public Set<String> getReservedKeys()

create

public static ReservedKeysVerificationStrategy create(org.apache.commons.configuration2.Configuration configuration)

getConfiguration

public org.apache.commons.configuration2.Configuration getConfiguration()

Description copied from interface: TraversalStrategy

Get the configuration representation of this strategy. This is useful for converting a strategy into a serialized form.

Specified by:

getConfiguration in interface TraversalStrategy<TraversalStrategy.VerificationStrategy>

Overrides:

getConfiguration in class AbstractWarningVerificationStrategy

Returns:

the configuration used to create this strategy

build

public static ReservedKeysVerificationStrategy.Builder build()