Module org.neo4j.cypherdsl.core

Package org.neo4j.cypherdsl.core

Interface ExposesMatch

All Known Subinterfaces:

ExposesSubqueryCall.BuildableSubquery, LoadCSVStatementBuilder, StatementBuilder, StatementBuilder.OngoingInQueryCallWithReturnFields, StatementBuilder.OngoingReading, StatementBuilder.OngoingReadingAndWith, StatementBuilder.OngoingReadingAndWithWithSkip, StatementBuilder.OngoingReadingAndWithWithWhereAndOrder, StatementBuilder.OngoingReadingWithoutWhere, StatementBuilder.OngoingReadingWithWhere, StatementBuilder.OngoingStandaloneCallWithReturnFields, StatementBuilder.OrderableOngoingReadingAndWith, StatementBuilder.OrderableOngoingReadingAndWithWithoutWhere, StatementBuilder.OrderableOngoingReadingAndWithWithWhere, StatementBuilder.VoidCall

@API(status=STABLE,
     since="1.0")
public interface ExposesMatch

A step exposing a match(PatternElement...) method. This is one of the main entry points of most Cypher queries.

Since:

1.0

Author:

Michael J. Simons

Method Summary

Modifier and Type	Method	Description
StatementBuilder.OngoingReadingWithoutWhere	match(boolean optional, PatternElement... pattern)	Adds (another) MATCH clause.
default StatementBuilder.OngoingReadingWithoutWhere	match(Collection<? extends PatternElement> pattern)	Adds (another) MATCH clause.
default StatementBuilder.OngoingReadingWithoutWhere	match(PatternElement... pattern)	Adds (another) MATCH clause.
default StatementBuilder.OngoingReadingWithoutWhere	optionalMatch(Collection<? extends PatternElement> pattern)	Adds (another) optional MATCH clause.
default StatementBuilder.OngoingReadingWithoutWhere	optionalMatch(PatternElement... pattern)	Adds (another) optional MATCH clause.

Method Details

match

@NotNull
@CheckReturnValue
default StatementBuilder.OngoingReadingWithoutWhere match(PatternElement... pattern)

Adds (another) MATCH clause.

Parameters:

pattern - The patterns to match

Returns:

An ongoing match that is used to specify an optional where and a required return clause

match

@NotNull
@CheckReturnValue
default StatementBuilder.OngoingReadingWithoutWhere match(Collection<? extends PatternElement> pattern)

Adds (another) MATCH clause.

Parameters:

pattern - The patterns to match

Returns:

An ongoing match that is used to specify an optional where and a required return clause

Since:

2021.2.2

optionalMatch

@NotNull
@CheckReturnValue
default StatementBuilder.OngoingReadingWithoutWhere optionalMatch(PatternElement... pattern)

Adds (another) optional MATCH clause.

Parameters:

pattern - The patterns to match

Returns:

An ongoing match that is used to specify an optional where and a required return clause

optionalMatch

@NotNull
@CheckReturnValue
default StatementBuilder.OngoingReadingWithoutWhere optionalMatch(Collection<? extends PatternElement> pattern)

Adds (another) optional MATCH clause.

Parameters:

pattern - The patterns to match

Returns:

An ongoing match that is used to specify an optional where and a required return clause

Since:

2021.2.2

match

@NotNull
@CheckReturnValue
StatementBuilder.OngoingReadingWithoutWhere match(boolean optional,
 PatternElement... pattern)

Adds (another) MATCH clause.

Parameters:

optional - A flag whether the MATCH clause includes the OPTIONAL keyword.

pattern - The patterns to match

Returns:

An ongoing match that is used to specify an optional where and a required return clause

Since:

2020.1.3