Package org.springframework.data.mongodb.core.aggregation

Class StringOperators.StringOperatorFactory

java.lang.Object

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

Enclosing class:

StringOperators

public static class StringOperators.StringOperatorFactory
extends Object

Author:

Christoph Strobl

Constructor Summary

Constructors

Constructor	Description
StringOperatorFactory(String fieldReference)	Creates new StringOperators.StringOperatorFactory for given fieldReference.
StringOperatorFactory(AggregationExpression expression)	Creates new StringOperators.StringOperatorFactory for given AggregationExpression.

Method Summary

Modifier and Type	Method	Description
StringOperators.Concat	concat(String value)	Creates new AggregationExpression that takes the associated string representation and concats given value to it.
StringOperators.Concat	concatValueOf(String fieldReference)	Creates new AggregationExpression that takes the associated string representation and concats the value of the referenced field to it.
StringOperators.Concat	concatValueOf(AggregationExpression expression)	Creates new AggregationExpression that takes the associated string representation and concats the result of the given AggregationExpression to it.
StringOperators.IndexOfBytes	indexOf(String substring)	Creates new AggregationExpression that takes the associated string representation and searches a string for an occurrence of a given substring and returns the UTF-8 byte index (zero-based) of the first occurrence.
StringOperators.IndexOfBytes	indexOf(AggregationExpression expression)	Creates new AggregationExpression that takes the associated string representation and searches a string for an occurrence of a substring resulting from the given AggregationExpression and returns the UTF-8 byte index (zero-based) of the first occurrence.
StringOperators.IndexOfBytes	indexOf(Field fieldReference)	Creates new AggregationExpression that takes the associated string representation and searches a string for an occurrence of a substring contained in the given field reference and returns the UTF-8 byte index (zero-based) of the first occurrence.
StringOperators.IndexOfCP	indexOfCP(String substring)	Creates new AggregationExpression that takes the associated string representation and searches a string for an occurrence of a given substring and returns the UTF-8 code point index (zero-based) of the first occurrence.
StringOperators.IndexOfCP	indexOfCP(AggregationExpression expression)	Creates new AggregationExpression that takes the associated string representation and searches a string for an occurrence of a substring resulting from the given AggregationExpression and returns the UTF-8 code point index (zero-based) of the first occurrence.
StringOperators.IndexOfCP	indexOfCP(Field fieldReference)	Creates new AggregationExpression that takes the associated string representation and searches a string for an occurrence of a substring contained in the given field reference and returns the UTF-8 code point index (zero-based) of the first occurrence.
StringOperators.StrLenBytes	length()	Creates new AggregationExpression that returns the number of UTF-8 bytes in the associated string representation.
StringOperators.StrLenCP	lengthCP()	Creates new AggregationExpression that returns the number of UTF-8 code points in the associated string representation.
StringOperators.LTrim	ltrim()	Creates new AggregationExpression that takes the associated string representation and trims whitespaces from the beginning.
StringOperators.LTrim	ltrim(String chars)	Creates new AggregationExpression that takes the associated string representation and trims the given character sequence from the beginning.
StringOperators.LTrim	ltrim(AggregationExpression expression)	Creates new AggregationExpression that takes the associated string representation and trims the character sequence resulting from the given AggregationExpression from the beginning.
StringOperators.RegexFind	regexFind(String regex)	Creates new AggregationExpression that takes the associated string representation and applies the given regular expression to find the document with the first match. NOTE: Requires MongoDB 4.0 or later.
StringOperators.RegexFind	regexFind(String regex, String options)	Creates new AggregationExpression that takes the associated string representation and applies the regular expression with the options specified in the argument to find the document with the first match.
StringOperators.RegexFind	regexFind(Pattern pattern)	Creates new AggregationExpression that takes the Pattern and applies the regular expression with the options specified in the argument to find the document with the first match.
StringOperators.RegexFind	regexFind(AggregationExpression expression)	Creates new AggregationExpression that takes the associated string representation and applies the regular expression resulting from the given AggregationExpression to find the document with the first match. NOTE: Requires MongoDB 4.0 or later.
StringOperators.RegexFindAll	regexFindAll(String regex)	Creates new AggregationExpression that takes the associated string representation and applies the given regular expression to find all the documents with the match. NOTE: Requires MongoDB 4.0 or later.
StringOperators.RegexFindAll	regexFindAll(String regex, String options)	Creates new AggregationExpression that takes the associated string representation and applies the regular expression with the options specified in the argument to find all the documents with the match.
StringOperators.RegexFindAll	regexFindAll(Pattern pattern)	Creates new AggregationExpression that takes a Pattern and applies the regular expression with the options specified in the argument to find all the documents with the match.
StringOperators.RegexFindAll	regexFindAll(AggregationExpression expression)	Creates new AggregationExpression that takes the associated string representation and applies the regular expression resulting from the given AggregationExpression to find all the documents with the match.. NOTE: Requires MongoDB 4.0 or later.
StringOperators.RegexMatch	regexMatch(String regex)	Creates new AggregationExpression that takes the associated string representation and applies the given regular expression to find if a match is found or not. NOTE: Requires MongoDB 4.0 or later.
StringOperators.RegexMatch	regexMatch(String regex, String options)	Creates new AggregationExpression that takes the associated string representation and applies the regular expression with the options specified in the argument to find if a match is found or not.
StringOperators.RegexMatch	regexMatch(Pattern pattern)	Creates new AggregationExpression that takes a Pattern and applies the regular expression with the options specified in the argument to find if a match is found or not.
StringOperators.RegexMatch	regexMatch(AggregationExpression expression)	Creates new AggregationExpression that takes the associated string representation and applies the regular expression resulting from the given AggregationExpression to find if a match is found or not. NOTE: Requires MongoDB 4.0 or later.
StringOperators.ReplaceAll	replaceAll(String search, String replacement)	Creates new AggregationExpression that takes the associated string representation and replaces all occurrences of the search string with the given replacement.
StringOperators.ReplaceAll	replaceAll(AggregationExpression search, String replacement)	Creates new AggregationExpression that takes the associated string representation and replaces all occurrences of the search string computed by the given AggregationExpression with the given replacement.
StringOperators.ReplaceOne	replaceOne(String search, String replacement)	Creates new AggregationExpression that takes the associated string representation and replaces the first occurrence of the search string with the given replacement.
StringOperators.ReplaceOne	replaceOne(AggregationExpression search, String replacement)	Creates new AggregationExpression that takes the associated string representation and replaces the first occurrence of the search string computed by the given AggregationExpression with the given replacement.
StringOperators.RTrim	rtrim()	Creates new AggregationExpression that takes the associated string representation and trims whitespaces from the end.
StringOperators.RTrim	rtrim(String chars)	Creates new AggregationExpression that takes the associated string representation and trims the given character sequence from the end.
StringOperators.RTrim	rtrim(AggregationExpression expression)	Creates new AggregationExpression that takes the associated string representation and trims the character sequence resulting from the given AggregationExpression from the end.
StringOperators.Split	split(String delimiter)	Creates new AggregationExpression that divides the associated string representation into an array of substrings based on the given delimiter.
StringOperators.Split	split(AggregationExpression expression)	Creates new AggregationExpression that divides the associated string representation into an array of substrings based on a delimiter resulting from the given AggregationExpression.
StringOperators.Split	split(Field fieldReference)	Creates new AggregationExpression that divides the associated string representation into an array of substrings based on the delimiter resulting from the referenced field..
StringOperators.StrCaseCmp	strCaseCmp(String value)	Creates new AggregationExpression that takes the associated string representation and performs case-insensitive comparison to the given value.
StringOperators.StrCaseCmp	strCaseCmpValueOf(String fieldReference)	Creates new AggregationExpression that takes the associated string representation and performs case-insensitive comparison to the referenced fieldReference.
StringOperators.StrCaseCmp	strCaseCmpValueOf(AggregationExpression expression)	Creates new AggregationExpression that takes the associated string representation and performs case-insensitive comparison to the result of the given AggregationExpression.
StringOperators.Substr	substring(int start)	Creates new AggregationExpression that takes the associated string representation and returns a substring starting at a specified index position.
StringOperators.Substr	substring(int start, int nrOfChars)	Creates new AggregationExpression that takes the associated string representation and returns a substring starting at a specified index position including the specified number of characters.
StringOperators.SubstrCP	substringCP(int codePointStart)	Creates new AggregationExpression that takes the associated string representation and returns a substring starting at a specified code point index position.
StringOperators.SubstrCP	substringCP(int codePointStart, int nrOfCodePoints)	Creates new AggregationExpression that takes the associated string representation and returns a substring starting at a specified code point index position including the specified number of code points.
StringOperators.ToLower	toLower()	Creates new AggregationExpression that takes the associated string representation and lowers it.
StringOperators.ToUpper	toUpper()	Creates new AggregationExpression that takes the associated string representation and uppers it.
StringOperators.Trim	trim()	Creates new AggregationExpression that takes the associated string representation and trims whitespaces from the beginning and end.
StringOperators.Trim	trim(String chars)	Creates new AggregationExpression that takes the associated string representation and trims the given character sequence from the beginning and end.
StringOperators.Trim	trim(AggregationExpression expression)	Creates new AggregationExpression that takes the associated string representation and trims the character sequence resulting from the given AggregationExpression from the beginning and end.

