StringOperators.StringOperatorFactory (Spring Data MongoDB 2.1.0.RELEASE API)

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 and Description
`StringOperatorFactory(AggregationExpression expression)` Creates new `StringOperators.StringOperatorFactory` for given `AggregationExpression`.
`StringOperatorFactory(String fieldReference)` Creates new `StringOperators.StringOperatorFactory` for given fieldReference.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`StringOperators.Concat`	`concat(String value)` Creates new `AggregationExpression` that takes the associated string representation and concats given value 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.Concat`	`concatValueOf(String fieldReference)` Creates new `AggregationExpression` that takes the associated string representation and concats the value of the referenced field to it.
`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.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.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.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.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(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.LTrim`	`ltrim(String chars)` Creates new `AggregationExpression` that takes the associated string representation and trims the given character sequence from the beginning.
`StringOperators.RTrim`	`rtrim()` Creates new `AggregationExpression` that takes the associated string representation and trims whitespaces 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.RTrim`	`rtrim(String chars)` Creates new `AggregationExpression` that takes the associated string representation and trims the given character sequence from the end.
`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.Split`	`split(String delimiter)` Creates new `AggregationExpression` that divides the associated string representation into an array of substrings based on the given delimiter.
`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(AggregationExpression expression)` Creates new `AggregationExpression` that takes the associated string representation and performs case-insensitive comparison to the result of the given `AggregationExpression`.
`StringOperators.StrCaseCmp`	`strCaseCmpValueOf(String fieldReference)` Creates new `AggregationExpression` that takes the associated string representation and performs case-insensitive comparison to the referenced fieldReference.
`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(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.
`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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - 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 Detail
  - 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:
  - 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:
  - 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:
  - 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 -
    
    Returns:
  - 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 -
    
    nrOfChars -
    
    Returns:
  - toLower
```
public StringOperators.ToLower toLower()
```
    Creates new AggregationExpression that takes the associated string representation and lowers it.
    
    Returns:
  - toUpper
```
public StringOperators.ToUpper toUpper()
```
    Creates new AggregationExpression that takes the associated string representation and uppers it.
    
    Returns:
  - 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:
  - 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:
  - 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:
  - 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:
  - 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:
  - 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:
  - 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:
  - 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:
  - 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:
  - 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:
  - 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:
  - 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:
  - length
```
public StringOperators.StrLenBytes length()
```
    Creates new AggregationExpression that returns the number of UTF-8 bytes in the associated string representation.
    
    Returns:
  - lengthCP
```
public StringOperators.StrLenCP lengthCP()
```
    Creates new AggregationExpression that returns the number of UTF-8 code points in the associated string representation.
    
    Returns:
  - 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:
  - 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 -
    
    nrOfCodePoints -
    
    Returns:
  - 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

Class StringOperators.StringOperatorFactory

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StringOperatorFactory

StringOperatorFactory

Method Detail

concatValueOf

concatValueOf

concat

substring

substring

toLower

toUpper

strCaseCmp

strCaseCmpValueOf

strCaseCmpValueOf

indexOf

indexOf

indexOf

indexOfCP

indexOfCP

indexOfCP

split

split

split

length

lengthCP

substringCP

substringCP

trim

trim

trim

ltrim

ltrim

ltrim

rtrim

rtrim

rtrim