EnumColumn (tech.bitey:dataframe 0.3.2 API)

java.lang.Object
- tech.bitey.dataframe.EnumColumn<T>

Type Parameters:

T - - enum element type

All Implemented Interfaces:

Iterable<T>, Collection<T>, List<T>, Column<T>
```
public class EnumColumn<T extends Enum<T>>
extends Object
implements Column<T>
```
An EnumColumn is a view wrapping a ByteColumn, with the byte values interpreted as ordinals of the specified enum type.
EnumColumns are not first-class columns - they cannot be directly added to a DataFrame, and the getType() method returns null.

Author:

biteytech@protonmail.com

See Also:

wrap(Class, ByteColumn), unwrap()

Field Summary
- Fields inherited from interface tech.bitey.dataframe.Column
  BASE_CHARACTERISTICS

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(int index, T element)`
`boolean`	`add(T e)`
`boolean`	`addAll(Collection<? extends T> c)`
`boolean`	`addAll(int index, Collection<? extends T> c)`
`EnumColumn<T>`	`append(Column<T> tail)` Appends two columns with the same element type.
`T`	`ceiling(T value)` Returns the least element in this column greater than or equal to the given element, or `null` if there is no such element.
`int`	`characteristics()` Returns the `Spliterator.characteristics()` for this column.
`void`	`clear()`
`Comparator<? super T>`	`comparator()` Returns the comparator used to order the elements in this column.
`boolean`	`contains(Object o)`
`boolean`	`containsAll(Collection<?> c)`
`EnumColumn<T>`	`copy()` Returns a column equal to this one, but with elements stored in a newly allocated buffer.
`boolean`	`equals(Object o)`
`T`	`first()` Returns the first (lowest) element in this column.
`T`	`floor(T value)` Returns the greatest element in this column less than or equal to the given element, or `null` if there is no such element.
`T`	`get(int index)`
`ColumnType<T>`	`getType()`
`int`	`hashCode()`
`EnumColumn<T>`	`head(T toElement)` Same behavior as `Column.head(Object, boolean)`, with `inclusive` set to false.
`EnumColumn<T>`	`head(T 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`.
`T`	`higher(T value)` Returns the least element in this column strictly greater than the given element, or `null` if there is no such element.
`int`	`indexOf(Object o)`
`boolean`	`isEmpty()`
`boolean`	`isNull(int index)` Test if a value is null at a given index.
`Iterator<T>`	`iterator()`
`T`	`last()` Returns the last (highest) element in this column.
`int`	`lastIndexOf(Object o)`
`ListIterator<T>`	`listIterator()`
`ListIterator<T>`	`listIterator(int index)`
`T`	`lower(T value)` Returns the greatest element in this column strictly less than the given element, or `null` if there is no such element.
`T`	`remove(int index)`
`boolean`	`remove(Object o)`
`boolean`	`removeAll(Collection<?> c)`
`boolean`	`retainAll(Collection<?> c)`
`T`	`set(int index, T element)`
`int`	`size()`
`EnumColumn<T>`	`subColumn(int fromIndex, int toIndex)` Returns a view of the portion of this column between the specified `fromIndex`, inclusive, and `toIndex`, exclusive.
`EnumColumn<T>`	`subColumnByValue(T fromElement, boolean fromInclusive, T toElement, boolean toInclusive)` Returns a view of the portion of this column whose elements range from `fromElement` to `toElement`.
`EnumColumn<T>`	`subColumnByValue(T fromElement, T toElement)` Same behavior as `Column#subColumn(Object, boolean, Object, Boolean)`, with `fromInclusive` set to true and `toInclusive` set to false.
`List<T>`	`subList(int fromIndex, int toIndex)`
`EnumColumn<T>`	`tail(T fromElement)` Same behavior as `Column.tail(Object, boolean)`, with `inclusive` set to true.
`EnumColumn<T>`	`tail(T 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`.
`Object[]`	`toArray()`
`<E> E[]`	`toArray(E[] a)`
`EnumColumn<T>`	`toDistinct()` Converts a column to a unique index.
`EnumColumn<T>`	`toHeap()` Converts an index into a heap.
`EnumColumn<T>`	`toSorted()` Converts a heap to an index.
`ByteColumn`	`unwrap()` Returns the `ByteColumn` containing the ordinal values.
`static <T extends Enum<T>> EnumColumn<T>`	`wrap(Class<T> enumType, ByteColumn delegate)` Wraps the specified `ByteColumn`, interpreting the `byte` values as ordinals of the specified enum type.

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

Methods inherited from interface tech.bitey.dataframe.Column
append, isDistinct, isNonnull, isSorted, spliterator

Methods inherited from interface java.util.List
replaceAll, sort

Methods inherited from interface java.util.Collection
parallelStream, removeIf, stream

Methods inherited from interface java.lang.Iterable
forEach

- Method Detail
  - wrap
```
public static <T extends Enum<T>> EnumColumn<T> wrap(Class<T> enumType,
                                                     ByteColumn delegate)
```
    Wraps the specified ByteColumn, interpreting the byte values as ordinals of the specified enum type.
    
    Type Parameters:
    
    T - - enum element type
    
    Parameters:
    
    enumType - - the enum element type
    
    delegate - - the ByteColumn containing ordinal values
    
    Returns:
    
    an enum view over the specified ByteColumn
  - unwrap
```
public ByteColumn unwrap()
```
    Returns the ByteColumn containing the ordinal values.
    
    Returns:
    
    the ByteColumn containing the ordinal values.
  - equals
```
public boolean equals(Object o)
```
    Specified by:
    
    equals in interface Collection<T extends Enum<T>>
    
    Specified by:
    
    equals in interface List<T extends Enum<T>>
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface Collection<T extends Enum<T>>
    
    Specified by:
    
    hashCode in interface List<T extends Enum<T>>
    
    Overrides:
    
    hashCode in class Object
  - size
```
public int size()
```
    Specified by:
    
    size in interface Collection<T extends Enum<T>>
    
    Specified by:
    
    size in interface List<T extends Enum<T>>
  - isEmpty
```
public boolean isEmpty()
```
    Specified by:
    
    isEmpty in interface Collection<T extends Enum<T>>
    
    Specified by:
    
    isEmpty in interface List<T extends Enum<T>>
  - contains
```
public boolean contains(Object o)
```
    Specified by:
    
    contains in interface Collection<T extends Enum<T>>
    
    Specified by:
    
    contains in interface List<T extends Enum<T>>
  - get
```
public T get(int index)
```
    Specified by:
    
    get in interface List<T extends Enum<T>>
  - indexOf
```
public int indexOf(Object o)
```
    Specified by:
    
    indexOf in interface List<T extends Enum<T>>
  - lastIndexOf
```
public int lastIndexOf(Object o)
```
    Specified by:
    
    lastIndexOf in interface List<T extends Enum<T>>
  - toArray
```
public Object[] toArray()
```
    Specified by:
    
    toArray in interface Collection<T extends Enum<T>>
    
    Specified by:
    
    toArray in interface List<T extends Enum<T>>
  - toArray
```
public <E> E[] toArray(E[] a)
```
    Specified by:
    
    toArray in interface Collection<T extends Enum<T>>
    
    Specified by:
    
    toArray in interface List<T extends Enum<T>>
  - containsAll
```
public boolean containsAll(Collection<?> c)
```
    Specified by:
    
    containsAll in interface Collection<T extends Enum<T>>
    
    Specified by:
    
    containsAll in interface List<T extends Enum<T>>
  - iterator
```
public Iterator<T> iterator()
```
    Specified by:
    
    iterator in interface Iterable<T extends Enum<T>>
    
    Specified by:
    
    iterator in interface Collection<T extends Enum<T>>
    
    Specified by:
    
    iterator in interface List<T extends Enum<T>>
  - listIterator
```
public ListIterator<T> listIterator()
```
    Specified by:
    
    listIterator in interface List<T extends Enum<T>>
  - listIterator
```
public ListIterator<T> listIterator(int index)
```
    Specified by:
    
    listIterator in interface List<T extends Enum<T>>
  - subList
```
public List<T> subList(int fromIndex,
                       int toIndex)
```
    Specified by:
    
    subList in interface List<T extends Enum<T>>
  - characteristics
```
public int characteristics()
```
    Description copied from interface: Column
    
    Returns the Spliterator.characteristics() for this column.
    
    Specified by:
    
    characteristics in interface Column<T extends Enum<T>>
    
    Returns:
    
    the characteristics for this column
  - toHeap
```
public EnumColumn<T> toHeap()
```
    Description copied from interface: Column
    
    Converts an index into a heap.
    
    Specified by:
    
    toHeap in interface Column<T extends Enum<T>>
    
    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
```
public EnumColumn<T> 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<T extends Enum<T>>
    
    Returns:
    
    a column with elements sorted in ascending order
  - toDistinct
```
public EnumColumn<T> 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<T extends Enum<T>>
    
    Returns:
    
    a column with distinct elements sorted in ascending order
  - getType
```
public ColumnType<T> getType()
```
    Specified by:
    
    getType in interface Column<T extends Enum<T>>
    
    Returns:
    
    this column's type.
  - isNull
```
public boolean isNull(int index)
```
    Description copied from interface: Column
    
    Test if a value is null at a given index.
    
    Specified by:
    
    isNull in interface Column<T extends Enum<T>>
    
    Parameters:
    
    index - the index to test
    
    Returns:
    
    true iff the value at the given index is null
  - subColumn
```
public EnumColumn<T> 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<T extends Enum<T>>
    
    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
  - append
```
public EnumColumn<T> append(Column<T> 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<T extends Enum<T>>
    
    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
```
public EnumColumn<T> 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<T extends Enum<T>>
    
    Returns:
    
    a column equal to this one, but with elements stored in a newly allocated buffer.
  - comparator
```
public Comparator<? super T> comparator()
```
    Description copied from interface: Column
    
    Returns the comparator used to order the elements in this column.
    
    Specified by:
    
    comparator in interface Column<T extends Enum<T>>
    
    Returns:
    
    the comparator used to order the elements in this column.
  - first
```
public T first()
```
    Description copied from interface: Column
    
    Returns the first (lowest) element in this column.
    
    Specified by:
    
    first in interface Column<T extends Enum<T>>
    
    Returns:
    
    the first (lowest) element in this column
  - last
```
public T last()
```
    Description copied from interface: Column
    
    Returns the last (highest) element in this column.
    
    Specified by:
    
    last in interface Column<T extends Enum<T>>
    
    Returns:
    
    the last (highest) element in this column
  - lower
```
public T lower(T value)
```
    Description copied from interface: Column
    
    Returns the greatest element in this column strictly less than the given element, or null if there is no such element.
    
    Specified by:
    
    lower in interface Column<T extends Enum<T>>
    
    Parameters:
    
    value - the value to match
    
    Returns:
    
    the greatest element less than e, or null if there is no such element
  - higher
```
public T higher(T value)
```
    Description copied from interface: Column
    
    Returns the least element in this column strictly greater than the given element, or null if there is no such element.
    
    Specified by:
    
    higher in interface Column<T extends Enum<T>>
    
    Parameters:
    
    value - the value to match
    
    Returns:
    
    the least element greater than e, or null if there is no such element
  - floor
```
public T floor(T value)
```
    Description copied from interface: Column
    
    Returns the greatest element in this column less than or equal to the given element, or null if there is no such element.
    
    Specified by:
    
    floor in interface Column<T extends Enum<T>>
    
    Parameters:
    
    value - the value to match
    
    Returns:
    
    the greatest element less than or equal to e, or null if there is no such element
  - ceiling
```
public T ceiling(T value)
```
    Description copied from interface: Column
    
    Returns the least element in this column greater than or equal to the given element, or null if there is no such element.
    
    Specified by:
    
    ceiling in interface Column<T extends Enum<T>>
    
    Parameters:
    
    value - the value to match
    
    Returns:
    
    the least element greater than or equal to e, or null if there is no such element
  - subColumnByValue
```
public EnumColumn<T> subColumnByValue(T fromElement,
                                      boolean fromInclusive,
                                      T 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<T extends Enum<T>>
    
    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
```
public EnumColumn<T> subColumnByValue(T fromElement,
                                      T 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<T extends Enum<T>>
    
    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
```
public EnumColumn<T> head(T 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<T extends Enum<T>>
    
    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
```
public EnumColumn<T> head(T 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<T extends Enum<T>>
    
    Parameters:
    
    toElement - high endpoint of the returned column
    
    Returns:
    
    a view of the portion of this column whose elements are less than toElement
  - tail
```
public EnumColumn<T> tail(T 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<T extends Enum<T>>
    
    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
```
public EnumColumn<T> tail(T 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<T extends Enum<T>>
    
    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
  - add
```
public boolean add(T e)
```
    Specified by:
    
    add in interface Collection<T extends Enum<T>>
    
    Specified by:
    
    add in interface List<T extends Enum<T>>
  - remove
```
public boolean remove(Object o)
```
    Specified by:
    
    remove in interface Collection<T extends Enum<T>>
    
    Specified by:
    
    remove in interface List<T extends Enum<T>>
  - addAll
```
public boolean addAll(Collection<? extends T> c)
```
    Specified by:
    
    addAll in interface Collection<T extends Enum<T>>
    
    Specified by:
    
    addAll in interface List<T extends Enum<T>>
  - removeAll
```
public boolean removeAll(Collection<?> c)
```
    Specified by:
    
    removeAll in interface Collection<T extends Enum<T>>
    
    Specified by:
    
    removeAll in interface List<T extends Enum<T>>
  - retainAll
```
public boolean retainAll(Collection<?> c)
```
    Specified by:
    
    retainAll in interface Collection<T extends Enum<T>>
    
    Specified by:
    
    retainAll in interface List<T extends Enum<T>>
  - clear
```
public void clear()
```
    Specified by:
    
    clear in interface Collection<T extends Enum<T>>
    
    Specified by:
    
    clear in interface List<T extends Enum<T>>
  - addAll
```
public boolean addAll(int index,
                      Collection<? extends T> c)
```
    Specified by:
    
    addAll in interface List<T extends Enum<T>>
  - set
```
public T set(int index,
             T element)
```
    Specified by:
    
    set in interface List<T extends Enum<T>>
  - add
```
public void add(int index,
                T element)
```
    Specified by:
    
    add in interface List<T extends Enum<T>>
  - remove
```
public T remove(int index)
```
    Specified by:
    
    remove in interface List<T extends Enum<T>>

Class EnumColumn<T extends Enum<T>>

Field Summary

Fields inherited from interface tech.bitey.dataframe.Column

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface tech.bitey.dataframe.Column

Methods inherited from interface java.util.List

Methods inherited from interface java.util.Collection

Methods inherited from interface java.lang.Iterable

Method Detail

wrap

unwrap

equals

hashCode

size

isEmpty

contains

get

indexOf

lastIndexOf

toArray

toArray

containsAll

iterator

listIterator

listIterator

subList

characteristics

toHeap

toSorted

toDistinct

getType

isNull

subColumn

append

copy

comparator

first

last

lower

higher

floor

ceiling

subColumnByValue

subColumnByValue

head

head

tail

tail

add

remove

addAll

removeAll

retainAll

clear

addAll

set

add

remove