databionics.io
Class LrnFile

java.lang.Object
  databionics.io.BaseFile
      databionics.io.Array2DFile
          databionics.io.LrnFile

Direct Known Subclasses:

ArffFile, CsvFile

public class LrnFile
extends Array2DFile

File that stores multivariate data sets in a 2D array.

Field Summary

protected int	classColumnIndex Index of class column.
protected java.lang.String	classColumnName Name of class column.
protected cern.colt.list.IntArrayList	classes Column with class numbers, not stored in the main array.
static int	CLS_COLUMN
static int	DAT_COLUMN
protected cern.colt.list.IntArrayList	defines Type of data columns from header.
static int	KEY_COLUMN
protected int	keyColumnIndex Index of key column.
protected java.lang.String	keyColumnName Name of key column.
protected cern.colt.list.IntArrayList	keys Column with unique keys, not stored in the main array.
protected static org.apache.log4j.Logger	log Log4j logging.
protected StringList	names Names of data columns from header.
static int	NUL_COLUMN constants for column definitions.
protected cern.colt.list.IntArrayList	nullColumns Column to be ignored.

Fields inherited from class databionics.io.Array2DFile

data

Fields inherited from class databionics.io.BaseFile

allowEmptyLines, comment, commentPrefix, delimiter, delimiters, file, header, headerPrefix, loc, nf

Constructor Summary

LrnFile()
Standard constructor

LrnFile(int rows, int cols)
Constructor with size for an empty array.

LrnFile(LrnFile file)
Clone constructor

LrnFile(java.lang.String filename)
Constructor with a filename

Method Summary

protected void	buildHeader() Generate header.
protected java.lang.String	buildLine(int row) Construct a line for saving.
protected void	checkHeader() Check consistency of header information.
cern.colt.matrix.DoubleMatrix1D	getByIndex(int i) Get a datavector by it's keyValue returns DoubleMatrix1D
int	getClassColumnIndex() Get class column index.
java.lang.String	getClassColumnName() Get class column name.
cern.colt.list.IntArrayList	getClasses() Get classes.
cern.colt.list.IntArrayList	getDefines() Get defines.
static FileType	getFileType() Get the type of file.
int	getKeyColumnIndex() Get key column index.
java.lang.String	getKeyColumnName() Get key column nams.
cern.colt.list.IntArrayList	getKeys() Get keys.
StringList	getNames() Get names.
protected void	init(int rows, int cols) Initialize 2D array and class and key columns.
void	initTest()
protected void	parseHeader() Parse the header.
protected void	parseLine(int row, java.lang.String line) Parse a line.
protected void	parseNames(java.lang.String line) Parse line for names with custom delimiters.
void	removeColumn(int col)
void	setClassColumnName(java.lang.String name) Set class column nams.
void	setClasses(int[] classes) Set classes.
void	setClasses(cern.colt.list.IntArrayList classes) Set classes.
void	setDefines() Set automatically generated defines.
void	setDefines(int[] defines) Set defines.
void	setDefines(cern.colt.list.IntArrayList defines) Set defines.
void	setKeyColumnName(java.lang.String name) Set key column nams.
void	setKeys() Add automatically generated keys.
void	setKeys(int[] keys) Set keys.
void	setKeys(cern.colt.list.IntArrayList keys) Set keys.
void	setNames() Set automatically generated names.
void	setNames(StringList names) Set names.

Methods inherited from class databionics.io.Array2DFile

get, getColumns, getData, getRows, getSize, set, setData, setData

Methods inherited from class databionics.io.BaseFile

checkHeaderAgainstSize, getComment, getFile, getFilename, getHeader, getLocale, getNumberFormat, isHeader, isNaN, isNumber, load, load, parseError, save, save, setComment, setFilename, setLocale, writeStringList, writeStringList

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static org.apache.log4j.Logger log

Log4j logging.

NUL_COLUMN

public static final int NUL_COLUMN

constants for column definitions.

See Also:

Constant Field Values

DAT_COLUMN

public static final int DAT_COLUMN

See Also:

Constant Field Values

CLS_COLUMN