Methods inherited from class java.lang.Object

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

Constructor Details

StringOperatorFactory

public StringOperatorFactory(String fieldReference)

Creates new StringOperators.StringOperatorFactory for given fieldReference.

Parameters:

fieldReference - must not be null.

StringOperatorFactory

public StringOperatorFactory(AggregationExpression expression)

Creates new StringOperators.StringOperatorFactory for given AggregationExpression.

Parameters:

expression - must not be null.

Method Details

concatValueOf

public StringOperators.Concat concatValueOf(String fieldReference)

Creates new AggregationExpression that takes the associated string representation and concats the value of the referenced field to it.

Parameters:

fieldReference - must not be null.

Returns:

new instance of StringOperators.Concat.

concatValueOf

public StringOperators.Concat concatValueOf(AggregationExpression expression)

Creates new AggregationExpression that takes the associated string representation and concats the result of the given AggregationExpression to it.

Parameters:

expression - must not be null.

Returns:

new instance of StringOperators.Concat.

concat

public StringOperators.Concat concat(String value)

Creates new AggregationExpression that takes the associated string representation and concats given value to it.

Parameters:

value - must not be null.

Returns:

new instance of StringOperators.Concat.

substring

public StringOperators.Substr substring(int start)

Creates new AggregationExpression that takes the associated string representation and returns a substring starting at a specified index position.

