org.springframework.data.mongodb.core.aggregation

Class StringOperators.RegexFindAll

java.lang.Object

org.springframework.data.mongodb.core.aggregation.StringOperators.RegexFindAll

All Implemented Interfaces:

AggregationExpression, MongoExpression

Enclosing class:

StringOperators

public static class StringOperators.RegexFindAll
extends Object

AggregationExpression for $regexFindAll which applies a regular expression (regex) to a string and returns information on all the matched substrings.
NOTE: Requires MongoDB 4.0 or later.

Since:

3.3

Author:

Divya Srivastava

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AbstractAggregationExpression.Expand Expand a nested list of values to single entries or keep the list.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RegexFindAll(Object value)

Method Summary

Modifier and Type	Method and Description
protected List<Object>	append(Object value)
protected List<Object>	append(Object value, AbstractAggregationExpression.Expand expandList)
protected Map<String,Object>	append(String key, Object value)
protected Map<String,Object>	appendAt(int index, String key, Object value) Append the given key at the position in the underlying LinkedHashMap.
protected Map<String,Object>	argumentMap() Get the argument map.
protected static List<Field>	asFields(String... fieldRefs)
protected boolean	contains(Object key) Check if the given key is available.
protected <T> T	get(int index) Get the value at a given index.
protected <T> T	get(Object key) Get the value for a given key.
protected String	getMongoMethod()
StringOperators.RegexFindAll	options(String options) Optional specify the options to use with the regular expression.
StringOperators.RegexFindAll	optionsOf(AggregationExpression expression) Optional specify the AggregationExpression evaluating to the options values to use with the regular expression.
StringOperators.RegexFindAll	optionsOf(String fieldReference) Optional specify the reference to the field holding the options values to use with the regular expression.
StringOperators.RegexFindAll	pattern(Pattern pattern) Apply a Pattern into regex and options fields.
StringOperators.RegexFindAll	regex(String regex) Specify the regular expression to apply.
StringOperators.RegexFindAll	regexOf(AggregationExpression expression) Specify the AggregationExpression evaluating to the regular expression to apply.
StringOperators.RegexFindAll	regexOf(String fieldReference) Specify the reference to the field holding the regular expression to apply.
protected Map<String,Object>	remove(String key)
org.bson.Document	toDocument(AggregationOperationContext context) Turns the AggregationExpression into a Document within the given AggregationOperationContext.
org.bson.Document	toDocument(Object value, AggregationOperationContext context)
static StringOperators.RegexFindAll	valueOf(AggregationExpression expression) Creates new StringOperators.RegexFindAll using the result of the provided AggregationExpression as input value.
static StringOperators.RegexFindAll	valueOf(String fieldReference) Creates new StringOperators.RegexFindAll using the value of the provided fieldReference as input value.
protected List<Object>	values()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.data.mongodb.core.aggregation.AggregationExpression

from, toDocument

Methods inherited from interface org.springframework.data.mongodb.MongoExpression

create, create

Constructor Detail

RegexFindAll

protected RegexFindAll(Object value)

Method Detail

valueOf

public static StringOperators.RegexFindAll valueOf(String fieldReference)

Creates new StringOperators.RegexFindAll using the value of the provided fieldReference as input value.

Parameters:

fieldReference - must not be null.

Returns:

new instance of StringOperators.RegexFindAll.

valueOf

public static StringOperators.RegexFindAll valueOf(AggregationExpression expression)

Creates new StringOperators.RegexFindAll using the result of the provided AggregationExpression as input value.

Parameters:

expression - must not be null.

Returns:

new instance of StringOperators.RegexFindAll.

options

public StringOperators.RegexFindAll options(String options)

Optional specify the options to use with the regular expression.

Parameters:

options - must not be null.

Returns:

new instance of StringOperators.RegexFindAll.

optionsOf

public StringOperators.RegexFindAll optionsOf(String fieldReference)

Optional specify the reference to the field holding the options values to use with the regular expression.

Parameters:

fieldReference - must not be null.

Returns:

new instance of StringOperators.RegexFindAll.

optionsOf

public StringOperators.RegexFindAll optionsOf(AggregationExpression expression)

Optional specify the AggregationExpression evaluating to the options values to use with the regular expression.

Parameters:

expression - must not be null.

Returns:

new instance of StringOperators.RegexFindAll.

pattern

public StringOperators.RegexFindAll pattern(Pattern pattern)

Apply a Pattern into regex and options fields.

Parameters:

pattern - must not be null.

Returns:

new instance of StringOperators.RegexFindAll.

regex

public StringOperators.RegexFindAll regex(String regex)

Specify the regular expression to apply.

Parameters:

regex - must not be null.

Returns:

new instance of StringOperators.RegexFindAll.

regexOf

public StringOperators.RegexFindAll regexOf(String fieldReference)

Specify the reference to the field holding the regular expression to apply.

Parameters:

fieldReference - must not be null.

Returns:

new instance of StringOperators.RegexFindAll.

regexOf

public StringOperators.RegexFindAll regexOf(AggregationExpression expression)

Specify the AggregationExpression evaluating to the regular expression to apply.

Parameters:

expression - must not be null.

Returns:

new instance of StringOperators.RegexFindAll.

getMongoMethod

protected String getMongoMethod()

toDocument

public org.bson.Document toDocument(AggregationOperationContext context)

Description copied from interface: AggregationExpression

Turns the AggregationExpression into a Document within the given AggregationOperationContext.

Specified by:

toDocument in interface AggregationExpression

Parameters:

context - must not be null.

Returns:

the MongoDB native (Document) form of the expression.

toDocument

public org.bson.Document toDocument(Object value,
                                    AggregationOperationContext context)

asFields

protected static List<Field> asFields(String... fieldRefs)

append

protected List<Object> append(Object value,
                              AbstractAggregationExpression.Expand expandList)

append

protected List<Object> append(Object value)

append

protected Map<String,Object> append(String key,
                                    Object value)

remove

protected Map<String,Object> remove(String key)

appendAt

protected Map<String,Object> appendAt(int index,
                                      String key,
                                      Object value)

Append the given key at the position in the underlying LinkedHashMap.

Parameters:

index -

key -

value -

Returns:

Since:

3.1

values

protected List<Object> values()

get

protected <T> T get(int index)

Get the value at a given index.

Type Parameters:

T -

Parameters:

index -

Returns:

Since:

2.1

get

protected <T> T get(Object key)

Get the value for a given key.

Type Parameters:

T -

Parameters:

key -

Returns:

Since:

2.1

argumentMap

protected Map<String,Object> argumentMap()

Get the argument map.

Returns:

Since:

2.1

contains

protected boolean contains(Object key)

Check if the given key is available.

Parameters:

key -

Returns:

Since:

2.1