StringFunction (com.sap.cloud.servicesdk.odatav2-connectivity-sdk3 1.37.1 API)

java.lang.Object
- com.sap.cloud.sdk.odatav2.connectivity.filter.StringFunction

public class StringFunction
extends Object

Constructor Summary

Constructors
Constructor and Description

StringFunction()

Constructors
Constructor and Description
`StringFunction()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static StringValue`	`concat(ODataProperty property, String operand)` Creates concat filter function that concatenates a property of an entity with a string operand
`static StringValue`	`concat(StringValue filterFunction, String operand)` Creates concat filter function that concatenates the result of a filter function with a string operand.
`static BoolValue`	`endsWith(ODataProperty property, String operand)` Creates endswith filter function that checks whether the property value ends with a particular string
`static NumValue`	`indexOf(ODataProperty property, String operand)` Creates indexof filter function that returns the position of a specified string within the property value
`static BoolValue`	`isSubstringOf(ODataProperty property, String operand)` Creates issubstringof filter function that checks whether a specified string is present in the property value of an entity
`static NumValue`	`length(ODataProperty property)` Creates length filter function that returns the number of characters in the property value
`static StringValue`	`replace(ODataProperty property, String find, String replace)` Creates replace filter function that replaces a string from the property value of an entity
`static StringValue`	`replace(StringValue filterFunction, String find, String replace)` Creates replace filter function that replaces a string from the result of another filter function
`static BoolValue`	`startsWith(ODataProperty property, String operand)` Creates startswith filter function that checks whether the property value starts with a particular string
`static StringValue`	`substring(ODataProperty property, int pos)` Creates substring filter function that extracts a string starting from a defined position in the property of an entity
`static StringValue`	`substring(ODataProperty property, int pos, int length)` Creates substring filter function that extracts a string of a defined length from the property of an entity, starting from a specified position
`static StringValue`	`substring(StringValue filterFunction, int pos)` Creates substring filter function that extracts a string starting from a defined position in the result of another filter function
`static StringValue`	`substring(StringValue filterFunction, int pos, int length)` Creates substring filter function that extracts a string of a defined length from the result of a filter function, starting from a specified position
`static StringValue`	`toLower(ODataProperty property)` Creates tolower filter function that converts the property value of an entity to lower case
`static StringValue`	`toLower(StringValue property)` Creates tolower filter function that converts the result of a filter function to lower case
`static StringValue`	`toUpper(ODataProperty property)` Creates toupper filter function that capitalizes the property value of an entity
`static StringValue`	`toUpper(StringValue filterFunction)` Creates toupper filter function that capitalizes the result of a filter function
`static StringValue`	`trim(ODataProperty property)` Creates trim filter function that trims the whitespaces from the property value of an entity
`static StringValue`	`trim(StringValue filterFunction)` Creates trim filter function that trims the whitespaces from the result of a filter function

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

- Constructor Detail
  - StringFunction
```
public StringFunction()
```
- Method Detail
  - concat
```
public static StringValue concat(ODataProperty property,
                                 String operand)
```
    Creates concat filter function that concatenates a property of an entity with a string operand
    
    Parameters:
    
    property - An ODataProperty object representing the property of an entity
    
    operand - The string being concatenated to the property value
    
    Returns:
    
    A StringValue object representing the concat function
  - concat
```
public static StringValue concat(StringValue filterFunction,
                                 String operand)
```
    Creates concat filter function that concatenates the result of a filter function with a string operand. For example, concat(concat(City,", "), "Germany").
    
    Parameters:
    
    filterFunction - A StringValue object representing a filter function
    
    operand - The string being concatenated to the filter function
    
    Returns:
    
    A StringValue object representing the concat function
  - trim
```
public static StringValue trim(ODataProperty property)
```
    Creates trim filter function that trims the whitespaces from the property value of an entity
    
    Parameters:
    
    property - An ODataProperty object representing the property of an entity
    
    Returns:
    
    A StringValue object representing the trim function
  - trim
```
public static StringValue trim(StringValue filterFunction)
```
    Creates trim filter function that trims the whitespaces from the result of a filter function
    
    Parameters:
    
    filterFunction - A StringValue object representing a filter function
    
    Returns:
    
    A StringValue object representing the trim function
  - toUpper
```
public static StringValue toUpper(ODataProperty property)
```
    Creates toupper filter function that capitalizes the property value of an entity
    
    Parameters:
    
    property - An ODataProperty object representing the property of an entity
    
    Returns:
    
    A StringValue object representing the toupper function
  - toUpper
```
public static StringValue toUpper(StringValue filterFunction)
```
    Creates toupper filter function that capitalizes the result of a filter function
    
    Parameters:
    
    filterFunction - A StringValue object representing a filter function
    
    Returns:
    
    A StringValue object representing the toupper function
  - toLower