Parameters:

start - start index number (including)

Returns:

new instance of StringOperators.Substr.

substring

public StringOperators.Substr substring(int start,
 int nrOfChars)

Creates new AggregationExpression that takes the associated string representation and returns a substring starting at a specified index position including the specified number of characters.

Parameters:

start - start index number (including)

nrOfChars - number of characters.

Returns:

new instance of StringOperators.Substr.

toLower

public StringOperators.ToLower toLower()

Creates new AggregationExpression that takes the associated string representation and lowers it.

Returns:

new instance of StringOperators.ToLower.

toUpper

public StringOperators.ToUpper toUpper()

Creates new AggregationExpression that takes the associated string representation and uppers it.

Returns:

new instance of StringOperators.ToUpper.

strCaseCmp

public StringOperators.StrCaseCmp strCaseCmp(String value)

Creates new AggregationExpression that takes the associated string representation and performs case-insensitive comparison to the given value.

Parameters:

value - must not be null.

Returns:

new instance of StringOperators.StrCaseCmp.

strCaseCmpValueOf

public StringOperators.StrCaseCmp strCaseCmpValueOf(String fieldReference)

Creates new AggregationExpression that takes the associated string representation and performs case-insensitive comparison to the referenced fieldReference.

Parameters:

fieldReference - must not be null.

Returns:

new instance of StringOperators.StrCaseCmp.

strCaseCmpValueOf

public StringOperators.StrCaseCmp strCaseCmpValueOf(AggregationExpression expression)

Creates new AggregationExpression that takes the associated string representation and performs case-insensitive comparison to the result of the given AggregationExpression.

Parameters:

expression - must not be null.

Returns:

