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

Class TextP

java.lang.Object

org.apache.tinkerpop.gremlin.process.traversal.P<String>

org.apache.tinkerpop.gremlin.process.traversal.TextP

All Implemented Interfaces:

Serializable, Cloneable, Predicate<String>

public class TextP
extends P<String>

Predefined Predicate values that can be used as String filters.

Author:

Daniel Kuppitz (http://gremlin.guru)

See Also:

• Serialized Form

Field Summary

Fields inherited from class org.apache.tinkerpop.gremlin.process.traversal.P

biPredicate, literals, variables

Constructor Summary

Constructors

Modifier	Constructor	Description
	TextP(PBiPredicate<String,String> biPredicate, String value)
protected	TextP(PBiPredicate<String,String> biPredicate, Collection<String> literals, Map<String,String> variables)
	TextP(PBiPredicate<String,String> biPredicate, org.apache.tinkerpop.gremlin.process.traversal.step.GValue<String> value)
	TextP(PBiPredicate<String,String> biPredicate, Traversal.Admin<?,?> traversalValue)	Constructs a TextP with a child traversal whose result is resolved at runtime against the current traverser.

Method Summary

Modifier and Type	Method	Description
TextP	clone()
static TextP	containing(String value)	Determines if String does contain the given value.
static TextP	containing(org.apache.tinkerpop.gremlin.process.traversal.step.GValue<String> value)	Determines if String does contain the given value.
static TextP	containing(Traversal<?,?> traversalValue)	Determines if String does contain the value resolved from a child traversal at runtime.
static TextP	endingWith(String value)	Determines if String does end with the given value.
static TextP	endingWith(org.apache.tinkerpop.gremlin.process.traversal.step.GValue<String> value)	Determines if String does end with the given value.
static TextP	endingWith(Traversal<?,?> traversalValue)	Determines if String does end with the value resolved from a child traversal at runtime.
boolean	equals(Object other)
P<String>	negate()
static TextP	notContaining(String value)	Determines if String does not contain the given value.
static TextP	notContaining(org.apache.tinkerpop.gremlin.process.traversal.step.GValue<String> value)	Determines if String does not contain the given value.
static TextP	notContaining(Traversal<?,?> traversalValue)	Determines if String does not contain the value resolved from a child traversal at runtime.
static TextP	notEndingWith(String value)	Determines if String does not end with the given value.
static TextP	notEndingWith(org.apache.tinkerpop.gremlin.process.traversal.step.GValue<String> value)	Determines if String does not end with the given value.
static TextP	notEndingWith(Traversal<?,?> traversalValue)	Determines if String does not end with the value resolved from a child traversal at runtime.
static TextP	notRegex(String value)	Determines if String has no match with the given regex pattern and the reference implementation treats it as a simple negation of the evaluation of the pattern match of regex(String).
static TextP	notRegex(org.apache.tinkerpop.gremlin.process.traversal.step.GValue<String> value)	Determines if String has no match with the given regex pattern and the reference implementation treats it as a simple negation of the evaluation of the pattern match of regex(String).
static TextP	notStartingWith(String value)	Determines if String does not start with the given value.
static TextP	notStartingWith(org.apache.tinkerpop.gremlin.process.traversal.step.GValue<String> value)	Determines if String does not start with the given value.
static TextP	notStartingWith(Traversal<?,?> traversalValue)	Determines if String does not start with the value resolved from a child traversal at runtime.
static TextP	regex(String value)	Determines if String has a match with the given regex pattern.
static TextP	regex(org.apache.tinkerpop.gremlin.process.traversal.step.GValue<String> value)	Determines if String has a match with the given regex pattern.
static TextP	startingWith(String value)	Determines if String does start with the given value.
static TextP	startingWith(org.apache.tinkerpop.gremlin.process.traversal.step.GValue<String> value)	Determines if String does start with the given value.
static TextP	startingWith(Traversal<?,?> traversalValue)	Determines if String does start with the value resolved from a child traversal at runtime.

Methods inherited from class org.apache.tinkerpop.gremlin.process.traversal.P

and, between, between, collectTraversals, eq, eq, eq, getBiPredicate, getChildTraversals, getGValues, getPredicateName, getValue, gt, gt, gt, gte, gte, gte, hashCode, hasTraversal, inside, inside, isParameterized, isResolvedEmpty, lt, lt, lt, lte, lte, lte, neq, neq, neq, not, or, outside, outside, resolve, setValue, test, test, toString, typeOf, typeOf, typeOf, updateVariable, within, within, within, within, within, without, without, without, without, without

Methods inherited from class java.lang.Object

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

Constructor Details

TextP

public TextP(PBiPredicate<String,String> biPredicate,
 String value)

TextP

public TextP(PBiPredicate<String,String> biPredicate,
 org.apache.tinkerpop.gremlin.process.traversal.step.GValue<String> value)

TextP

public TextP(PBiPredicate<String,String> biPredicate,
 Traversal.Admin<?,?> traversalValue)

Constructs a TextP with a child traversal whose result is resolved at runtime against the current traverser. The traversal must produce a String result.

Since:

4.0.0

TextP

protected TextP(PBiPredicate<String,String> biPredicate,
 Collection<String> literals,
 Map<String,String> variables)

Method Details

equals

public boolean equals(Object other)

Overrides:

equals in class P<String>

negate

public P<String> negate()

Specified by:

negate in interface Predicate<String>

Overrides:

negate in class P<String>

clone

public TextP clone()

Overrides:

clone in class P<String>

startingWith

public static TextP startingWith(String value)

Determines if String does start with the given value.

Since:

3.4.0

startingWith

public static TextP startingWith(org.apache.tinkerpop.gremlin.process.traversal.step.GValue<String> value)

Determines if String does start with the given value.

Since:

3.8.0

startingWith

public static TextP startingWith(Traversal<?,?> traversalValue)

Determines if String does start with the value resolved from a child traversal at runtime.

Since:

4.0.0

notStartingWith

public static TextP notStartingWith(String value)

Determines if String does not start with the given value.

Since:

3.4.0

notStartingWith

public static TextP notStartingWith(org.apache.tinkerpop.gremlin.process.traversal.step.GValue<String> value)

Determines if String does not start with the given value.

Since:

3.8.0

notStartingWith

public static TextP notStartingWith(Traversal<?,?> traversalValue)

Determines if String does not start with the value resolved from a child traversal at runtime.

Since:

4.0.0

endingWith

public static TextP endingWith(String value)

Determines if String does end with the given value.

Since:

3.4.0

endingWith

public static TextP endingWith(org.apache.tinkerpop.gremlin.process.traversal.step.GValue<String> value)

Determines if String does end with the given value.

Since:

3.8.0

endingWith

public static TextP endingWith(Traversal<?,?> traversalValue)

Determines if String does end with the value resolved from a child traversal at runtime.

Since:

4.0.0

notEndingWith

public static TextP notEndingWith(String value)

Determines if String does not end with the given value.

Since:

3.4.0

notEndingWith

public static TextP notEndingWith(org.apache.tinkerpop.gremlin.process.traversal.step.GValue<String> value)

Determines if String does not end with the given value.

Since:

3.8.0

notEndingWith

public static TextP notEndingWith(Traversal<?,?> traversalValue)

Determines if String does not end with the value resolved from a child traversal at runtime.

Since:

4.0.0

containing

public static TextP containing(String value)

Determines if String does contain the given value.

Since:

3.4.0

containing

public static TextP containing(org.apache.tinkerpop.gremlin.process.traversal.step.GValue<String> value)

Determines if String does contain the given value.

Since:

3.8.0

containing

public static TextP containing(Traversal<?,?> traversalValue)

Determines if String does contain the value resolved from a child traversal at runtime.

Since:

4.0.0

notContaining

public static TextP notContaining(String value)

Determines if String does not contain the given value.

Since:

3.4.0

notContaining

public static TextP notContaining(org.apache.tinkerpop.gremlin.process.traversal.step.GValue<String> value)

Determines if String does not contain the given value.

Since:

3.8.0

notContaining

public static TextP notContaining(Traversal<?,?> traversalValue)

Determines if String does not contain the value resolved from a child traversal at runtime.

Since:

4.0.0

regex

public static TextP regex(String value)

Determines if String has a match with the given regex pattern. The TinkerPop reference implementation uses Java syntax for regex. The string is considered a match to the pattern if any substring matches the pattern. It is therefore important to use the appropriate boundary matchers (e.g. `$` for end of a line) to ensure a proper match.

Since:

3.6.0

regex

public static TextP regex(org.apache.tinkerpop.gremlin.process.traversal.step.GValue<String> value)

Determines if String has a match with the given regex pattern. The TinkerPop reference implementation uses Java syntax for regex. The string is considered a match to the pattern if any substring matches the pattern. It is therefore important to use the appropriate boundary matchers (e.g. `$` for end of a line) to ensure a proper match.

Since:

3.8.0

notRegex

public static TextP notRegex(String value)

Determines if String has no match with the given regex pattern and the reference implementation treats it as a simple negation of the evaluation of the pattern match of regex(String).

Since:

3.6.0

notRegex

public static TextP notRegex(org.apache.tinkerpop.gremlin.process.traversal.step.GValue<String> value)

Determines if String has no match with the given regex pattern and the reference implementation treats it as a simple negation of the evaluation of the pattern match of regex(String).

Since:

3.8.0