tech.bitey.dataframe

Interface StringColumn

All Superinterfaces:

Collection<String>, Column<String>, Iterable<String>, List<String>

public interface StringColumn
extends Column<String>

A Column with element type String.

Elements are stored as UTF-8 encoded bytes in a ByteBuffer.

Author:

biteytech@protonmail.com

Field Summary

Fields inherited from interface tech.bitey.dataframe.Column

BASE_CHARACTERISTICS

Method Summary

Modifier and Type	Method and Description
StringColumn	append(Column<String> tail) Appends two columns with the same element type.
static StringColumnBuilder	builder() Returns a new StringColumnBuilder
static StringColumnBuilder	builder(int characteristic) Returns an builder with the specified characteristic.
static Collector<String,?,StringColumn>	collector() Collects a stream of Strings into a new StringColumn.
static Collector<String,?,StringColumn>	collector(int characteristic) Collects a stream of Strings into a new StringColumn with the specified characteristic.
StringColumn	copy() Returns a column equal to this one, but with elements stored in a newly allocated buffer.
StringColumn	head(String toElement) Same behavior as Column.head(Object, boolean), with inclusive set to false.
StringColumn	head(String toElement, boolean inclusive) Returns a view of the portion of this column whose elements are less than (or equal to, if inclusive is true) toElement.
static StringColumn	of(String... elements) Returns a new StringColumn containing the specified elements.
StringColumn	subColumn(int fromIndex, int toIndex) Returns a view of the portion of this column between the specified fromIndex, inclusive, and toIndex, exclusive.
StringColumn	subColumnByValue(String fromElement, boolean fromInclusive, String toElement, boolean toInclusive) Returns a view of the portion of this column whose elements range from fromElement to toElement.
StringColumn	subColumnByValue(String fromElement, String toElement) Same behavior as Column#subColumn(Object, boolean, Object, Boolean), with fromInclusive set to true and toInclusive set to false.
StringColumn	tail(String fromElement) Same behavior as Column.tail(Object, boolean), with inclusive set to true.
StringColumn	tail(String fromElement, boolean inclusive) Returns a view of the portion of this column whose elements are greater than (or equal to, if inclusive is true) fromElement.
StringColumn	toDistinct() Converts a column to a unique index.
StringColumn	toHeap() Converts an index into a heap.
StringColumn	toSorted() Converts a heap to an index.

Methods inherited from interface tech.bitey.dataframe.Column

append, ceiling, characteristics, comparator, first, floor, getType, higher, isDistinct, isNonnull, isNull, isSorted, last, lower, spliterator

Methods inherited from interface java.util.List

add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, replaceAll, retainAll, set, size, sort, subList, toArray, toArray

Methods inherited from interface java.util.Collection

parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable

forEach

Method Detail

subColumn

StringColumn subColumn(int fromIndex,
                       int toIndex)

Description copied from interface: Column

Returns a view of the portion of this column between the specified fromIndex, inclusive, and toIndex, exclusive. (If fromIndex and toIndex are equal, the returned list is empty.) The returned column is backed by this column.

Specified by:

subColumn in interface Column<String>

Parameters:

fromIndex - low endpoint (inclusive) of the subList

toIndex - high endpoint (exclusive) of the subList

Returns:

a view of the specified range within this column

subColumnByValue

StringColumn subColumnByValue(String fromElement,
                              boolean fromInclusive,
                              String toElement,
                              boolean toInclusive)

Description copied from interface: Column

Returns a view of the portion of this column whose elements range from fromElement to toElement. If fromElement and toElement are equal, the returned column is empty unless fromInclusive and toInclusive are both true. The returned column is backed by this column.

This method is only available when Column.isDistinct() returns true.

Specified by:

subColumnByValue in interface Column<String>

Parameters:

fromElement - low endpoint of the returned column

fromInclusive - true if the low endpoint is to be included in the result

toElement - high endpoint of the returned column

toInclusive - true if the high endpoint is to be included in the result

Returns:

a view of the portion of this column whose elements range from fromElement to toElement

subColumnByValue

StringColumn subColumnByValue(String fromElement,
                              String toElement)

Description copied from interface: Column

Same behavior as Column#subColumn(Object, boolean, Object, Boolean), with fromInclusive set to true and toInclusive set to false.

This method is only available when Column.isDistinct() returns true.

Specified by:

subColumnByValue in interface Column<String>

Parameters:

fromElement - low endpoint of the returned column, inclusive

toElement - high endpoint of the returned column, exclusive

Returns:

view of the portion of this column whose elements range from fromElement, inclusive, to toElement, exclusive

head

StringColumn head(String toElement,
                  boolean inclusive)

Description copied from interface: Column

Returns a view of the portion of this column whose elements are less than (or equal to, if inclusive is true) toElement. The returned column is backed by this column.

This method is only available when Column.isDistinct() returns true.

Specified by:

head in interface Column<String>

Parameters:

toElement - high endpoint of the returned column

inclusive - true if the high endpoint is to be included in the returned view

Returns:

a view of the portion of this column whose elements are less than (or equal to, if inclusive is true) toElement

head

StringColumn head(String toElement)

Description copied from interface: Column

Same behavior as Column.head(Object, boolean), with inclusive set to false.

This method is only available when Column.isDistinct() returns true.

Specified by:

head in interface Column<String>

Parameters:

toElement - high endpoint of the returned column

Returns:

a view of the portion of this column whose elements are less than toElement

tail

StringColumn tail(String fromElement,
                  boolean inclusive)

Description copied from interface: Column

Returns a view of the portion of this column whose elements are greater than (or equal to, if inclusive is true) fromElement. The returned column is backed by this column.

This method is only available when Column.isDistinct() returns true.

Specified by:

tail in interface Column<String>

Parameters:

fromElement - low endpoint of the returned column

inclusive - true if the low endpoint is to be included in the returned view

Returns:

a view of the portion of this column whose elements are greater than or equal to fromElement

tail

StringColumn tail(String fromElement)

Description copied from interface: Column

Same behavior as Column.tail(Object, boolean), with inclusive set to true.

This method is only available when Column.isDistinct() returns true.

Specified by:

tail in interface Column<String>

Parameters:

fromElement - low endpoint of the returned column

Returns:

a view of the portion of this column whose elements are greater than or equal to fromElement

toHeap

StringColumn toHeap()

Description copied from interface: Column

Converts an index into a heap.

Specified by:

toHeap in interface Column<String>

Returns:

a column equal to this one, but which reports Column.isSorted() as false. The resulting column shares the same underlying buffer as this one.

toSorted

StringColumn toSorted()

Description copied from interface: Column

Converts a heap to an index. The resulting column will have the same elements, but sorted in ascending order. The behavior of this method depends on the Column.characteristics() of this column:

• heap - checks if the column is already sorted. If so, returns a new column which shares the same underlying buffer, but with SORTED flag set. If not already sorted then Column.copy() will be invoked, and the resulting column will be sorted.
• sorted - returns this column
• distinct - returns a new column which shares the same underlying buffer, but with DISTINCT flag unset.

Specified by:

toSorted in interface Column<String>

Returns:

a column with elements sorted in ascending order

toDistinct

StringColumn toDistinct()

Description copied from interface: Column

Converts a column to a unique index. The behavior of this method depends on the Column.characteristics() of this column:

• heap - checks if the column is already sorted and distinct. If so, returns a new column which shares the same underlying buffer, but with SORTED and DISTINCT flags set. If not already sorted and distinct then Column.copy() will be invoked, and the resulting column will be sorted and deduplicated.
• sorted - checks if the column contains duplicates. If not, returns a new column which shares the same underlying buffer, but with DISTINCT flag set. If duplicates are present then Column.copy() will be invoked, and the resulting column will be deduplicated.
• distinct - returns this column

Specified by:

toDistinct in interface Column<String>

Returns:

a column with distinct elements sorted in ascending order

append

StringColumn append(Column<String> tail)

Description copied from interface: Column

Appends two columns with the same element type.

Both columns must have the same characteristics. If they're both unique indices then the first value of the provided column must be greater than the last value of this column.

Specified by:

append in interface Column<String>

Parameters:

tail - - the column to be appended to the end of this column

Returns:

the provided column appended to the end of this column

copy

StringColumn copy()

Description copied from interface: Column

Returns a column equal to this one, but with elements stored in a newly allocated buffer.

Specified by:

copy in interface Column<String>

Returns:

a column equal to this one, but with elements stored in a newly allocated buffer.

builder

static StringColumnBuilder builder(int characteristic)

Returns an builder with the specified characteristic.

Parameters:

characteristic - - one of:

• 0 (zero) - no constraints on the elements to be added to the column
• NONNULL
• SORTED
• DISTINCT

Returns:

a new StringColumnBuilder

Throws:

IllegalArgumentException - if characteristic is not valid

builder

static StringColumnBuilder builder()

Returns a new StringColumnBuilder

Equivalent to builder(0)

Returns:

a new StringColumnBuilder

of

static StringColumn of(String... elements)

Returns a new StringColumn containing the specified elements.

Parameters:

elements - the elements to be included in the new column

Returns:

a new StringColumn containing the specified elements.

collector

static Collector<String,?,StringColumn> collector(int characteristic)

Collects a stream of Strings into a new StringColumn with the specified characteristic.

Parameters:

characteristic - - one of:

• 0 (zero) - no constraints on the elements to be added to the column
• NONNULL
• SORTED
• DISTINCT

Returns:

a new StringColumn

Throws:

IllegalArgumentException - if characteristic is not valid

collector

static Collector<String,?,StringColumn> collector()

Collects a stream of Strings into a new StringColumn.

Equivalent to collector(0)

Returns:

a new StringColumn