new instance of StringOperators.StrCaseCmp.

indexOf

public StringOperators.IndexOfBytes indexOf(String substring)

Creates new AggregationExpression that takes the associated string representation and searches a string for an occurrence of a given substring and returns the UTF-8 byte index (zero-based) of the first occurrence.

Parameters:

substring - must not be null.

Returns:

new instance of StringOperators.IndexOfBytes.

indexOf

public StringOperators.IndexOfBytes indexOf(Field fieldReference)

Creates new AggregationExpression that takes the associated string representation and searches a string for an occurrence of a substring contained in the given field reference and returns the UTF-8 byte index (zero-based) of the first occurrence.

Parameters:

fieldReference - must not be null.

Returns:

new instance of StringOperators.IndexOfBytes.

indexOf

public StringOperators.IndexOfBytes indexOf(AggregationExpression expression)

Creates new AggregationExpression that takes the associated string representation and searches a string for an occurrence of a substring resulting from the given AggregationExpression and returns the UTF-8 byte index (zero-based) of the first occurrence.

Parameters:

expression - must not be null.

Returns:

new instance of StringOperators.IndexOfBytes.

indexOfCP

public StringOperators.IndexOfCP indexOfCP(String substring)

Creates new AggregationExpression that takes the associated string representation and searches a string for an occurrence of a given substring and returns the UTF-8 code point index (zero-based) of the first occurrence.

Parameters:

substring - must not be null.

Returns:

new instance of StringOperators.IndexOfCP.

indexOfCP

public StringOperators.IndexOfCP indexOfCP(Field fieldReference)

Creates new AggregationExpression that takes the associated string representation and searches a string for an occurrence of a substring contained in the given field reference and returns the UTF-8 code point index (zero-based) of the first occurrence.

Parameters:

fieldReference - must not be null.

Returns:

new instance of StringOperators.IndexOfCP.

indexOfCP

public StringOperators.IndexOfCP indexOfCP(AggregationExpression expression)

Creates new AggregationExpression that takes the associated string representation and searches a string for an occurrence of a substring resulting from the given AggregationExpression and returns the UTF-8 code point index (zero-based) of the first occurrence.

Parameters:

expression - must not be null.

Returns:

new instance of StringOperators.IndexOfCP.

split

public StringOperators.Split split(String delimiter)

Creates new AggregationExpression that divides the associated string representation into an array of substrings based on the given delimiter.

Parameters:

delimiter - must not be null.

Returns:

new instance of StringOperators.Split.

split

public StringOperators.Split split(Field fieldReference)

Creates new AggregationExpression that divides the associated string representation into an array of substrings based on the delimiter resulting from the referenced field..

Parameters:

fieldReference - must not be null.

Returns:

new instance of StringOperators.Split.

split

public StringOperators.Split split(AggregationExpression expression)

Creates new AggregationExpression that divides the associated string representation into an array of substrings based on a delimiter resulting from the given AggregationExpression.

Parameters:

expression - must not be null.

Returns:

new instance of StringOperators.Split.

length

public StringOperators.StrLenBytes length()

Creates new AggregationExpression that returns the number of UTF-8 bytes in the associated string representation.

Returns:

new instance of StringOperators.StrLenBytes.

lengthCP

public StringOperators.StrLenCP lengthCP()

Creates new AggregationExpression that returns the number of UTF-8 code points in the associated string representation.

Returns:

new instance of StringOperators.StrLenCP.

substringCP

public StringOperators.SubstrCP substringCP(int codePointStart)

Creates new AggregationExpression that takes the associated string representation and returns a substring starting at a specified code point index position.

Parameters:

codePointStart -

Returns:

new instance of StringOperators.SubstrCP.

substringCP

public StringOperators.SubstrCP substringCP(int codePointStart,
 int nrOfCodePoints)

Creates new AggregationExpression that takes the associated string representation and returns a substring starting at a specified code point index position including the specified number of code points.

Parameters:

codePointStart - start point (including).

nrOfCodePoints -

Returns:

new instance of StringOperators.SubstrCP.

trim

public StringOperators.Trim trim()

Creates new AggregationExpression that takes the associated string representation and trims whitespaces from the beginning and end.
NOTE: Requires MongoDB 4.0 or later.

