Module org.neo4j.cypherdsl.core

Package org.neo4j.cypherdsl.core

Class Predicates

java.lang.Object

org.neo4j.cypherdsl.core.Predicates

@API(status=DEPRECATED,
     since="2023.9.0")
@Deprecated(since="2023.9.0")
public final class Predicates
extends Object

Deprecated.

use Cypher instead. This class will become package private in the next major release and no longer be accessible.

Factory methods for creating predicates.

Since:

1.0

Author:

Michael J. Simons

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Predicates.OngoingListBasedPredicateFunction	Deprecated. Allows to define the source of the list predicate.
static interface	Predicates.OngoingListBasedPredicateFunctionWithList	Deprecated. Allows to specify the where condition for the list based predicate.

Method Summary

Modifier and Type	Method	Description
static @NotNull Predicates.OngoingListBasedPredicateFunction	all(String variable)	Deprecated.
static @NotNull Predicates.OngoingListBasedPredicateFunction	all(SymbolicName variable)	Deprecated. Starts building a new condition based on a function invocation for the all() function.
static @NotNull Predicates.OngoingListBasedPredicateFunction	any(String variable)	Deprecated.
static @NotNull Predicates.OngoingListBasedPredicateFunction	any(SymbolicName variable)	Deprecated. Starts building a new condition based on a function invocation for the any() function.
static Condition	exists(List<PatternElement> pattern)	Deprecated. Creates a new condition via an existential sub-query based on the list of patterns
static Condition	exists(List<PatternElement> pattern, @Nullable Where where)	Deprecated. Creates a new condition via an existential sub-query based on the list of patterns and an optional where-clause.
static Condition	exists(PatternElement pattern)	Deprecated. Creates a new condition via an existential sub-query based on the list of patterns
static @NotNull Condition	exists(Property property)	Deprecated. Creates a new condition based on a function invocation for the exists() function.
static @NotNull Condition	exists(RelationshipPattern pattern)	Deprecated. Creates a new condition based on a function invocation for the exists() function.
static Condition	exists(Statement statement, IdentifiableElement... imports)	Deprecated. Creates a new condition via an existential sub-query.
static Condition	isEmpty(Expression e)	Deprecated. Creates a new condition based on a function invocation for the isEmpty() function.
static @NotNull Predicates.OngoingListBasedPredicateFunction	none(String variable)	Deprecated.
static @NotNull Predicates.OngoingListBasedPredicateFunction	none(SymbolicName variable)	Deprecated. Starts building a new condition based on a function invocation for the none() function.
static @NotNull Predicates.OngoingListBasedPredicateFunction	single(String variable)	Deprecated.
static @NotNull Predicates.OngoingListBasedPredicateFunction	single(SymbolicName variable)	Deprecated. Starts building a new condition based on a function invocation for the single() function.

Methods inherited from class java.lang.Object

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

Method Details

exists

@NotNull
@Contract(pure=true)
public static @NotNull Condition exists(Property property)

Deprecated.

Creates a new condition based on a function invocation for the exists() function. See exists.

Parameters:

property - The property to be passed to exists()

Returns:

A function call for exists() for one property

exists

@NotNull
@Contract(pure=true)
public static @NotNull Condition exists(RelationshipPattern pattern)

Deprecated.

Creates a new condition based on a function invocation for the exists() function. See exists.

Parameters:

pattern - The pattern to be passed to exists()

Returns:

A function call for exists() for one pattern

exists

public static Condition exists(Statement statement,
 IdentifiableElement... imports)

Deprecated.

Creates a new condition via an existential sub-query. The statement may or may not have a RETURN clause. It must however not contain any updates. While it would render syntactically correct Cypher, Neo4j does not support updates inside existential sub-queries.

Parameters:

statement - The statement to be passed to exists{}

imports - Optional imports to be used in the statement (will be imported with WITH)

Returns:

An existential sub-query.

Since:

2023.1.0

exists

public static Condition exists(PatternElement pattern)

Deprecated.

Creates a new condition via an existential sub-query based on the list of patterns

Parameters:

pattern - the pattern that must exists

Returns:

An existential sub-query.

Since:

2023.9.0

exists

public static Condition exists(List<PatternElement> pattern)

Deprecated.

Creates a new condition via an existential sub-query based on the list of patterns

Parameters:

pattern - the list of patterns that must exists

Returns:

An existential sub-query.

Since:

2023.9.0

exists

public static Condition exists(List<PatternElement> pattern,
 @Nullable
 @Nullable Where where)

Deprecated.

Creates a new condition via an existential sub-query based on the list of patterns and an optional where-clause.

Parameters:

pattern - the list of patterns that must exists

where - an optional where-clause

Returns:

An existential sub-query.

Since:

2023.9.0

all

@NotNull
@Contract(pure=true)
public static @NotNull Predicates.OngoingListBasedPredicateFunction all(String variable)

Deprecated.

Parameters:

variable - The variable referring to elements of a list

Returns:

A builder for the all() predicate function

Since:

1.1

See Also:

• all(SymbolicName)

all

@NotNull
@Contract(pure=true)
public static @NotNull Predicates.OngoingListBasedPredicateFunction all(SymbolicName variable)

Deprecated.

Starts building a new condition based on a function invocation for the all() function. See exists.

Parameters:

variable - The variable referring to elements of a list

Returns:

A builder for the all() predicate function

Since:

1.1

any

@NotNull
@Contract(pure=true)
public static @NotNull Predicates.OngoingListBasedPredicateFunction any(String variable)

Deprecated.

Parameters:

variable - The variable referring to elements of a list

Returns:

A builder for the any() predicate function

Since:

1.1

See Also:

• any(SymbolicName)

any

@NotNull
@Contract(pure=true)
public static @NotNull Predicates.OngoingListBasedPredicateFunction any(SymbolicName variable)

Deprecated.

Starts building a new condition based on a function invocation for the any() function. See exists.

Parameters:

variable - The variable referring to elements of a list

Returns:

A builder for the any() predicate function

Since:

1.1

none

@NotNull
@Contract(pure=true)
public static @NotNull Predicates.OngoingListBasedPredicateFunction none(String variable)

Deprecated.

Parameters:

variable - The variable referring to elements of a list

Returns:

A builder for the none() predicate function

Since:

1.1

See Also:

• none(SymbolicName)

none

@NotNull
@Contract(pure=true)
public static @NotNull Predicates.OngoingListBasedPredicateFunction none(SymbolicName variable)

Deprecated.

Starts building a new condition based on a function invocation for the none() function. See exists.

Parameters:

variable - The variable referring to elements of a list

Returns:

A builder for the none() predicate function

Since:

1.1

single

@NotNull
@Contract(pure=true)
public static @NotNull Predicates.OngoingListBasedPredicateFunction single(String variable)

Deprecated.

Parameters:

variable - The variable referring to elements of a list

Returns:

A builder for the single() predicate function

Since:

1.1

See Also:

• single(SymbolicName)

single

@NotNull
@Contract(pure=true)
public static @NotNull Predicates.OngoingListBasedPredicateFunction single(SymbolicName variable)

Deprecated.

Starts building a new condition based on a function invocation for the single() function. See exists.

Parameters:

variable - The variable referring to elements of a list

Returns:

A builder for the single() predicate function

Since:

1.1

isEmpty

public static Condition isEmpty(Expression e)

Deprecated.

Creates a new condition based on a function invocation for the isEmpty() function. See isEmpty.

The argument e must refer to an expression that evaluates to a list for isEmpty() to work

Parameters:

e - An expression referring to a list

Returns:

A function call for isEmpty() for a list

Since:

2023.6.1