de.unknownreality.dataframe.index

Class TreeIndex

java.lang.Object

de.unknownreality.dataframe.index.TreeIndex

All Implemented Interfaces:

Index

public class TreeIndex
extends Object
implements Index

Created by Alex on 27.05.2016.

Constructor Summary

Constructors

Constructor and Description
TreeIndex(String indexName, boolean unique, DataFrameColumn... columns) Creates a multi index using more that one column
TreeIndex(String indexName, DataFrameColumn... columns)

Method Summary

Modifier and Type	Method and Description
void	clear() Clears this index
boolean	containsColumn(DataFrameColumn column) Returns true if this index contains the specified column
Collection<Integer>	find(Comparable... values) Returns the row number for values used in this index
List<DataFrameColumn>	getColumns() Returns the columns used in this index
String	getName() Returns the name if this index
boolean	isUnique() Returns true if this index is unique
void	remove(DataRow dataRow) removes a DataRow from this index
void	replaceColumn(DataFrameColumn existing, DataFrameColumn replacement)
void	setUnique(boolean unique) set true if only unique values are allowed for this index
void	update(DataRow dataRow) updates a DataRow in this index

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TreeIndex

public TreeIndex(String indexName,
                 boolean unique,
                 DataFrameColumn... columns)

Creates a multi index using more that one column

Parameters:

indexName - name of index

unique - defines whether this index only allows unique values

columns - index columns

TreeIndex

public TreeIndex(String indexName,
                 DataFrameColumn... columns)

Method Detail

setUnique

public void setUnique(boolean unique)

Description copied from interface: Index

set true if only unique values are allowed for this index

Specified by:

setUnique in interface Index

Parameters:

unique - allow only unique values

getName

public String getName()

Description copied from interface: Index

Returns the name if this index

Specified by:

getName in interface Index

Returns:

name of index

clear

public void clear()

Description copied from interface: Index

Clears this index

Specified by:

clear in interface Index

containsColumn

public boolean containsColumn(DataFrameColumn column)

Description copied from interface: Index

Returns true if this index contains the specified column

Specified by:

containsColumn in interface Index

Parameters:

column - column to tes t

Returns:

true if column is contained in this index

isUnique

public boolean isUnique()

Description copied from interface: Index

Returns true if this index is unique

Specified by:

isUnique in interface Index

Returns:

true if this index is unique

replaceColumn

public void replaceColumn(DataFrameColumn existing,
                          DataFrameColumn replacement)

Specified by:

replaceColumn in interface Index

getColumns

public List<DataFrameColumn> getColumns()

Description copied from interface: Index

Returns the columns used in this index

Specified by:

getColumns in interface Index

Returns:

columns in this index

update

public void update(DataRow dataRow)

Description copied from interface: Index

updates a DataRow in this index

Specified by:

update in interface Index

Parameters:

dataRow - data row to update

remove

public void remove(DataRow dataRow)

Description copied from interface: Index

removes a DataRow from this index

Specified by:

remove in interface Index

Parameters:

dataRow - data row to remove

find

public Collection<Integer> find(Comparable... values)

Description copied from interface: Index

Returns the row number for values used in this index

Specified by:

find in interface Index

Parameters:

values - indexed row values

Returns:

index of row with the input value