Returns:

new instance of StringOperators.Trim.

Since:

2.1

trim

public StringOperators.Trim trim(String chars)

Creates new AggregationExpression that takes the associated string representation and trims the given character sequence from the beginning and end.
NOTE: Requires MongoDB 4.0 or later.

Parameters:

chars - must not be null.

Returns:

new instance of StringOperators.Trim.

Since:

2.1

trim

public StringOperators.Trim trim(AggregationExpression expression)

Creates new AggregationExpression that takes the associated string representation and trims the character sequence resulting from the given AggregationExpression from the beginning and end.
NOTE: Requires MongoDB 4.0 or later.

Parameters:

expression - must not be null.

Returns:

new instance of StringOperators.Trim.

Since:

2.1

ltrim

public StringOperators.LTrim ltrim()

Creates new AggregationExpression that takes the associated string representation and trims whitespaces from the beginning.
NOTE: Requires MongoDB 4.0 or later.

Returns:

new instance of StringOperators.LTrim.

Since:

2.1

ltrim

public StringOperators.LTrim ltrim(String chars)

Creates new AggregationExpression that takes the associated string representation and trims the given character sequence from the beginning.
NOTE: Requires MongoDB 4.0 or later.

Parameters:

chars - must not be null.

Returns:

new instance of StringOperators.LTrim.

Since:

2.1

ltrim

public StringOperators.LTrim ltrim(AggregationExpression expression)

Creates new AggregationExpression that takes the associated string representation and trims the character sequence resulting from the given AggregationExpression from the beginning.
NOTE: Requires MongoDB 4.0 or later.

Parameters:

expression - must not be null.

Returns:

new instance of StringOperators.LTrim.

Since:

2.1

rtrim

public StringOperators.RTrim rtrim()

Creates new AggregationExpression that takes the associated string representation and trims whitespaces from the end.
NOTE: Requires MongoDB 4.0 or later.

Returns:

new instance of StringOperators.RTrim.

Since:

2.1

rtrim

public StringOperators.RTrim rtrim(String chars)

Creates new AggregationExpression that takes the associated string representation and trims the given character sequence from the end.
NOTE: Requires MongoDB 4.0 or later.

Parameters:

chars - must not be null.

Returns:

new instance of StringOperators.RTrim.

Since:

2.1

rtrim

public StringOperators.RTrim rtrim(AggregationExpression expression)

Creates new AggregationExpression that takes the associated string representation and trims the character sequence resulting from the given AggregationExpression from the end.
NOTE: Requires MongoDB 4.0 or later.

Parameters:

expression - must not be null.

Returns:

new instance of StringOperators.RTrim.

Since:

2.1

regexFind

public StringOperators.RegexFind regexFind(String regex)

Creates new AggregationExpression that takes the associated string representation and applies the given regular expression to find the document with the first match.
NOTE: Requires MongoDB 4.0 or later.

Parameters:

regex - must not be null.

Returns:

new instance of StringOperators.RegexFind.

Since:

3.3

regexFind

public StringOperators.RegexFind regexFind(AggregationExpression expression)

Creates new AggregationExpression that takes the associated string representation and applies the regular expression resulting from the given AggregationExpression to find the document with the first match.
NOTE: Requires MongoDB 4.0 or later.

Parameters:

expression - must not be null.

Returns:

new instance of StringOperators.RegexFind.

Since:

3.3

regexFind

public StringOperators.RegexFind regexFind(Pattern pattern)

Creates new AggregationExpression that takes the Pattern and applies the regular expression with the options specified in the argument to find the document with the first match.

Parameters:

pattern - the pattern object to apply.

Returns:

new instance of StringOperators.RegexFind.

Since:

3.3

regexFind

public StringOperators.RegexFind regexFind(String regex,
 String options)

Creates new AggregationExpression that takes the associated string representation and applies the regular expression with the options specified in the argument to find the document with the first match.

Parameters:

regex - the regular expression to apply.

options - the options to use.

Returns:

new instance of StringOperators.RegexFind.

Since:

3.3

regexFindAll

public StringOperators.RegexFindAll regexFindAll(String regex)

