StringFunctions (Transform API)

com.oracle.endeca.transform.functions.StringFunctions

List of String interface functions

Inherited fields
Fields inherited from class	Fields
`class DateFunctions`	`DATEFORMAT_DEFAULT`

Methods Summary

Methods
Type	Name and description
`java.lang.String`	`concat(java.lang.String... attributes)` Concatenate the arguments into a new string
`java.lang.String`	`concatWithToken(java.lang.String joinToken, java.lang.String... attributes)` Concatenate the arguments into a new string using a join token
`java.lang.Boolean`	`contains(java.lang.String attribute, java.lang.String searchString)` Find whether the substring is part of the original string
`java.lang.String`	`find(java.lang.String attribute, java.lang.String pattern)` Find the first occurrence of a regular expression string within a string.
`java.util.List<java.lang.String>`	`findAll(java.lang.String attribute, java.lang.String pattern)` Returns a (possibly empty) list of all occurrences of a regular expression (in String format) found within a String.
`java.lang.Integer`	`indexOf(java.lang.String attribute, java.lang.String searchString)` Find the index of substring in the original string
`java.lang.Boolean`	`isDouble(java.lang.String attribute)` Test whether the string is a double
`java.lang.Boolean`	`isLong(java.lang.String attribute)` Test whether the string is a long
`java.lang.Integer`	`length(java.lang.String attribute)` Test the length of the string
`java.lang.String`	`replace(java.lang.String attribute, java.lang.String searchString, java.lang.String replaceString, java.lang.Boolean useRegex = false)` Replace a part of whole string with a new expression
`java.lang.String[]`	`splitToSet(java.lang.String attribute, java.lang.String delimiter)` Split the string based on the delimiter
`java.lang.String`	`stripIndent(java.lang.String attribute)` Strip indentation and extra spaces of the string
`java.lang.String`	`substring(java.lang.String attribute, java.lang.Integer startLocation, java.lang.Integer endLocation = null)` Get the substring from the original string based on the start and end location in the string
`java.lang.String`	`toLowerCase(java.lang.String attribute, java.lang.String localeInfo = "en")` Convert the original string to lower case
`java.lang.String`	`toTitleCase(java.lang.String attribute)` Capitalize the string
`java.lang.String`	`toUpperCase(java.lang.String attribute, java.lang.String localeInfo = "en")` Convert the original string to upper case
`java.lang.String`	`trim(java.lang.String attribute)` Trim the string of extra spaces
`java.lang.String`	`urlDecode(java.lang.String attribute, java.lang.String characterEncoding = "UTF-8")` Decodes a string into application/x-www-form-urlencoded format using a specific encoding scheme.
`java.lang.String`	`urlEncode(java.lang.String attribute, java.lang.String characterEncoding = "UTF-8")` Translates a string into application/x-www-form-urlencoded format using a specific encoding scheme.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class GeocodeFunctions`	`distance, getLatitude, getLongitude, isGeocode, toGeocode, toGeocode`
`class DateFunctions`	`addTime, diffDates, getDayOfMonth, getDayOfWeek, getDayOfYear, getHour, getMilliSecond, getMinute, getMonth, getSeconds, getYear, isDate, toDate, toDate, toString, today, truncateDate`
`class ConversionFunctions`	`toBoolean, toBoolean, toBoolean, toDate, toDouble, toDouble, toDouble, toLong, toLong, toLong, toLong, toString`
`class EnrichmentFunctions`	`detectLanguage, extractKeyPhrases, extractNounGroups, extractWhitelistTags, geotagIPAddress, geotagIPAddressGetGeocode, geotagStructuredAddress, geotagUnstructuredAddress, geotagUnstructuredAddressGetGeocode, getEntities, getSentiment, getTermSentiment, reverseGeotag, runExternalPlugin, stripTagsFromHTML, toPhoneticHash`
`class groovy.lang.Script`	groovy.lang.Script#println(), groovy.lang.Script#println(java.lang.Object), groovy.lang.Script#run(), groovy.lang.Script#run(java.io.File, [Ljava.lang.String;), groovy.lang.Script#setProperty(java.lang.String, java.lang.Object), groovy.lang.Script#getProperty(java.lang.String), groovy.lang.Script#print(java.lang.Object), groovy.lang.Script#printf(java.lang.String, java.lang.Object), groovy.lang.Script#printf(java.lang.String, [Ljava.lang.Object;), groovy.lang.Script#invokeMethod(java.lang.String, java.lang.Object), groovy.lang.Script#evaluate(java.lang.String), groovy.lang.Script#evaluate(java.io.File), groovy.lang.Script#getBinding(), groovy.lang.Script#setBinding(groovy.lang.Binding), groovy.lang.Script#getMetaClass(), groovy.lang.Script#setMetaClass(groovy.lang.MetaClass), groovy.lang.Script#wait(long, int), groovy.lang.Script#wait(long), groovy.lang.Script#wait(), groovy.lang.Script#equals(java.lang.Object), groovy.lang.Script#toString(), groovy.lang.Script#hashCode(), groovy.lang.Script#getClass(), groovy.lang.Script#notify(), groovy.lang.Script#notifyAll()

- Method Detail
  - @ManagedMethod(category=FunctionCategory.STRING) java.lang.String concat(@ManagedParameter(name="attributes", type=TypeConstants.VARG_STRING_TYPE) java.lang.String... attributes)
    
    Concatenate the arguments into a new string
    Parameters:
    attributes - The list of attributes that are to be concatenated
    Returns:
    concatenated string
  - @ManagedMethod(category=FunctionCategory.STRING) java.lang.String concatWithToken(@ManagedParameter(name="joinToken", type=TypeConstants.STRING_TYPE) java.lang.String joinToken, @ManagedParameter(name="attributes", type=TypeConstants.VARG_STRING_TYPE) java.lang.String... attributes)
    
    Concatenate the arguments into a new string using a join token
    Parameters:
    joinToken - The token which will be used to join the string arguments
    attributes - The list of attributes that are to be concatenated
    Returns:
    Return the concatenated string
  - @ManagedMethod(category=FunctionCategory.STRING) java.lang.Boolean contains(@ManagedParameter(name="attribute", type=TypeConstants.STRING_TYPE) java.lang.String attribute, @ManagedParameter(name="searchString", type=TypeConstants.STRING_TYPE) java.lang.String searchString)
    
    Find whether the substring is part of the original string
    Parameters:
    attribute
    searchString
    Returns:
    true if the substring is part of the original string
  - @ManagedMethod(category=FunctionCategory.STRING) java.lang.String find(@ManagedParameter(name="attribute", type=TypeConstants.STRING_TYPE) java.lang.String attribute, @ManagedParameter(name="pattern", type=TypeConstants.STRING_TYPE) java.lang.String pattern)
    
    Find the first occurrence of a regular expression string within a string. If the regex doesn't match, null will be returned.
    Parameters:
    attribute
    pattern
    Returns:
    the string after finding the location of the substring
  - @ManagedMethod(category=FunctionCategory.STRING) java.util.List<java.lang.String> findAll(@ManagedParameter(name="attribute", type=TypeConstants.STRING_TYPE) java.lang.String attribute, @ManagedParameter(name="pattern", type=TypeConstants.STRING_TYPE) java.lang.String pattern)
    
    Returns a (possibly empty) list of all occurrences of a regular expression (in String format) found within a String.
    Parameters:
    attribute
    pattern
    Returns:
    a List containing all full matches of the regex within the string, an empty list will be returned if there are no matches
  - @ManagedMethod(category=FunctionCategory.STRING) java.lang.Integer indexOf(@ManagedParameter(name="attribute", type=TypeConstants.STRING_TYPE) java.lang.String attribute, @ManagedParameter(name="searchString", type=TypeConstants.STRING_TYPE) java.lang.String searchString)
    
    Find the index of substring in the original string
    Parameters:
    attribute
    searchString
    Returns:
    the index of the substring in the original string
  - @ManagedMethod(category=FunctionCategory.STRING) java.lang.Boolean isDouble(@ManagedParameter(name="attribute", type=TypeConstants.STRING_TYPE) java.lang.String attribute)
    
    Test whether the string is a double
    Parameters:
    attribute
    Returns:
    true if the string is a double
  - @ManagedMethod(category=FunctionCategory.STRING) java.lang.Boolean isLong(@ManagedParameter(name="attribute", type=TypeConstants.STRING_TYPE) java.lang.String attribute)
    
    Test whether the string is a long
    Parameters:
    attribute
    Returns:
    true if the string is a long
  - @ManagedMethod(category=FunctionCategory.STRING) java.lang.Integer length(@ManagedParameter(name="attribute", type=TypeConstants.STRING_TYPE) java.lang.String attribute)
    
    Test the length of the string
    Parameters:
    attribute
    Returns:
    the length of the string
  - @ManagedMethod(category=FunctionCategory.STRING) java.lang.String replace(@ManagedParameter(name="attribute", type=TypeConstants.STRING_TYPE) java.lang.String attribute, @ManagedParameter(name="searchString", type=TypeConstants.STRING_TYPE) java.lang.String searchString, @ManagedParameter(name="replaceString", type=TypeConstants.STRING_TYPE) java.lang.String replaceString, @ManagedParameter(name="useRegex", type=TypeConstants.BOOLEAN_TYPE, optional=true) java.lang.Boolean useRegex = false)
    
    Replace a part of whole string with a new expression
    Parameters:
    attribute
    searchString - The expression can either be a literal or a regex
    replaceString
    Returns:
    the replaced string
  - @ManagedMethod(category=FunctionCategory.STRING) java.lang.String[] splitToSet(@ManagedParameter(name="attribute", type=TypeConstants.STRING_TYPE) java.lang.String attribute, @ManagedParameter(name="delimiter", type=TypeConstants.STRING_TYPE) java.lang.String delimiter)
    
    Split the string based on the delimiter
    Parameters:
    attribute
    delimiter
    Returns:
    array of strings split based on delimiter
  - @ManagedMethod(category=FunctionCategory.STRING) java.lang.String stripIndent(@ManagedParameter(name="attribute", type=TypeConstants.STRING_TYPE) java.lang.String attribute)
    
    Strip indentation and extra spaces of the string
    Parameters:
    attribute
    Returns:
    a new string without extra spaces
  - @ManagedMethod(category=FunctionCategory.STRING) java.lang.String substring(@ManagedParameter(name="attribute", type=TypeConstants.STRING_TYPE) java.lang.String attribute, @ManagedParameter(name="startLocation", type=TypeConstants.INTEGER_TYPE) java.lang.Integer startLocation, @ManagedParameter(name="endLocation", type=TypeConstants.INTEGER_TYPE, optional=true) java.lang.Integer endLocation = null)
    
    Get the substring from the original string based on the start and end location in the string
    Parameters:
    attribute
    startLocation
    endLocation
    Returns:
    the substring from the specified locations
  - @ManagedMethod(category=FunctionCategory.STRING) java.lang.String toLowerCase(@ManagedParameter(name="attribute", type=TypeConstants.STRING_TYPE) java.lang.String attribute, @ManagedParameter(name="localeCode", type=TypeConstants.STRING_TYPE, optional=true) java.lang.String localeInfo = "en")
    
    Convert the original string to lower case
    Parameters:
    originalString
    localeInfo
    Returns:
    the lower case string
  - @ManagedMethod(category=FunctionCategory.STRING) java.lang.String toTitleCase(@ManagedParameter(name="attribute", type=TypeConstants.STRING_TYPE) java.lang.String attribute)
    
    Capitalize the string
    Parameters:
    originalString
    Returns:
    the capitalized string
  - @ManagedMethod(category=FunctionCategory.STRING) java.lang.String toUpperCase(@ManagedParameter(name="attribute", type=TypeConstants.STRING_TYPE) java.lang.String attribute, @ManagedParameter(name="localeCode", type=TypeConstants.STRING_TYPE, optional=true) java.lang.String localeInfo = "en")
    
    Convert the original string to upper case
    Parameters:
    attribute
    localeInfo
    Returns:
    the upper case string
  - @ManagedMethod(category=FunctionCategory.STRING) java.lang.String trim(@ManagedParameter(name="attribute", type=TypeConstants.STRING_TYPE) java.lang.String attribute)
    
    Trim the string of extra spaces
    Parameters:
    attribute
    Returns:
    the trimmed string
  - @ManagedMethod(category=FunctionCategory.MISC) java.lang.String urlDecode(@ManagedParameter(name="attribute", type=TypeConstants.STRING_TYPE) java.lang.String attribute, @ManagedParameter(name="characterEncoding", type=TypeConstants.STRING_TYPE, optional=true) java.lang.String characterEncoding = "UTF-8")
    
    Decodes a string into application/x-www-form-urlencoded format using a specific encoding scheme.
    Parameters:
    attribute
    characterEncoding - decoding scheme, default to UTF-8
    Returns:
    encoded string
  - @ManagedMethod(category=FunctionCategory.MISC) java.lang.String urlEncode(@ManagedParameter(name="attribute", type=TypeConstants.STRING_TYPE) java.lang.String attribute, @ManagedParameter(name="characterEncoding", type=TypeConstants.STRING_TYPE, optional=true) java.lang.String characterEncoding = "UTF-8")
    
    Translates a string into application/x-www-form-urlencoded format using a specific encoding scheme.
    Parameters:
    attribute
    characterEncoding - encoding scheme, default to UTF-8
    Returns:
    encoded string

Summary:
Method

| Detail:
Method

[Groovy] Class StringFunctions

Methods Summary

Inherited Methods Summary

Method Detail

@ManagedMethod(category=FunctionCategory.STRING) java.lang.String concat(@ManagedParameter(name="attributes", type=TypeConstants.VARG_STRING_TYPE) java.lang.String... attributes)

@ManagedMethod(category=FunctionCategory.STRING) java.lang.String concatWithToken(@ManagedParameter(name="joinToken", type=TypeConstants.STRING_TYPE) java.lang.String joinToken, @ManagedParameter(name="attributes", type=TypeConstants.VARG_STRING_TYPE) java.lang.String... attributes)

@ManagedMethod(category=FunctionCategory.STRING) java.lang.Boolean contains(@ManagedParameter(name="attribute", type=TypeConstants.STRING_TYPE) java.lang.String attribute, @ManagedParameter(name="searchString", type=TypeConstants.STRING_TYPE) java.lang.String searchString)

@ManagedMethod(category=FunctionCategory.STRING) java.lang.String find(@ManagedParameter(name="attribute", type=TypeConstants.STRING_TYPE) java.lang.String attribute, @ManagedParameter(name="pattern", type=TypeConstants.STRING_TYPE) java.lang.String pattern)

@ManagedMethod(category=FunctionCategory.STRING) java.util.List<java.lang.String> findAll(@ManagedParameter(name="attribute", type=TypeConstants.STRING_TYPE) java.lang.String attribute, @ManagedParameter(name="pattern", type=TypeConstants.STRING_TYPE) java.lang.String pattern)

@ManagedMethod(category=FunctionCategory.STRING) java.lang.Integer indexOf(@ManagedParameter(name="attribute", type=TypeConstants.STRING_TYPE) java.lang.String attribute, @ManagedParameter(name="searchString", type=TypeConstants.STRING_TYPE) java.lang.String searchString)

@ManagedMethod(category=FunctionCategory.STRING) java.lang.Boolean isDouble(@ManagedParameter(name="attribute", type=TypeConstants.STRING_TYPE) java.lang.String attribute)

@ManagedMethod(category=FunctionCategory.STRING) java.lang.Boolean isLong(@ManagedParameter(name="attribute", type=TypeConstants.STRING_TYPE) java.lang.String attribute)

@ManagedMethod(category=FunctionCategory.STRING) java.lang.Integer length(@ManagedParameter(name="attribute", type=TypeConstants.STRING_TYPE) java.lang.String attribute)

@ManagedMethod(category=FunctionCategory.STRING) java.lang.String[] splitToSet(@ManagedParameter(name="attribute", type=TypeConstants.STRING_TYPE) java.lang.String attribute, @ManagedParameter(name="delimiter", type=TypeConstants.STRING_TYPE) java.lang.String delimiter)

@ManagedMethod(category=FunctionCategory.STRING) java.lang.String stripIndent(@ManagedParameter(name="attribute", type=TypeConstants.STRING_TYPE) java.lang.String attribute)

@ManagedMethod(category=FunctionCategory.STRING) java.lang.String toLowerCase(@ManagedParameter(name="attribute", type=TypeConstants.STRING_TYPE) java.lang.String attribute, @ManagedParameter(name="localeCode", type=TypeConstants.STRING_TYPE, optional=true) java.lang.String localeInfo = "en")

@ManagedMethod(category=FunctionCategory.STRING) java.lang.String toTitleCase(@ManagedParameter(name="attribute", type=TypeConstants.STRING_TYPE) java.lang.String attribute)

@ManagedMethod(category=FunctionCategory.STRING) java.lang.String toUpperCase(@ManagedParameter(name="attribute", type=TypeConstants.STRING_TYPE) java.lang.String attribute, @ManagedParameter(name="localeCode", type=TypeConstants.STRING_TYPE, optional=true) java.lang.String localeInfo = "en")

@ManagedMethod(category=FunctionCategory.STRING) java.lang.String trim(@ManagedParameter(name="attribute", type=TypeConstants.STRING_TYPE) java.lang.String attribute)