public static final int CLS_COLUMN

See Also:

Constant Field Values

KEY_COLUMN

public static final int KEY_COLUMN

See Also:

Constant Field Values

names

protected StringList names

Names of data columns from header.

defines

protected cern.colt.list.IntArrayList defines

Type of data columns from header.

nullColumns

protected cern.colt.list.IntArrayList nullColumns

Column to be ignored.

keys

protected cern.colt.list.IntArrayList keys

Column with unique keys, not stored in the main array.

keyColumnIndex

protected int keyColumnIndex

Index of key column.

keyColumnName

protected java.lang.String keyColumnName

Name of key column.

classes

protected cern.colt.list.IntArrayList classes

Column with class numbers, not stored in the main array.

classColumnIndex

protected int classColumnIndex

Index of class column.

classColumnName

protected java.lang.String classColumnName

Name of class column.

Constructor Detail

LrnFile

public LrnFile()

Standard constructor

LrnFile

public LrnFile(java.lang.String filename)

Constructor with a filename

Parameters:

filename - Name of the file

LrnFile

public LrnFile(int rows,
               int cols)

Constructor with size for an empty array.

Parameters:

rows - Rows of data array.

cols - Columns of data array.

LrnFile

public LrnFile(LrnFile file)

Clone constructor

Method Detail

parseNames

protected void parseNames(java.lang.String line)

Parse line for names with custom delimiters.

initTest

public void initTest()

parseHeader

protected void parseHeader()

Parse the header.

Overrides:

parseHeader in class BaseFile

init

protected void init(int rows,
                    int cols)

Initialize 2D array and class and key columns.

Overrides:

init in class Array2DFile

Parameters:

rows - Rows of data array.

cols - Columns of data array.

parseLine

protected void parseLine(int row,
                         java.lang.String line)

Parse a line.

Overrides:

parseLine in class Array2DFile

Parameters:

row - Number of current line.

line - Current line.

checkHeader

protected void checkHeader()

Check consistency of header information.

Overrides:

checkHeader in class BaseFile

buildHeader

protected void buildHeader()

Generate header.

Overrides:

buildHeader in class Array2DFile

buildLine

protected java.lang.String buildLine(int row)

Construct a line for saving.

Overrides:

buildLine in class Array2DFile

Parameters:

row - Number of current line.

Returns:

Line with that number.

getNames

public StringList getNames()

Get names.

setNames

public void setNames(StringList names)

Set names.

setNames

public void setNames()

Set automatically generated names.

getDefines

public cern.colt.list.IntArrayList getDefines()

Get defines.

setDefines

public void setDefines(cern.colt.list.IntArrayList defines)

Set defines.

setDefines

public void setDefines(int[] defines)

Set defines.

removeColumn

public void removeColumn(int col)

setDefines

public void setDefines()

Set automatically generated defines.

getKeyColumnIndex

public int getKeyColumnIndex()

Get key column index.

getKeyColumnName

public java.lang.String getKeyColumnName()

Get key column nams.

setKeyColumnName

public void setKeyColumnName(java.lang.String name)

Set key column nams.

getKeys

public cern.colt.list.IntArrayList getKeys()

Get keys.

setKeys

public void setKeys(cern.colt.list.IntArrayList keys)

Set keys.

setKeys

public void setKeys(int[] keys)

Set keys.

setKeys

public void setKeys()

Add automatically generated keys.

getClassColumnIndex

public int getClassColumnIndex()

Get class column index.

getClassColumnName

public java.lang.String getClassColumnName()

Get class column name.

setClassColumnName

public void setClassColumnName(java.lang.String name)

Set class column nams.

getClasses

public cern.colt.list.IntArrayList getClasses()

Get classes.

setClasses

public void setClasses(cern.colt.list.IntArrayList classes)

Set classes.

setClasses

public void setClasses(int[] classes)

Set classes.

getFileType

public static FileType getFileType()

Get the type of file.

getByIndex

public cern.colt.matrix.DoubleMatrix1D getByIndex(int i)

Get a datavector by it's keyValue returns DoubleMatrix1D