StringColumn (tablesaw-core 0.33.0 API)

java.lang.Object
- tech.tablesaw.columns.AbstractColumn<String>
- - tech.tablesaw.api.StringColumn

All Implemented Interfaces:

Iterable<String>, Comparator<String>, CategoricalColumn<String>, Column<String>, StringFilters, StringMapFunctions, StringReduceUtils
```
public class StringColumn
extends AbstractColumn<String>
implements CategoricalColumn<String>, StringFilters, StringMapFunctions, StringReduceUtils
```
A column that contains String values. They are assumed to be 'categorical' rather than free-form text, so are stored in an encoding that takes advantage of the expected repetition of string values.
Because the MISSING_VALUE for this column type is an empty string, there is little or no need for special handling of missing values in this class's methods.

Field Summary
- Fields inherited from class tech.tablesaw.columns.AbstractColumn
  DEFAULT_ARRAY_SIZE

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`StringColumn`	`addAll(List<String> stringValues)` Add all the strings in the list to this column
`StringColumn`	`append(Column<String> column)`
`Column<String>`	`append(Column<String> column, int row)`
`StringColumn`	`append(String value)` Added for naming consistency with all other columns
`StringColumn`	`appendCell(String object)`
`StringColumn`	`appendCell(String object, AbstractColumnParser<?> parser)`
`StringColumn`	`appendMissing()` Appends a missing value appropriate to the column
`StringColumn`	`appendObj(Object obj)`
`byte[]`	`asBytes(int rowNumber)` Returns the contents of the cell at rowNumber as a byte[]
`double[]`	`asDoubleArray()`
`DoubleColumn`	`asDoubleColumn()`
`List<String>`	`asList()` Returns a List<String> representation of all the values in this column
`String[]`	`asObjectArray()`
`Set<String>`	`asSet()`
`StringColumn`	`asStringColumn()`
`TextColumn`	`asTextColumn()`
`List<String>`	`bottom(int n)` Returns the smallest ("bottom") n values in the column
`int`	`byteSize()` Returns the width of a cell in this column, in bytes.
`void`	`clear()`
`int`	`compare(String o1, String o2)`
`boolean`	`contains(String aString)` Returns true if this column contains a cell with the given string, and false otherwise
`StringColumn`	`copy()` Returns a deep copy of the receiver
`Table`	`countByCategory()`
`int`	`countMissing()` Returns the count of missing values in this column
`int`	`countOccurrences(String value)`
`int`	`countUnique()` Returns the count of unique values in this column.
`static StringColumn`	`create(String name)`
`static StringColumn`	`create(String name, int size)`
`static StringColumn`	`create(String name, List<String> strings)`
`static StringColumn`	`create(String name, String[] strings)`
`StringColumn`	`emptyCopy()` Returns a copy of the receiver with no data.
`StringColumn`	`emptyCopy(int rowSize)` Returns an empty copy of the receiver, with its internal storage initialized to the given row size.
`StringColumn`	`filter(Predicate<? super String> test)` Returns a new Column of the same type with only those rows satisfying the predicate
`StringColumn`	`first(int numRows)`
`int`	`firstIndexOf(String value)`
`String`	`get(int rowIndex)` Returns the value at rowIndex in this column.
`double`	`getDouble(int i)`
`List<BooleanColumn>`	`getDummies()` Returns a list of boolean columns suitable for use as dummy variables in, for example, regression analysis, select a column of categorical data must be encoded as a list of columns, such that each column represents a single category and indicates whether it is present (1) or not present (0)
`StringColumnFormatter`	`getPrintFormatter()`
`String`	`getString(int row)` Returns a string representation of the value at the given row.
`String`	`getUnformattedString(int row)`
`StringColumn`	`inRange(int start, int end)` Returns a column containing the rows in this column beginning with start inclusive, and ending with end exclusive
`boolean`	`isEmpty()` Returns true if the column has no data
`Selection`	`isEqualTo(String string)`
`Selection`	`isIn(Collection<String> strings)`
`Selection`	`isIn(String... strings)`
`boolean`	`isMissing(int rowNumber)`
`Selection`	`isNotEqualTo(String string)`
`Selection`	`isNotIn(Collection<String> strings)`
`Selection`	`isNotIn(String... strings)`
`Iterator<String>`	`iterator()`
`StringColumn`	`lag(int n)` Returns a column of the same type and size as the receiver, containing the receivers values offset by n.
`StringColumn`	`last(int numRows)`
`StringColumn`	`lead(int n)` Returns a column of the same type as the receiver, containing the receivers values offset -n For example if you lead a column containing 2, 3, 4 by 1, you get a column containing 3, 4, NA.
`StringColumn`	`map(Function<? super String,? extends String> fun)` Maps the function across all rows, appending the results to a new Column of the same type
`StringColumn`	`max(Column<String> other)` Returns a column containing the element-wise min between this column and other column TODO(lwhite) Override in column subtypes for better performance
`StringColumn`	`min(Column<String> other)` Returns a column containing the element-wise min between this column and other column TODO(lwhite) Override in column subtypes for better performance
`StringColumn`	`removeMissing()`
`it.unimi.dsi.fastutil.ints.IntComparator`	`rowComparator()`
`StringColumn`	`sampleN(int n)` Returns a column containing a random sample of the values in this column
`StringColumn`	`sampleX(double proportion)` Returns a table consisting of randomly selected values from this column.
`Column<String>`	`set(int row, Column<String> column, int sourceRow)`
`StringColumn`	`set(int rowIndex, String stringValue)`
`StringColumn`	`set(Selection condition, Column<String> other)` Updates this column where values matching the selection are replaced with the corresponding value from the given column
`StringColumn`	`set(Selection rowSelection, String newValue)` Conditionally update this column, replacing current values with newValue for all rows where the current value matches the selection criteria
`Column<String>`	`setMissing(int i)`
`StringColumn`	`setName(String name)` Sets the columns name to the given string
`void`	`setPrintFormatter(StringColumnFormatter formatter)`
`int`	`size()` Returns the number of elements (a.k.a.
`void`	`sortAscending()`
`void`	`sortDescending()`
`StringColumn`	`sorted(Comparator<? super String> comp)` Returns a new Column of the same type sorted according to the provided Comparator
`StringColumn`	`subset(int[] rows)`
`Table`	`summary()`
`List<String>`	`top(int n)` Returns the largest ("top") n values in the column
`StringColumn`	`unique()` Returns a new Column containing all the unique values in this column
`static boolean`	`valueIsMissing(String string)`
`StringColumn`	`where(Selection selection)`

Methods inherited from class tech.tablesaw.columns.AbstractColumn
name, toString, type

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

Methods inherited from interface tech.tablesaw.columns.strings.StringFilters
containsString, endsWith, equalsIgnoreCase, equalsIgnoreCase, eval, eval, eval, eval, isAlpha, isAlphaNumeric, isEmptyString, isEqualTo, isLongerThan, isLowerCase, isMissing, isNotEqualTo, isNotMissing, isNumeric, isShorterThan, isUpperCase, lengthEquals, matchesRegex, startsWith, startsWith

Methods inherited from interface tech.tablesaw.columns.strings.StringMapFunctions
abbreviate, commonPrefix, commonSuffix, concatenate, countTokens, distance, format, join, length, lowerCase, padEnd, padStart, parseInt, replaceAll, replaceAll, replaceFirst, substring, substring, tokenizeAndRemoveDuplicates, tokenizeAndSort, tokenizeAndSort, tokens, trim, uniqueTokens, upperCase

Methods inherited from interface tech.tablesaw.columns.strings.StringReduceUtils
appendAll, appendAll

Methods inherited from interface tech.tablesaw.columns.Column
allMatch, anyMatch, columnWidth, count, count, mapInto, max, min, name, noneMatch, print, reduce, reduce, rolling, title, type

Methods inherited from interface java.lang.Iterable
forEach, spliterator

Methods inherited from interface java.util.Comparator
comparing, comparing, comparingDouble, comparingInt, comparingLong, equals, naturalOrder, nullsFirst, nullsLast, reversed, reverseOrder, thenComparing, thenComparing, thenComparing, thenComparingDouble, thenComparingInt, thenComparingLong

- Method Detail
  - valueIsMissing
```
public static boolean valueIsMissing(String string)
```
  - appendMissing
```
public StringColumn appendMissing()
```
    Description copied from interface: Column
    
    Appends a missing value appropriate to the column
    
    Specified by:
    
    appendMissing in interface Column<String>
  - create
```
public static StringColumn create(String name)
```
  - create
```
public static StringColumn create(String name,
                                  String[] strings)
```
  - create
```
public static StringColumn create(String name,
                                  List<String> strings)
```
  - create
```
public static StringColumn create(String name,
                                  int size)
```
  - isMissing
```
public boolean isMissing(int rowNumber)
```
    Specified by:
    
    isMissing in interface Column<String>
  - setPrintFormatter
```
public void setPrintFormatter(StringColumnFormatter formatter)
```
  - getPrintFormatter
```
public StringColumnFormatter getPrintFormatter()
```
  - getString
```
public String getString(int row)
```
    Description copied from interface: Column
    
    Returns a string representation of the value at the given row.
    
    Specified by:
    
    getString in interface Column<String>
    
    Parameters:
    
    row - The index of the row.
    
    Returns:
    
    value as String
  - getUnformattedString
```
public String getUnformattedString(int row)
```
    Specified by:
    
    getUnformattedString in interface Column<String>
  - emptyCopy
```
public StringColumn emptyCopy()
```
    Description copied from interface: Column
    
    Returns a copy of the receiver with no data. The column name and type are the same.
    
    Specified by:
    
    emptyCopy in interface Column<String>
    
    Specified by:
    
    emptyCopy in class AbstractColumn<String>
    
    Returns:
    
    a empty copy of Column
  - emptyCopy
```
public StringColumn emptyCopy(int rowSize)
```
    Description copied from interface: Column
    
    Returns an empty copy of the receiver, with its internal storage initialized to the given row size.
    
    Specified by:
    
    emptyCopy in interface Column<String>
    
    Parameters:
    
    rowSize - the initial row size
    
    Returns:
    
    a Column
  - sortAscending
```
public void sortAscending()
```
    Specified by:
    
    sortAscending in interface Column<String>
  - sortDescending
```
public void sortDescending()
```
    Specified by:
    
    sortDescending in interface Column<String>
  - size
```
public int size()
```
    Returns the number of elements (a.k.a. rows or cells) in the column
    
    Specified by:
    
    size in interface Column<String>
    
    Returns:
    
    size as int
  - get
```
public String get(int rowIndex)
```
    Returns the value at rowIndex in this column. The index is zero-based.
    
    Specified by:
    
    get in interface Column<String>
    
    Specified by:
    
    get in interface StringFilters
    
    Parameters:
    
    rowIndex - index of the row
    
    Returns:
    
    value as String
    
    Throws:
    
    IndexOutOfBoundsException - if the given rowIndex is not in the column
  - asList
```
public List<String> asList()
```
    Returns a List<String> representation of all the values in this column
    NOTE: Unless you really need a string consider using the column itself for large datasets as it uses much less memory
    
    Specified by:
    
    asList in interface Column<String>
    
    Returns:
    
    values as a list of String.
  - summary
```
public Table summary()
```
    Specified by:
    
    summary in interface Column<String>
  - countByCategory
```
public Table countByCategory()
```
    Specified by:
    
    countByCategory in interface CategoricalColumn<String>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface Column<String>
  - lead
```
public StringColumn lead(int n)
```
    Description copied from interface: Column
    
    Returns a column of the same type as the receiver, containing the receivers values offset -n For example if you lead a column containing 2, 3, 4 by 1, you get a column containing 3, 4, NA.
    
    Specified by:
    
    lead in interface Column<String>
  - lag
```
public StringColumn lag(int n)
```
    Description copied from interface: Column
    
    Returns a column of the same type and size as the receiver, containing the receivers values offset by n.
    For example if you lag a column containing 2, 3, 4 by 1, you get a column containing NA, 2, 3
    
    Specified by:
    
    lag in interface Column<String>
  - set
```
public StringColumn set(Selection rowSelection,
                        String newValue)
```
    Conditionally update this column, replacing current values with newValue for all rows where the current value matches the selection criteria
    Examples: myCatColumn.set(myCatColumn.isEqualTo("Cat"), "Dog"); // no more cats myCatColumn.set(myCatColumn.valueIsMissing(), "Fox"); // no more missing values
    
    Specified by:
    
    set in interface Column<String>
  - set
```
public StringColumn set(int rowIndex,
                        String stringValue)
```
    Specified by:
    
    set in interface Column<String>
  - countUnique
```
public int countUnique()
```
    Description copied from interface: Column
    
    Returns the count of unique values in this column.
    
    Specified by:
    
    countUnique in interface Column<String>
    
    Returns:
    
    unique values as int
  - top
```
public List<String> top(int n)
```
    Returns the largest ("top") n values in the column
    
    Parameters:
    
    n - The maximum number of records to return. The actual number will be smaller if n is greater than the number of observations in the column
    
    Returns:
    
    A list, possibly empty, of the largest observations
  - bottom
```
public List<String> bottom(int n)
```
    Returns the smallest ("bottom") n values in the column
    
    Parameters:
    
    n - The maximum number of records to return. The actual number will be smaller if n is greater than the number of observations in the column
    
    Returns:
    
    A list, possibly empty, of the smallest n observations
  - contains
```
public boolean contains(String aString)
```
    Returns true if this column contains a cell with the given string, and false otherwise
    
    Specified by:
    
    contains in interface Column<String>
    
    Parameters:
    
    aString - the value to look for
    
    Returns:
    
    true if contains, false otherwise
  - setMissing
```
public Column<String> setMissing(int i)
```
    Specified by:
    
    setMissing in interface Column<String>
  - addAll
```
public StringColumn addAll(List<String> stringValues)
```
    Add all the strings in the list to this column
    
    Parameters:
    
    stringValues - a list of values
  - appendCell
```
public StringColumn appendCell(String object)
```
    Specified by:
    
    appendCell in interface Column<String>
  - appendCell
```
public StringColumn appendCell(String object,
                               AbstractColumnParser<?> parser)
```
    Specified by:
    
    appendCell in interface Column<String>
  - rowComparator
```
public it.unimi.dsi.fastutil.ints.IntComparator rowComparator()
```
    Specified by:
    
    rowComparator in interface Column<String>
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from interface: Column
    
    Returns true if the column has no data
    
    Specified by:
    
    isEmpty in interface Column<String>
    
    Returns:
    
    true if empty, false if not
  - isEqualTo
```
public Selection isEqualTo(String string)
```
    Specified by:
    
    isEqualTo in interface StringFilters
  - isNotEqualTo
```
public Selection isNotEqualTo(String string)
```
    Specified by:
    
    isNotEqualTo in interface StringFilters
  - getDummies
```
public List<BooleanColumn> getDummies()
```
    Returns a list of boolean columns suitable for use as dummy variables in, for example, regression analysis, select a column of categorical data must be encoded as a list of columns, such that each column represents a single category and indicates whether it is present (1) or not present (0)
    
    Returns:
    
    a list of BooleanColumn
  - unique
```
public StringColumn unique()
```
    Returns a new Column containing all the unique values in this column
    
    Specified by:
    
    unique in interface Column<String>
    
    Returns:
    
    a column with unique values.
  - asDoubleColumn
```
public DoubleColumn asDoubleColumn()
```
  - where
```
public StringColumn where(Selection selection)
```
    Specified by:
    
    where in interface Column<String>
  - copy
```
public StringColumn copy()
```
    Description copied from interface: Column
    
    Returns a deep copy of the receiver
    
    Specified by:
    
    copy in interface Column<String>
    
    Returns:
    
    a Column
  - append
```
public StringColumn append(Column<String> column)
```
    Specified by:
    
    append in interface Column<String>
  - append
```
public Column<String> append(Column<String> column,
                             int row)
```
    Specified by:
    
    append in interface Column<String>
  - set
```
public Column<String> set(int row,
                          Column<String> column,
                          int sourceRow)
```
    Specified by:
    
    set in interface Column<String>
  - countMissing
```
public int countMissing()
```
    Returns the count of missing values in this column
    
    Specified by:
    
    countMissing in interface Column<String>
    
    Returns:
    
    missing values as int
  - removeMissing
```
public StringColumn removeMissing()
```
    Specified by:
    
    removeMissing in interface Column<String>
  - iterator
```
public Iterator<String> iterator()
```
    Specified by:
    
    iterator in interface Iterable<String>
  - asSet
```
public Set<String> asSet()
```
  - byteSize
```
public int byteSize()
```
    Description copied from interface: Column
    
    Returns the width of a cell in this column, in bytes.
    
    Specified by:
    
    byteSize in interface Column<String>
    
    Returns:
    
    width in bytes
  - asBytes
```
public byte[] asBytes(int rowNumber)
```
    Returns the contents of the cell at rowNumber as a byte[]
    
    Specified by:
    
    asBytes in interface Column<String>
    
    Parameters:
    
    rowNumber - index of the row
    
    Returns:
    
    content as byte[]
  - getDouble
```
public double getDouble(int i)
```
  - asDoubleArray
```
public double[] asDoubleArray()
```
  - append
```
public StringColumn append(String value)
```
    Added for naming consistency with all other columns
    
    Specified by:
    
    append in interface Column<String>
  - appendObj
```
public StringColumn appendObj(Object obj)
```
    Specified by:
    
    appendObj in interface Column<String>
  - isIn
```
public Selection isIn(String... strings)
```
    Specified by:
    
    isIn in interface StringFilters
  - isIn
```
public Selection isIn(Collection<String> strings)
```
    Specified by:
    
    isIn in interface StringFilters
  - isNotIn
```
public Selection isNotIn(String... strings)
```
    Specified by:
    
    isNotIn in interface StringFilters
  - isNotIn
```
public Selection isNotIn(Collection<String> strings)
```
    Specified by:
    
    isNotIn in interface StringFilters
  - firstIndexOf
```
public int firstIndexOf(String value)
```
  - countOccurrences
```
public int countOccurrences(String value)
```
  - asObjectArray
```
public String[] asObjectArray()
```
    Specified by:
    
    asObjectArray in interface Column<String>
  - compare
```
public int compare(String o1,
                   String o2)
```
    Specified by:
    
    compare in interface Comparator<String>
  - setName
```
public StringColumn setName(String name)
```
    Description copied from interface: Column
    
    Sets the columns name to the given string
    
    Specified by:
    
    setName in interface Column<String>
    
    Overrides:
    
    setName in class AbstractColumn<String>
    
    Parameters:
    
    name - The new name MUST be unique for any table containing this column
    
    Returns:
    
    this Column to allow method chaining
  - filter
```
public StringColumn filter(Predicate<? super String> test)
```
    Description copied from interface: Column
    
    Returns a new Column of the same type with only those rows satisfying the predicate
    
    Specified by:
    
    filter in interface Column<String>
    
    Parameters:
    
    test - the predicate
    
    Returns:
    
    a new Column of the same type with only those rows satisfying the predicate
  - subset
```
public StringColumn subset(int[] rows)
```
    Specified by:
    
    subset in interface Column<String>
  - sorted
```
public StringColumn sorted(Comparator<? super String> comp)
```
    Description copied from interface: Column
    
    Returns a new Column of the same type sorted according to the provided Comparator
    
    Specified by:
    
    sorted in interface Column<String>
    
    Parameters:
    
    comp - the Comparator
    
    Returns:
    
    a sorted Column
  - map
```
public StringColumn map(Function<? super String,? extends String> fun)
```
    Description copied from interface: Column
    
    Maps the function across all rows, appending the results to a new Column of the same type
    
    Specified by:
    
    map in interface Column<String>
    
    Parameters:
    
    fun - function to map
    
    Returns:
    
    the Column with the results
  - min
```
public StringColumn min(Column<String> other)
```
    Description copied from interface: Column
    
    Returns a column containing the element-wise min between this column and other column TODO(lwhite) Override in column subtypes for better performance
    
    Specified by:
    
    min in interface Column<String>
  - max
```
public StringColumn max(Column<String> other)
```
    Description copied from interface: Column
    
    Returns a column containing the element-wise min between this column and other column TODO(lwhite) Override in column subtypes for better performance
    
    Specified by:
    
    max in interface Column<String>
  - set
```
public StringColumn set(Selection condition,
                        Column<String> other)
```
    Description copied from interface: Column
    
    Updates this column where values matching the selection are replaced with the corresponding value from the given column
    
    Specified by:
    
    set in interface Column<String>
  - first
```
public StringColumn first(int numRows)
```
    Specified by:
    
    first in interface Column<String>
  - last
```
public StringColumn last(int numRows)
```
    Specified by:
    
    last in interface Column<String>
  - inRange
```
public StringColumn inRange(int start,
                            int end)
```
    Description copied from interface: Column
    
    Returns a column containing the rows in this column beginning with start inclusive, and ending with end exclusive
    
    Specified by:
    
    inRange in interface Column<String>
  - sampleN
```
public StringColumn sampleN(int n)
```
    Description copied from interface: Column
    
    Returns a column containing a random sample of the values in this column
    
    Specified by:
    
    sampleN in interface Column<String>
    
    Parameters:
    
    n - the number of values to select
    
    Returns:
    
    A column of the same type as the receiver
  - sampleX
```
public StringColumn sampleX(double proportion)
```
    Description copied from interface: Column
    
    Returns a table consisting of randomly selected values from this column. The sample size is based on the given proportion of the total number of cells in this column
    
    Specified by:
    
    sampleX in interface Column<String>
    
    Parameters:
    
    proportion - The proportion to go in the sample
  - asStringColumn
```
public StringColumn asStringColumn()
```
    Specified by:
    
    asStringColumn in interface Column<String>
    
    Overrides:
    
    asStringColumn in class AbstractColumn<String>
  - asTextColumn
```
public TextColumn asTextColumn()
```

Class StringColumn

Field Summary

Fields inherited from class tech.tablesaw.columns.AbstractColumn

Method Summary

Methods inherited from class tech.tablesaw.columns.AbstractColumn

Methods inherited from class java.lang.Object

Methods inherited from interface tech.tablesaw.columns.strings.StringFilters

Methods inherited from interface tech.tablesaw.columns.strings.StringMapFunctions

Methods inherited from interface tech.tablesaw.columns.strings.StringReduceUtils

Methods inherited from interface tech.tablesaw.columns.Column

Methods inherited from interface java.lang.Iterable

Methods inherited from interface java.util.Comparator

Method Detail

valueIsMissing

appendMissing

create

create

create

create

isMissing

setPrintFormatter

getPrintFormatter

getString

getUnformattedString

emptyCopy

emptyCopy

sortAscending

sortDescending

size

get

asList

summary

countByCategory

clear

lead

lag

set

set

countUnique

top

bottom

contains

setMissing

addAll

appendCell

appendCell

rowComparator

isEmpty

isEqualTo

isNotEqualTo

getDummies

unique

asDoubleColumn

where

copy

append

append

set

countMissing

removeMissing

iterator

asSet

byteSize

asBytes

getDouble

asDoubleArray

append

appendObj

isIn

isIn

isNotIn

isNotIn

firstIndexOf

countOccurrences

asObjectArray

compare

setName

filter

subset

sorted