Class StringOperators.StringOperatorFactory
java.lang.Object
org.springframework.data.mongodb.core.aggregation.StringOperators.StringOperatorFactory
- Enclosing class:
- StringOperators
- Author:
- Christoph Strobl
-
Constructor Summary
ConstructorDescriptionStringOperatorFactory
(String fieldReference) Creates newStringOperators.StringOperatorFactory
for given fieldReference.StringOperatorFactory
(AggregationExpression expression) Creates newStringOperators.StringOperatorFactory
for givenAggregationExpression
. -
Method Summary
Modifier and TypeMethodDescriptionCreates newAggregationExpression
that takes the associated string representation and concats given value to it.concatValueOf
(String fieldReference) Creates newAggregationExpression
that takes the associated string representation and concats the value of the referenced field to it.concatValueOf
(AggregationExpression expression) Creates newAggregationExpression
that takes the associated string representation and concats the result of the givenAggregationExpression
to it.Creates newAggregationExpression
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.indexOf
(AggregationExpression expression) Creates newAggregationExpression
that takes the associated string representation and searches a string for an occurrence of a substring resulting from the givenAggregationExpression
and returns the UTF-8 byte index (zero-based) of the first occurrence.Creates newAggregationExpression
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.Creates newAggregationExpression
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.indexOfCP
(AggregationExpression expression) Creates newAggregationExpression
that takes the associated string representation and searches a string for an occurrence of a substring resulting from the givenAggregationExpression
and returns the UTF-8 code point index (zero-based) of the first occurrence.Creates newAggregationExpression
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.length()
Creates newAggregationExpression
that returns the number of UTF-8 bytes in the associated string representation.lengthCP()
Creates newAggregationExpression
that returns the number of UTF-8 code points in the associated string representation.ltrim()
Creates newAggregationExpression
that takes the associated string representation and trims whitespaces from the beginning.Creates newAggregationExpression
that takes the associated string representation and trims the given character sequence from the beginning.ltrim
(AggregationExpression expression) Creates newAggregationExpression
that takes the associated string representation and trims the character sequence resulting from the givenAggregationExpression
from the beginning.Creates newAggregationExpression
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.Creates newAggregationExpression
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.Creates newAggregationExpression
that takes thePattern
and applies the regular expression with the options specified in the argument to find the document with the first match.regexFind
(AggregationExpression expression) Creates newAggregationExpression
that takes the associated string representation and applies the regular expression resulting from the givenAggregationExpression
to find the document with the first match.
NOTE: Requires MongoDB 4.0 or later.regexFindAll
(String regex) Creates newAggregationExpression
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.regexFindAll
(String regex, String options) Creates newAggregationExpression
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.regexFindAll
(Pattern pattern) Creates newAggregationExpression
that takes aPattern
and applies the regular expression with the options specified in the argument to find all the documents with the match.regexFindAll
(AggregationExpression expression) Creates newAggregationExpression
that takes the associated string representation and applies the regular expression resulting from the givenAggregationExpression
to find all the documents with the match..
NOTE: Requires MongoDB 4.0 or later.regexMatch
(String regex) Creates newAggregationExpression
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.regexMatch
(String regex, String options) Creates newAggregationExpression
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.regexMatch
(Pattern pattern) Creates newAggregationExpression
that takes aPattern
and applies the regular expression with the options specified in the argument to find if a match is found or not.regexMatch
(AggregationExpression expression) Creates newAggregationExpression
that takes the associated string representation and applies the regular expression resulting from the givenAggregationExpression
to find if a match is found or not.
NOTE: Requires MongoDB 4.0 or later.replaceAll
(String search, String replacement) Creates newAggregationExpression
that takes the associated string representation and replaces all occurrences of the search string with the given replacement.replaceAll
(AggregationExpression search, String replacement) Creates newAggregationExpression
that takes the associated string representation and replaces all occurrences of the search string computed by the givenAggregationExpression
with the given replacement.replaceOne
(String search, String replacement) Creates newAggregationExpression
that takes the associated string representation and replaces the first occurrence of the search string with the given replacement.replaceOne
(AggregationExpression search, String replacement) Creates newAggregationExpression
that takes the associated string representation and replaces the first occurrence of the search string computed by the givenAggregationExpression
with the given replacement.rtrim()
Creates newAggregationExpression
that takes the associated string representation and trims whitespaces from the end.Creates newAggregationExpression
that takes the associated string representation and trims the given character sequence from the end.rtrim
(AggregationExpression expression) Creates newAggregationExpression
that takes the associated string representation and trims the character sequence resulting from the givenAggregationExpression
from the end.Creates newAggregationExpression
that divides the associated string representation into an array of substrings based on the given delimiter.split
(AggregationExpression expression) Creates newAggregationExpression
that divides the associated string representation into an array of substrings based on a delimiter resulting from the givenAggregationExpression
.Creates newAggregationExpression
that divides the associated string representation into an array of substrings based on the delimiter resulting from the referenced field..strCaseCmp
(String value) Creates newAggregationExpression
that takes the associated string representation and performs case-insensitive comparison to the given value.strCaseCmpValueOf
(String fieldReference) Creates newAggregationExpression
that takes the associated string representation and performs case-insensitive comparison to the referenced fieldReference.strCaseCmpValueOf
(AggregationExpression expression) Creates newAggregationExpression
that takes the associated string representation and performs case-insensitive comparison to the result of the givenAggregationExpression
.substring
(int start) Creates newAggregationExpression
that takes the associated string representation and returns a substring starting at a specified index position.substring
(int start, int nrOfChars) Creates newAggregationExpression
that takes the associated string representation and returns a substring starting at a specified index position including the specified number of characters.substringCP
(int codePointStart) Creates newAggregationExpression
that takes the associated string representation and returns a substring starting at a specified code point index position.substringCP
(int codePointStart, int nrOfCodePoints) Creates newAggregationExpression
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.toLower()
Creates newAggregationExpression
that takes the associated string representation and lowers it.toUpper()
Creates newAggregationExpression
that takes the associated string representation and uppers it.trim()
Creates newAggregationExpression
that takes the associated string representation and trims whitespaces from the beginning and end.Creates newAggregationExpression
that takes the associated string representation and trims the given character sequence from the beginning and end.trim
(AggregationExpression expression) Creates newAggregationExpression
that takes the associated string representation and trims the character sequence resulting from the givenAggregationExpression
from the beginning and end.
-
Constructor Details
-
StringOperatorFactory
Creates newStringOperators.StringOperatorFactory
for given fieldReference.- Parameters:
fieldReference
- must not be null.
-
StringOperatorFactory
Creates newStringOperators.StringOperatorFactory
for givenAggregationExpression
.- Parameters:
expression
- must not be null.
-
-
Method Details
-
concatValueOf
Creates newAggregationExpression
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
Creates newAggregationExpression
that takes the associated string representation and concats the result of the givenAggregationExpression
to it.- Parameters:
expression
- must not be null.- Returns:
- new instance of
StringOperators.Concat
.
-
concat
Creates newAggregationExpression
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
Creates newAggregationExpression
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
Creates newAggregationExpression
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
Creates newAggregationExpression
that takes the associated string representation and lowers it.- Returns:
- new instance of
StringOperators.ToLower
.
-
toUpper
Creates newAggregationExpression
that takes the associated string representation and uppers it.- Returns:
- new instance of
StringOperators.ToUpper
.
-
strCaseCmp
Creates newAggregationExpression
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
Creates newAggregationExpression
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
Creates newAggregationExpression
that takes the associated string representation and performs case-insensitive comparison to the result of the givenAggregationExpression
.- Parameters:
expression
- must not be null.- Returns:
- new instance of
StringOperators.StrCaseCmp
.
-
indexOf
Creates newAggregationExpression
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
Creates newAggregationExpression
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
Creates newAggregationExpression
that takes the associated string representation and searches a string for an occurrence of a substring resulting from the givenAggregationExpression
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
Creates newAggregationExpression
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
Creates newAggregationExpression
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
Creates newAggregationExpression
that takes the associated string representation and searches a string for an occurrence of a substring resulting from the givenAggregationExpression
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
Creates newAggregationExpression
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
Creates newAggregationExpression
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
Creates newAggregationExpression
that divides the associated string representation into an array of substrings based on a delimiter resulting from the givenAggregationExpression
.- Parameters:
expression
- must not be null.- Returns:
- new instance of
StringOperators.Split
.
-
length
Creates newAggregationExpression
that returns the number of UTF-8 bytes in the associated string representation.- Returns:
- new instance of
StringOperators.StrLenBytes
.
-
lengthCP
Creates newAggregationExpression
that returns the number of UTF-8 code points in the associated string representation.- Returns:
- new instance of
StringOperators.StrLenCP
.
-
substringCP
Creates newAggregationExpression
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
Creates newAggregationExpression
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
Creates newAggregationExpression
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
Creates newAggregationExpression
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
Creates newAggregationExpression
that takes the associated string representation and trims the character sequence resulting from the givenAggregationExpression
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
Creates newAggregationExpression
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
Creates newAggregationExpression
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
Creates newAggregationExpression
that takes the associated string representation and trims the character sequence resulting from the givenAggregationExpression
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
Creates newAggregationExpression
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
Creates newAggregationExpression
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
Creates newAggregationExpression
that takes the associated string representation and trims the character sequence resulting from the givenAggregationExpression
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
Creates newAggregationExpression
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
Creates newAggregationExpression
that takes the associated string representation and applies the regular expression resulting from the givenAggregationExpression
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
Creates newAggregationExpression
that takes thePattern
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
Creates newAggregationExpression
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
Creates newAggregationExpression
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
Creates newAggregationExpression
that takes the associated string representation and applies the regular expression resulting from the givenAggregationExpression
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
Creates newAggregationExpression
that takes aPattern
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
Creates newAggregationExpression
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
Creates newAggregationExpression
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
Creates newAggregationExpression
that takes the associated string representation and applies the regular expression resulting from the givenAggregationExpression
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
Creates newAggregationExpression
that takes aPattern
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
Creates newAggregationExpression
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
Creates newAggregationExpression
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
Creates newAggregationExpression
that takes the associated string representation and replaces the first occurrence of the search string computed by the givenAggregationExpression
with the given replacement.- Parameters:
search
-replacement
-- Returns:
- new instance of
StringOperators.ReplaceOne
. - Since:
- 3.4
-
replaceAll
Creates newAggregationExpression
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
Creates newAggregationExpression
that takes the associated string representation and replaces all occurrences of the search string computed by the givenAggregationExpression
with the given replacement.- Parameters:
search
-replacement
-- Returns:
- new instance of
StringOperators.ReplaceOne
. - Since:
- 3.4
-