```
public static StringValue toLower(ODataProperty property)
```
    Creates tolower filter function that converts the property value of an entity to lower case
    
    Parameters:
    
    property - An ODataProperty object representing the property of an entity
    
    Returns:
    
    A StringValue object representing the tolower function
  - toLower
```
public static StringValue toLower(StringValue property)
```
    Creates tolower filter function that converts the result of a filter function to lower case
    
    Parameters:
    
    filterFunction - A StringValue object representing a filter function
    
    Returns:
    
    A StringValue object representing the tolower function
  - substring
```
public static StringValue substring(ODataProperty property,
                                    int pos,
                                    int length)
```
    Creates substring filter function that extracts a string of a defined length from the property of an entity, starting from a specified position
    
    Parameters:
    
    property - An ODataProperty object representing the property of an entity
    
    pos - Starting position from which the string has to extracted
    
    length - Number of characters to be included in the string
    
    Returns:
    
    A StringValue object representing the substring function
  - substring
```
public static StringValue substring(StringValue filterFunction,
                                    int pos,
                                    int length)
```
    Creates substring filter function that extracts a string of a defined length from the result of a filter function, starting from a specified position
    
    Parameters:
    
    filterFunction - A StringValue object representing a filter function
    
    pos - Starting position from which the string has to extracted
    
    length - Number of characters to be included in the string
    
    Returns:
    
    A StringValue object representing the substring function
  - substring
```
public static StringValue substring(ODataProperty property,
                                    int pos)
```
    Creates substring filter function that extracts a string starting from a defined position in the property of an entity
    
    Parameters:
    
    property - An ODataProperty object representing the property of an entity
    
    pos - Starting position from which the string has to extracted
    
    Returns:
    
    A StringValue object representing the substring function
  - substring
```
public static StringValue substring(StringValue filterFunction,
                                    int pos)
```
    Creates substring filter function that extracts a string starting from a defined position in the result of another filter function
    
    Parameters:
    
    filterFunction - A StringValue object representing a filter function
    
    pos - Starting position from which the string has to extracted
    
    Returns:
    
    A StringValue object representing the substring function
  - replace
```
public static StringValue replace(ODataProperty property,
                                  String find,
                                  String replace)
```
    Creates replace filter function that replaces a string from the property value of an entity
    
    Parameters:
    
    property - An ODataProperty object representing the property of an entity
    
    find - String to be replaced within the property value
    
    replace - String that replaces the find string
    
    Returns:
    
    A StringValue object representing the replace function
  - replace
```
public static StringValue replace(StringValue filterFunction,
                                  String find,
                                  String replace)
```
    Creates replace filter function that replaces a string from the result of another filter function
    
    Parameters:
    
    filterFunction - A StringValue object representing a filter function
    
    find - String to be replaced within the result of the filter function
    
    replace - String that replaces the find string
    
    Returns:
    
    A StringValue object representing the replace function
  - startsWith
```
public static BoolValue startsWith(ODataProperty property,
                                   String operand)
```
    Creates startswith filter function that checks whether the property value starts with a particular string
    
    Parameters:
    
    property - An ODataProperty object representing the property of an entity
    
    operand - Represents the starting sequence of the property value
    
    Returns:
    
    A StringValue object representing the startswith function
  - endsWith
```
public static BoolValue endsWith(ODataProperty property,
                                 String operand)
```
    Creates endswith filter function that checks whether the property value ends with a particular string
    
    Parameters:
    
    property - An ODataProperty object representing the property of an entity
    
    operand - Represents the ending sequence of the property value
    
    Returns:
    
    A StringValue object representing the endswith function
  - isSubstringOf
```
public static BoolValue isSubstringOf(ODataProperty property,
                                      String operand)
```
    Creates issubstringof filter function that checks whether a specified string is present in the property value of an entity
    
    Parameters:
    
    property - An ODataProperty object representing the property of an entity
    
    operand - Represents the string to be searched in the property value
    
    Returns:
    
    A StringValue object representing the issubstringof function
  - length
```
public static NumValue length(ODataProperty property)
```
    Creates length filter function that returns the number of characters in the property value
    
    Parameters:
    
    property - An ODataProperty object representing the property of an entity
    
    Returns:
    
    A StringValue object representing the length function
  - indexOf
```
public static NumValue indexOf(ODataProperty property,
                               String operand)
```
    Creates indexof filter function that returns the position of a specified string within the property value
    
    Parameters:
    
    property - An ODataProperty object representing the property of an entity
    
    operand - Represents the string to be checked in the property value
    
    Returns:
    
    A StringValue object representing the indexof function

Class StringFunction

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StringFunction

Method Detail

concat

concat

trim

trim

toUpper

toUpper

toLower

toLower

substring

substring

substring

substring

replace

replace

startsWith

endsWith

isSubstringOf

length

indexOf