miralib.data

Class Variable

java.lang.Object

miralib.data.Variable

All Implemented Interfaces:

DataTree.Item

Direct Known Subclasses:

CategoricalVariable, DateVariable, NumericalVariable, StringVariable

public abstract class Variable
extends java.lang.Object
implements DataTree.Item

Class holding all the meta-information needed to define a variable in the dataset (name, alias, min/max range, etc.)

Field Summary

Fields

Modifier and Type	Field and Description
static int	EXPONENTIAL
static int	LINEAR
static int	UNDEFINED

Constructor Summary

Constructors

Constructor and Description
Variable(java.lang.String name, int index)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canOpen()
abstract boolean	categorical()
boolean	column()
boolean	covariate()
static Variable	create(int index, java.lang.String name, int type)
abstract Range	createRange(double val0, double val1)
abstract boolean	discrete()
java.lang.String	formatRange()
java.lang.String	formatRange(boolean humanReadable)
java.lang.String	formatRange(Range sel)
abstract java.lang.String	formatRange(Range sel, boolean humanReadable)
static java.lang.String	formatType(int type)
abstract java.lang.String	formatValue(double value, boolean normalized)
java.lang.String	formatValue(double value, DataRanges ranges)
abstract java.lang.String	formatValue(double value, Range sel)
abstract java.lang.String	formatValue(TableRow row)
java.lang.String	getAlias()
int	getColumnSelection()
long	getCount()
long	getCount(DataRanges ranges)
long	getCount(Range sel)
int	getFirstChild()
int	getIndex()
int	getItemType()
int	getLastChild()
java.lang.String	getName()
int	getScaling(DataSlice1D slice)
static int	getType(java.lang.String name)
double	getValue(java.lang.String str)
abstract double	getValue(java.lang.String str, boolean normalized)
double	getValue(TableRow row, DataRanges ranges)
double	getValue(TableRow row, Range sel)
abstract double	getValue(TableRow row, Range sel, boolean normalized)
java.util.ArrayList<java.lang.String>	getValues()
double	getWeight(TableRow row)
static double	getWeight(TableRow row, Variable varx, Variable vary)
boolean	include()
void	initRange(Table data)
abstract void	initValues(java.lang.String valstr)
boolean	insideSample(TableRow row)
boolean	matchAlias(java.lang.String query)
boolean	matchName(java.lang.String query)
boolean	maxRange(Range sel)
abstract boolean	missing(TableRow row)
double	normalize(double value)
double	normalize(float value)
double	normalize(int value)
double	normalize(long value)
abstract boolean	numerical()
boolean	open()
void	setAlias(java.lang.String alias)
void	setClose()
void	setColumnSelection(int sel)
static void	setMissingString(java.lang.String str)
void	setOpen()
void	setSubsample()
void	setWeight()
void	setWeightVariable(Variable var)
double	snapValue(double value, Range sel)
abstract double	snapValue(double value, Range sel, boolean normalized)
boolean	sortKey()
abstract boolean	string()
boolean	subsample()
abstract int	type()
abstract boolean	valueAlias(java.lang.String value)
boolean	weight()
boolean	weighted()

Methods inherited from class java.lang.Object

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

Field Detail

UNDEFINED

public static final int UNDEFINED

See Also:

Constant Field Values

LINEAR

public static final int LINEAR

See Also:

Constant Field Values

EXPONENTIAL

public static final int EXPONENTIAL

See Also:

Constant Field Values

Constructor Detail

Variable

public Variable(java.lang.String name,
        int index)

Method Detail

create

public static Variable create(int index,
              java.lang.String name,
              int type)

setMissingString

public static void setMissingString(java.lang.String str)

createRange

public abstract Range createRange(double val0,
                double val1)

initRange

public void initRange(Table data)

getScaling

public int getScaling(DataSlice1D slice)

initValues

public abstract void initValues(java.lang.String valstr)

getItemType

public int getItemType()

Specified by:

getItemType in interface DataTree.Item

getName

public java.lang.String getName()

Specified by:

getName in interface DataTree.Item

getFirstChild

public int getFirstChild()

Specified by:

getFirstChild in interface DataTree.Item

getLastChild

public int getLastChild()

Specified by:

getLastChild in interface DataTree.Item

canOpen

public boolean canOpen()

Specified by:

canOpen in interface DataTree.Item

open

public boolean open()

Specified by:

open in interface DataTree.Item

setOpen

public void setOpen()

Specified by:

setOpen in interface DataTree.Item

setClose

public void setClose()

Specified by:

setClose in interface DataTree.Item

getColumnSelection

public int getColumnSelection()

Specified by:

getColumnSelection in interface DataTree.Item

setColumnSelection

public void setColumnSelection(int sel)

Specified by:

setColumnSelection in interface DataTree.Item

getIndex

public int getIndex()

include

public boolean include()

column

public boolean column()

covariate

public boolean covariate()

sortKey

public boolean sortKey()

setAlias

public void setAlias(java.lang.String alias)

getAlias

public java.lang.String getAlias()

matchName

public boolean matchName(java.lang.String query)

matchAlias

public boolean matchAlias(java.lang.String query)

type

public abstract int type()

discrete

public abstract boolean discrete()

numerical

public abstract boolean numerical()

categorical

public abstract boolean categorical()

string

public abstract boolean string()

getCount

public long getCount()

getCount

public long getCount(DataRanges ranges)

getCount

public long getCount(Range sel)

missing

public abstract boolean missing(TableRow row)

maxRange

public boolean maxRange(Range sel)

getValues

public java.util.ArrayList<java.lang.String> getValues()

getValue

public double getValue(java.lang.String str)

getValue

public abstract double getValue(java.lang.String str,
              boolean normalized)

getValue

public double getValue(TableRow row,
              DataRanges ranges)

getValue

public double getValue(TableRow row,
              Range sel)

getValue

public abstract double getValue(TableRow row,
              Range sel,
              boolean normalized)

formatValue

public abstract java.lang.String formatValue(TableRow row)

formatValue

public abstract java.lang.String formatValue(double value,
                           boolean normalized)

formatValue

public java.lang.String formatValue(double value,
                           DataRanges ranges)

formatValue

public abstract java.lang.String formatValue(double value,
                           Range sel)

valueAlias

public abstract boolean valueAlias(java.lang.String value)

snapValue

public double snapValue(double value,
               Range sel)

snapValue

public abstract double snapValue(double value,
               Range sel,
               boolean normalized)

formatRange

public java.lang.String formatRange()

formatRange

public java.lang.String formatRange(boolean humanReadable)

formatRange

public java.lang.String formatRange(Range sel)

formatRange

public abstract java.lang.String formatRange(Range sel,
                           boolean humanReadable)

normalize

public double normalize(int value)

normalize

public double normalize(long value)

normalize

public double normalize(float value)

normalize

public double normalize(double value)

weight

public boolean weight()

setWeight

public void setWeight()

subsample

public boolean subsample()

setSubsample

public void setSubsample()

setWeightVariable

public void setWeightVariable(Variable var)

weighted

public boolean weighted()

getWeight

public double getWeight(TableRow row)

insideSample

public boolean insideSample(TableRow row)

getType

public static int getType(java.lang.String name)

formatType

public static java.lang.String formatType(int type)

getWeight

public static double getWeight(TableRow row,
               Variable varx,
               Variable vary)