StringMapFunctions (tablesaw-core 0.24.1 API)

All Superinterfaces:

Column

All Known Implementing Classes:

StringColumn
```
public interface StringMapFunctions
extends Column
```
String utility functions. Each function takes one or more String columns as input and produces another Column as output. The resulting column need not be a string column.

Method Summary

All Methods Instance Methods Default Methods
Modifier and Type	Method	Description
`default StringColumn`	`abbreviate(int maxWidth)`	Abbreviates a String using ellipses.
`default StringColumn`	`commonPrefix(Column column2)`
`default StringColumn`	`commonSuffix(Column column2)`
`default StringColumn`	`concatenate(String append)`	Return a copy of this column with the given string appended to each element
`default NumberColumn`	`countTokens(String separator)`
`default NumberColumn`	`distance(Column column2)`	Returns a column containing the levenshtein distance between the two given string columns
`default StringColumn`	`format(String formatString)`
`default StringColumn`	`join(String separator, StringColumn... columns)`	Return a copy of this column with the given string appended
`default NumberColumn`	`length()`	Returns a column containing the character length of each string in this column The returned column is the same size as the original
`default StringColumn`	`lowerCase()`
`default StringColumn`	`padEnd(int minLength, char padChar)`
`default StringColumn`	`padStart(int minLength, char padChar)`
`default StringColumn`	`replaceAll(String[] regexArray, String replacement)`	Creates a new column, replacing each string in this column with a new string formed by replacing any substring that matches the regex
`default StringColumn`	`replaceAll(String regex, String replacement)`
`default StringColumn`	`replaceFirst(String regex, String replacement)`
`default StringColumn`	`substring(int start)`	Returns a column containing the substrings from start to the end of the input
`default StringColumn`	`substring(int start, int end)`
`default StringColumn`	`tokenizeAndRemoveDuplicates(String separator)`
`default StringColumn`	`tokenizeAndSort()`	Splits on Whitespace and returns the lexicographically sorted result.
`default StringColumn`	`tokenizeAndSort(String separator)`
`default StringColumn`	`tokens(String separator)`	Returns a column of arbitrary size containing each token in this column, where a token is defined using the given separator.
`default StringColumn`	`trim()`
`default StringColumn`	`uniqueTokens(String separator)`	Returns a column of arbitrary size containing each unique token in this column, where a token is defined using the given separator, and uniqueness is calculated across the entire column NOTE: Unlike other map functions, this method produces a column whose size may be different from the source, so they cannot safely be combined in a table.
`default StringColumn`	`upperCase()`

Methods inherited from interface tech.tablesaw.columns.Column
append, appendCell, appendMissing, asBytes, asDoubleArray, asObjectArray, byteSize, clear, columnWidth, copy, countMissing, countUnique, create, emptyCopy, emptyCopy, first, getDouble, getString, getUnformattedString, inRange, isEmpty, isMissing, isMissing, isNotMissing, lag, last, lead, name, print, removeMissing, rolling, rowComparator, rows, sampleN, sampleX, setName, size, sortAscending, sortDescending, subset, summarizeIf, summary, title, type, unique, where

- Method Detail
  - upperCase
```
default StringColumn upperCase()
```
  - lowerCase
```
default StringColumn lowerCase()
```
  - trim
```
default StringColumn trim()
```
  - replaceAll
```
default StringColumn replaceAll(String regex,
                                String replacement)
```
  - replaceFirst
```
default StringColumn replaceFirst(String regex,
                                  String replacement)
```
  - substring
```
default StringColumn substring(int start,
                               int end)
```
  - substring
```
default StringColumn substring(int start)
```
    Returns a column containing the substrings from start to the end of the input
    
    Throws:
    
    StringIndexOutOfBoundsException - if any string in the column is shorter than start
  - abbreviate
```
default StringColumn abbreviate(int maxWidth)
```
    Abbreviates a String using ellipses. This will turn "Now is the time for all good men" into "Now is the time for..."
    
    Parameters:
    
    maxWidth - the maximum width of the resulting strings, including the elipses.
  - format
```
default StringColumn format(String formatString)
```
  - padEnd
```
default StringColumn padEnd(int minLength,
                            char padChar)
```
  - padStart
```
default StringColumn padStart(int minLength,
                              char padChar)
```
  - commonPrefix
```
default StringColumn commonPrefix(Column column2)
```
  - commonSuffix
```
default StringColumn commonSuffix(Column column2)
```
  - distance
```
default NumberColumn distance(Column column2)
```
    Returns a column containing the levenshtein distance between the two given string columns
  - join
```
default StringColumn join(String separator,
                          StringColumn... columns)
```
    Return a copy of this column with the given string appended
    
    Parameters:
    
    columns - the column to append
    
    Returns:
    
    the new column
  - concatenate
```
default StringColumn concatenate(String append)
```
    Return a copy of this column with the given string appended to each element
    
    Parameters:
    
    append - the string to append
    
    Returns:
    
    the new column
  - replaceAll
```
default StringColumn replaceAll(String[] regexArray,
                                String replacement)
```
    Creates a new column, replacing each string in this column with a new string formed by replacing any substring that matches the regex
    
    Parameters:
    
    regexArray - the regex array to replace
    
    replacement - the replacement array
    
    Returns:
    
    the new column
  - tokenizeAndSort
```
default StringColumn tokenizeAndSort(String separator)
```
  - countTokens
```
default NumberColumn countTokens(String separator)
```
  - uniqueTokens
```
default StringColumn uniqueTokens(String separator)
```
    Returns a column of arbitrary size containing each unique token in this column, where a token is defined using the given separator, and uniqueness is calculated across the entire column NOTE: Unlike other map functions, this method produces a column whose size may be different from the source, so they cannot safely be combined in a table.
    
    Parameters:
    
    separator - the delimiter used in the tokenizing operation
    
    Returns:
    
    a new column
  - tokens
```
default StringColumn tokens(String separator)
```
    Returns a column of arbitrary size containing each token in this column, where a token is defined using the given separator. NOTE: Unlike other map functions, this method produces a column whose size may be different from the source, so they cannot safely be combined in a table.
    
    Parameters:
    
    separator - the delimiter used in the tokenizing operation
    
    Returns:
    
    a new column
  - length
```
default NumberColumn length()
```
    Returns a column containing the character length of each string in this column The returned column is the same size as the original
  - tokenizeAndSort
```
default StringColumn tokenizeAndSort()
```
    Splits on Whitespace and returns the lexicographically sorted result.
    
    Returns:
    
    a StringColumn
  - tokenizeAndRemoveDuplicates
```
default StringColumn tokenizeAndRemoveDuplicates(String separator)
```

Interface StringMapFunctions

Method Summary

Methods inherited from interface tech.tablesaw.columns.Column

Method Detail

upperCase

lowerCase

trim

replaceAll

replaceFirst

substring

substring

abbreviate

format

padEnd

padStart

commonPrefix

commonSuffix

distance

join

concatenate

replaceAll

tokenizeAndSort

countTokens

uniqueTokens

tokens

length

tokenizeAndSort

tokenizeAndRemoveDuplicates