Creates new AggregationExpression that takes the associated string representation and applies the given regular expression to find all the documents with the match.
NOTE: Requires MongoDB 4.0 or later.

Parameters:

regex - must not be null.

Returns:

new instance of StringOperators.RegexFindAll.

Since:

3.3

regexFindAll

public StringOperators.RegexFindAll regexFindAll(AggregationExpression expression)

Creates new AggregationExpression that takes the associated string representation and applies the regular expression resulting from the given AggregationExpression to find all the documents with the match..
NOTE: Requires MongoDB 4.0 or later.

Parameters:

expression - must not be null.

Returns:

new instance of StringOperators.RegexFindAll.

Since:

3.3

regexFindAll

public StringOperators.RegexFindAll regexFindAll(Pattern pattern)

Creates new AggregationExpression that takes a Pattern and applies the regular expression with the options specified in the argument to find all the documents with the match.

Parameters:

pattern - the pattern object to apply.

Returns:

new instance of StringOperators.RegexFindAll.

Since:

3.3

regexFindAll

public StringOperators.RegexFindAll regexFindAll(String regex,
 String options)

Creates new AggregationExpression that takes the associated string representation and applies the regular expression with the options specified in the argument to find all the documents with the match.

Parameters:

regex - the regular expression to apply.

options - the options to use.

Returns:

new instance of StringOperators.RegexFindAll.

Since:

3.3

regexMatch

public StringOperators.RegexMatch regexMatch(String regex)

Creates new AggregationExpression that takes the associated string representation and applies the given regular expression to find if a match is found or not.
NOTE: Requires MongoDB 4.0 or later.

Parameters:

regex - must not be null.

Returns:

new instance of StringOperators.RegexMatch.

Since:

3.3

regexMatch

public StringOperators.RegexMatch regexMatch(AggregationExpression expression)

Creates new AggregationExpression that takes the associated string representation and applies the regular expression resulting from the given AggregationExpression to find if a match is found or not.
NOTE: Requires MongoDB 4.0 or later.

Parameters:

expression - must not be null.

Returns:

new instance of StringOperators.RegexMatch.

Since:

3.3

regexMatch

public StringOperators.RegexMatch regexMatch(Pattern pattern)

Creates new AggregationExpression that takes a Pattern and applies the regular expression with the options specified in the argument to find if a match is found or not.

Parameters:

pattern - the pattern object to apply.

Returns:

new instance of StringOperators.RegexMatch.

Since:

3.3

regexMatch

public StringOperators.RegexMatch regexMatch(String regex,
 String options)

Creates new AggregationExpression that takes the associated string representation and applies the regular expression with the options specified in the argument to find if a match is found or not.

Parameters:

regex - the regular expression to apply.

options - the options to use.

Returns:

new instance of StringOperators.RegexMatch.

Since:

3.3

replaceOne

public StringOperators.ReplaceOne replaceOne(String search,
 String replacement)

Creates new AggregationExpression that takes the associated string representation and replaces the first occurrence of the search string with the given replacement.

Parameters:

search -

replacement -

Returns:

new instance of StringOperators.ReplaceOne.

Since:

3.4

replaceOne

public StringOperators.ReplaceOne replaceOne(AggregationExpression search,
 String replacement)

Creates new AggregationExpression that takes the associated string representation and replaces the first occurrence of the search string computed by the given AggregationExpression with the given replacement.

Parameters:

search -

replacement -

Returns:

new instance of StringOperators.ReplaceOne.

Since:

3.4

replaceAll

public StringOperators.ReplaceAll replaceAll(String search,
 String replacement)

Creates new AggregationExpression that takes the associated string representation and replaces all occurrences of the search string with the given replacement.

Parameters:

search -

replacement -

Returns:

new instance of StringOperators.ReplaceOne.

Since:

3.4

replaceAll

public StringOperators.ReplaceAll replaceAll(AggregationExpression search,
 String replacement)

Creates new AggregationExpression that takes the associated string representation and replaces all occurrences of the search string computed by the given AggregationExpression with the given replacement.

Parameters:

search -

replacement -

Returns:

new instance of StringOperators.ReplaceOne.

Since:

3.4