Variable

java.lang.Object
- java.util.AbstractCollection<E>
- - java.util.AbstractList<E>
  - - java.util.Vector<java.lang.Object>
    - - com.lobsterman.JavaGrinders.Variable

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<java.lang.Object>, java.util.Collection<java.lang.Object>, java.util.List<java.lang.Object>, java.util.RandomAccess

Direct Known Subclasses:

BooleanVariable, NumberVariable, StrVariable
```
public class Variable
extends java.util.Vector<java.lang.Object>
implements java.lang.Cloneable
```
handles things that a general variable should do or know about. It is based on the Vector class. This class can query and set the number of entries in the array, find selected rows for analysis using a variety of criteria, list the content, report descriptive statistics, identify how many unique IDs there are, compares these with other IDs, and reports them, etc.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`boolean`	`autoExtracted`
`boolean`	`hasDefaultColors`
`boolean`	`isSorted`
`Descriptives`	`itsDescriptives`
`java.lang.String`	`itsFormula`
`java.awt.Color`	`itsLineColor`
`java.awt.Color`	`itsLocationColor`
`static int`	`kEuclidian`
`static int`	`kGower`
`static int`	`kJaccard`
`static int`	`kManhattan`
`static int`	`kSquEuclidian`
`boolean`	`plotMarker`
`com.lobsterman.JavaGrinders.RHUtilities.RHRandomNumberGenerator`	`rand`

Fields inherited from class java.util.Vector
capacityIncrement, elementCount, elementData

Fields inherited from class java.util.AbstractList
modCount

Constructor Summary

Constructors
Constructor and Description
`Variable()` empty constructor for the root Variable class
`Variable(java.lang.String varName, VariableOrganizer theOwner)` Standard constructor for the root Variable class using a VariableOrganizer

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addValue(double aDouble)` appends a number to the end of the Variable
`void`	`addValue(float aFloat)` appends a number to the end of the Variable
`void`	`addValue(int anInt)` appends a number to the end of the Variable
`void`	`addValue(java.lang.Object anObject)` appends an Object to the end of the Variable
`void`	`append(java.lang.Object[] theData)` appends the variable to the end of the variable
`com.lobsterman.JavaGrinders.Jama.Matrix`	`asJAMAMatrix()` returns a matrix for the variables in the variableorganizer which have been selected as dependent variables (i.e., VariableDesignRole.Y) and which are ordinal or nominal
`VariableOrganizer`	`asVariableOrganizer()` returns the variable as a variable organizer filled with this variable
`boolean`	`checkAllUseRows()` examines whether all rows contain valid and selected data
`void`	`checkLocked()` examine whether this variables is locked
`boolean`	`checkMatchingRows(ContingencyTable aMat)` examine whether this variables has the same number of rows as the provided ContingencyTable
`boolean`	`checkMinUseRows(int minRows)` examines whether a minimum number rows is selected
`void`	`checkNumberIDs(int compareTo)` checks whether there is a given number of distinct IDs present in the currently selected set of rows
`void`	`checkSameIDs(Variable theOtherVariable)` checks whether two variables have identical sets of distinct IDs in the currently selected set of rows
`boolean`	`checkSameNRows(Variable theVar)` examines whether the variable has the same number of rows as another variable
`boolean`	`checkSameNSelectRows(Variable theVar)` examines whether the same rows are selected as in another variable
`boolean`	`checkSameSelectRows(Variable theVar)` examines whether the same rows are selected as in another variable
`boolean`	`checkSameSelectRows(VariableOrganizer theVarOrganizer)` examines whether the same rows are selected as in another variable
`boolean`	`checkSameUseRows(Variable theVar)` examines whether the same rows are selected and not missing as in another variable
`boolean`	`checkSameUseRows(VariableOrganizer theVarOrganizer)` examines whether the same rows are selected and not missing as in another variable
`boolean`	`checkValidRowRange(int row)` checks whether a given row is within a valid range
`java.lang.Object`	`clone()` clone the object
`Variable`	`cloneSelectedRowsOnly()` returns a clone of the Variable with selected rows only
`void`	`cloneVariableFrom(Variable aVar)` fills the variable as a clone of the variable
`void`	`combineSelectedWithSavedSelectedRows()` combines the current set of selected rows with that set that has been saved earlier using saveSelectedRows()
`Descriptives`	`copyDescriptives()` returns the descriptives for the variable
`void`	`copySelectStateFrom(Variable aVar)` sets the select flag for all rows based on select state of another variable
`void`	`customColorFromData(NumberVariable aVar, java.awt.Color baseColor)` sets a custom colors for all selected rows
`void`	`customColorSelectedRows(java.awt.Color aColor)` sets a custom colors for all selected rows
`void`	`customColorSelectedRows(java.awt.Color aColor, boolean resetOtherColors)` sets a custom colors for all selected rows
`void`	`deleteAllRows()` delete all rows from the Variable
`void`	`deleteDuplicateRows()` deletes duplicate rows
`void`	`deleteMissingRows()` deletes all missing rows
`void`	`deleteNonSelectedRows()` delete all non-selected rows
`void`	`deleteRow(int row)` delete a row from the Variable
`void`	`deleteRowNoCheck(int row)` delete a row from the Variable without coordinating a VartiableOrganizer
`void`	`deleteSelectedRows()` deletes all selected rows
`void`	`deselectAllRows()` sets the select flag for all rows to false
`Variable`	`fill(double[] theData)` fills the variable with individual datavalues from a double array
`Variable`	`fill(int[] theData)` fills the variable with individual datavalues from a double array
`void`	`fill(int nRows, double aValue)` fills the variable with a constant
`void`	`fill(int nRows, java.lang.Object aValue)` fills the variable with the given value in every row.
`Variable`	`fill(java.lang.Object[] theData)` fills the variable with the given value in every row.
`Variable`	`fill(java.lang.Object[] theData, boolean ascending)` fills the variable with the given value in every row.
`void`	`fillDescriptives()` fills the descriptive statistics for the variable, at the root level only a check for valid data points is performed
`void`	`fillDescriptives(java.lang.Double hypVal)` fills the descriptive statistics for the variable, at the root level only a check for valid data points is performed
`void`	`fillMoreDescriptives()` fills additional descriptive statistics for the variable
`void`	`fillWithParser(DataFileParser aParser, int varNum)` fills the variable with individual datavalues read from a textfile using a DataFileParser object.
`void`	`fillWithParser(DataFileParser aParser, int varNum, boolean firstRowAsLabels)` fills the variable with individual datavalues read from a textfile using a DataFileParser object.
`void`	`fillWithVariable(Variable aVar)` fills the variable as a clone of the variable
`int`	`findFirstSelectRow()` returns the first selected row of the variable
`int`	`findFirstUseRow()` returns the first selected row of the variable
`int`	`findLastSelectRow()` returns the last selected row of the variable
`int`	`findLastUseRow()` returns the last selected row of the variable
`int`	`findNextNonMissingRow(int startSearchAt)` returns the next selected row after a given row
`int`	`findNextSelectRow(int startSearchAt)` returns the next selected row after a given row
`int`	`findNextUseRow(int startSearchAt)` returns the next selected row after a given row
`int`	`findNextValue(int startSearchAt, java.lang.Object aValue)` returns the next selected row after a given row
`int`	`findPreviousSelectRow(int startSearchAt)` returns the next lower selected row before a given row
`int`	`findPreviousUseRow(int startSearchAt)` returns the next lower selected row before a given row
`int`	`getabasedintValue(int row)` returns the instance of char stored at a given row of the Vector and converts it into an integer starting with 0 at a char of 'a'
`int`	`getAbasedintValue(int row)` returns the instance of char stored at a given row of the Vector and converts it into an integer starting with 0 at a char of 'A'
`java.lang.Object[]`	`getArray(boolean validRows)` returns an array of double values of the Vector
`boolean`	`getbooleanValue(int row)` returns the value stored at a given row of the Vector as a boolean
`char`	`getcharValue(int row)` returns the instance of char stored at a given row in the Vector
`java.util.TreeMap<java.lang.Object,java.lang.Integer>`	`getCombinedIDs(Variable theOtherVariable)` returns a TreeMap containing all different values found in either this variable using the currently selected set of rows or in the selected rows of a second variable
`ContingencyTable`	`getCrossTabulation(Variable theXVariable, boolean sameIDs, boolean includeDiagonal)` returns a crosstabulation of values for two variables in form of a matrix
`ContingencyTable`	`getCrossTabulation(Variable theXVariable, java.util.TreeMap<java.lang.Object,java.lang.Integer> xHash, java.util.TreeMap<java.lang.Object,java.lang.Integer> yHash, boolean includeDiagonal)` returns a crosstabulation of values for two variables in form of a matrix
`java.awt.Color`	`getCustomColorRow(int row)` returns the custom color for a given row
`Descriptives`	`getDescriptives()` returns the descriptives for the variable
`double[]`	`getdoubleArray(boolean validRows)` returns an array of double values of the Vector
`double`	`getdoubleValue(int row)` returns the value stored at a given row of the Vector as a double
`java.lang.Double`	`getDoubleValue(int row)` returns the value stored at a given row of the Vector as a double
`float`	`getfloatValue(int row)` returns the value stored at a given row of the Vector as a float
`int[]`	`getFrequencies()` returns the frequencies for different instances of the variable using the currently selected set of rows up to the specified number of maxInstances
`java.awt.Color`	`getHighliteColor()` returns the highlite color for the animal
`boolean`	`getHighlitedRow(int row)` returns whether a given row is currently highlited.
`java.util.TreeMap<java.lang.Object,java.lang.Integer>`	`getIDMap()` returns a TreeMap containing all different values found in the variable using the currently selected set of rows
`java.lang.Object[]`	`getIDs()` returns a TreeMap containing all different values found in the variable using the currently selected set of rows
`java.lang.String`	`getIDString(int theIndex)` returns a single entry for a key in the TreeMap as a String
`java.lang.String[]`	`getIDStrings()` returns the keys in the TreeMap as strings
`InteractionTable`	`getInteractions(Variable theXVariable)` returns a crosstabulation of values for two variables in form of an interaction matrix
`int`	`getintValue(int row)` returns the value stored at a given row of the Vector as an int
`double`	`getJaccard(Variable aVar)` returns the Manhattan proximity measure to another variable
`java.awt.Color`	`getLineColor()` returns the line color for the variable
`java.awt.Color`	`getLocationColor()` returns the location color for the variable
`long`	`getlongValue(int row)` returns the instance of long stored at a given row in the Vector
`double`	`getManhattan(Variable aVar)` returns the Manhattan proximity measure to another variable
`boolean`	`getMissingRow(int row)` returns whether a given row is currently missing.
`java.lang.String`	`getName()` returns the name of the Variable
`int`	`getNIDs()` returns the number of different values present in the currently selected set of rows
`int`	`getNMissingRows()` returns the number of missing rows in the currently selected set
`java.lang.String`	`getNotes()` returns the Notes of the Variable
`int`	`getNRows()` returns the number of rows in the Variable
`int`	`getNSelectRows()` returns the number of currently selected rows for the variable
`int`	`getNUseRows()` returns the number of currently selected rows for the variable which do not have missing values
`VariableOrganizer`	`getOrganizer()` returns the VariableOrganizer for the Variable
`double`	`getProximity(Variable aVar)` returns the proximity measure to another variable
`double`	`getProximity(Variable aVar, int proxType)` returns the proximity measure to another variable
`java.lang.Object`	`getRandomValue()` returns the object stored at a randomly selected row of the Vector
`NumberVariable`	`getRowNumbers()` returns the number of currently selected rows for the variable
`java.util.Vector<java.lang.Object>`	`getRowOrder()` returns the row order for the Variable
`double`	`getRowOrderRow(int row)` returns the row order
`boolean`	`getSelectRow(int row)` returns whether a given row is currently selected.
`java.lang.String[]`	`getStringArray(boolean selected)` returns the object stored at a given row of the Vector as a String
`java.lang.String`	`getStringValue(int row)` returns the object stored at a given row of the Vector as a String
`ContingencyTable`	`getTransitions()` returns the transitions among consecutive values in form of a matrix
`boolean`	`getUseRow(int row)` returns whether a given row can be used.
`java.lang.Object`	`getValue(int row)` returns the object stored at a given row of the Vector
`int`	`getVariableDesignRole()` returns the variable design role
`java.lang.String`	`getVariableDesignRoleString()` returns the variable design role as a character string
`int`	`getVariableFormat()` returns the variable format
`int`	`getVariableType()` returns the variable type
`void`	`highliteSelectedRows()` highlites the selected rows only
`void`	`highliteSelectedRows(boolean addToPreviousSet)` highlites all selected rows
`void`	`invalidDescriptives()` descriptive statistics need to be updated
`void`	`invertSelectedRows()` invert select rows
`boolean`	`isAngleType()` returns whether the variable is of type ANGLES
`boolean`	`isContinuousType()` returns whether the variable is of type CONTINUOUS
`boolean`	`isDateTimeFormat()` returns whether the variable is of type DATETIME
`boolean`	`isLocationType()` returns whether the variable is of type LOCATIONS
`boolean`	`isLocked()` returns whether a variable is locked for further selections, modifications, etc.
`boolean`	`isNominalType()` returns whether the variable is of type NOMINAL
`boolean`	`isNumberFormat()` returns whether the variable is of type NUMBER
`boolean`	`isOrdinalType()` returns whether the variable is of type ORDINAL
`boolean`	`isStringFormat()` returns whether the variable is of type STRING
`boolean`	`isValidRowRange(int row)` checks whether a given row is within a valid range
`boolean`	`isXVariable()` is the variable selected as an independent variable
`boolean`	`isYVariable()` is the variable selected as a dependent variable
`void`	`listDescriptives()` lists the descriptive statistics for the variable using the currently selected set of rows
`void`	`listDescriptives(java.lang.Double hypMean)` lists the descriptive statistics for the variable using the currently selected set of rows
`void`	`listGroupDescriptives(Variable theXVariable)` lists the descriptives for the groups identified by X
`void`	`listGroupDescriptivesNoDia(Variable theXVariable)` lists the descriptives for the groups identified by X
`void`	`listRow(int row)` lists data value for a single row
`void`	`listRowOrder(int startLine, int endLine, boolean selectedOnly)` lists data values for a range of rows
`void`	`listRows()` lists all data values in the variable
`void`	`listRows(boolean selectedOnly)` lists all data values in the variable
`void`	`listRows(int startLine, int endLine)` lists data values for a range of rows regardless of selection
`void`	`listRows(int startLine, int endLine, boolean selectedOnly)` lists data values for a range of rows
`void`	`listSelectedRows()` lists data values for all selected rows in the variable
`void`	`listSelectState()` lists for each row whether it is selected or not
`void`	`listSelectState(int startLine, int endLine)` lists for a range of rows whether it is selected or not
`void`	`listUseRows()` lists data values for all selected rows in the variable
`void`	`makeNewDescriptives()` create a new set of descriptives for the variable the object
`ContingencyTable`	`makeTableSubSet(ContingencyTable aTable)` returns a subset of row data values for the ContingencyTable as a ContingencyTable.
`boolean`	`matchedIDs(java.util.TreeMap<java.lang.Object,java.lang.Integer> theOtherIDs)` returns whether there is a value in this variable that is not present in a given TreeMap
`void`	`replaceSelectedRows(java.lang.Object whichValue)` sets the select flag for all rows based on select state of another variable
`void`	`restoreSelectedRows()` restores the select flag for all rows from a previously saved set
`void`	`restrictToMatchingUseRows(Variable aVar)` restricts the select flag to those rows that are usable in both variables
`void`	`restrictToMatchingUseRows(VariableOrganizer aVarOrg)` restricts the use flag to those rows that are usable in the variables as well as in the Organizer
`void`	`restrictToValidRowsOnly()` sets the select flag for all valid (non-missing) rows to true
`void`	`reverseRows(int a1, int a2, boolean checkForOrganizer)` reverses the values of two given rows
`void`	`saveRowsToFile(int startLine, int endLine, boolean selectedOnly, java.lang.String name)` saves data values for a range of rows to a text file
`void`	`saveRowsToFile(java.lang.String name)` saves all data values to a text file
`void`	`saveSelectedRows()` saves the select flag for all currently selected rows
`void`	`selectAllRows()` sets the select flag for all rows to true
`void`	`selectDuplicateRows()` sets the select flag for all duplicate rows
`void`	`selectEveryNthRow(int n)` sets the select flag for every nth row to true
`void`	`selectRows(int start, int end)` sets the select flag for all rows to true
`void`	`selectUseRows()` restricts the select flag to those rows that are usable in both variables
`void`	`selectValue(java.lang.Object whichValue, boolean fromPrevSelected)` selects rows that match a given object from the currently selected set of rows
`void`	`setAnglesType()` sets the variable to type ANGLES
`void`	`setCustomColorRow(int row, java.awt.Color aColor)` sets the custom color for a given row
`void`	`setFormula(java.lang.String aFormula)` sets a formula for a given vector
`void`	`setHighliteColor(java.awt.Color aColor)` sets a highlite color for the animal
`void`	`setHighlitedRow(int row, boolean highlite)` sets the highlite flag for a given row
`void`	`setLineColor(java.awt.Color aColor)` sets a line color for the animal
`void`	`setLocationColor(java.awt.Color aColor)` sets a location color for the animal
`void`	`setLocationsType()` sets the variable to type LOCATIONS
`void`	`setLock(boolean lock)` sets whether a variable is locked for further selections, modifications, etc.
`void`	`setMissingRow(int row, boolean missing)` sets the missing flag for a given row
`void`	`setName(java.lang.String varName)` sets the name of the variable to the String provided
`void`	`setNominalType()` sets the variable to type NOMINAL
`void`	`setNotes(java.lang.String varNotes)` sets the notes for the variable
`void`	`setNRows(int rows)` sets the number of rows for the Variable
`void`	`setOrdinalType()` sets the variable to type ORDINAL
`void`	`setOrganizer(VariableOrganizer theOrganizer)` sets a VariableOrganizer for the Variable
`void`	`setRowOrder(java.util.Vector<java.lang.Object> rowOrder)` sets the rowOrder for the variable
`void`	`setRowOrderRow(int row, double rowNum)` sets the number of rows for the Variable
`void`	`setSelectRow(int row, boolean select)` sets the select flag for a given row
`void`	`setSelectRows(java.lang.Object aVal)` sets all selected rows to a particular value
`void`	`setSelectRowsToMissing()` sets all selected rows to missing
`void`	`setValue(int row, boolean aBoolean)` sets a boolean value for a given row of the Vector
`void`	`setValue(int row, char aChar)` sets a char value for a given row in the Vector
`void`	`setValue(int row, double aDouble)` sets a double value for a given row of the Vector
`void`	`setValue(int row, float aFloat)` sets a float value for a given row of the Vector
`void`	`setValue(int row, int aInt)` sets an integer value for a given row of the Vector
`void`	`setValue(int row, java.lang.Object anObject)` sets a general object for a given row of the Vector
`void`	`setVariableDesignRole(int vDesignRole)` sets the design role for the variable
`void`	`setVariableFormat(int vFormat)` sets the variable format
`void`	`setVariableType(int vType)` sets the variable type
`Variable`	`sort()` sorts the values for all rows using a map of hashcodes
`Variable`	`sort(boolean ascending)` sorts the values for all rows using a map of hashcodes
`Variable`	`sort2(boolean ascending)` sorts the values for all rows using a map of hashcodes
`void`	`updateRowOrder()` updates the row order for the variable

Methods inherited from class java.util.Vector
add, add, addAll, addAll, addElement, capacity, clear, contains, containsAll, copyInto, elementAt, elements, ensureCapacity, equals, firstElement, forEach, get, hashCode, indexOf, indexOf, insertElementAt, isEmpty, iterator, lastElement, lastIndexOf, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeAllElements, removeElement, removeElementAt, removeIf, removeRange, replaceAll, retainAll, set, setElementAt, setSize, size, sort, spliterator, subList, toArray, toArray, toString, trimToSize

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

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

- Field Detail
  - kSquEuclidian
```
public static final int kSquEuclidian
```
    See Also:
    
    Constant Field Values
  - kEuclidian
```
public static final int kEuclidian
```
    See Also:
    
    Constant Field Values
  - kManhattan
```
public static final int kManhattan
```
    See Also:
    
    Constant Field Values
  - kJaccard
```
public static final int kJaccard
```
    See Also:
    
    Constant Field Values
  - kGower
```
public static final int kGower
```
    See Also:
    
    Constant Field Values
  - rand
```
public com.lobsterman.JavaGrinders.RHUtilities.RHRandomNumberGenerator rand
```
  - itsDescriptives
```
public Descriptives itsDescriptives
```
  - isSorted
```
public boolean isSorted
```
  - itsFormula
```
public java.lang.String itsFormula
```
  - autoExtracted
```
public boolean autoExtracted
```
  - hasDefaultColors
```
public boolean hasDefaultColors
```
  - itsLocationColor
```
public java.awt.Color itsLocationColor
```
  - itsLineColor
```
public java.awt.Color itsLineColor
```
  - plotMarker
```
public boolean plotMarker
```
- Constructor Detail
  - Variable
```
public Variable()
         throws java.lang.Exception
```
    empty constructor for the root Variable class
    
    Throws:
    
    java.lang.Exception
  - Variable
```
public Variable(java.lang.String varName,
                VariableOrganizer theOwner)
         throws java.lang.Exception
```
    Standard constructor for the root Variable class using a VariableOrganizer
    
    Parameters:
    
    varName - assigns a name (String) to the variable
    
    theOwner - an instance of VariableOrganizer class coordinates a set of variables with respect to number of data points available and the rows that are currently selected
    
    Throws:
    
    java.lang.Exception
- Method Detail
  - cloneVariableFrom
```
public void cloneVariableFrom(Variable aVar)
```
    fills the variable as a clone of the variable
    
    Parameters:
    
    aVar - the variable to clone
  - cloneSelectedRowsOnly
```
public Variable cloneSelectedRowsOnly()
                               throws java.lang.Exception
```
    returns a clone of the Variable with selected rows only
    
    Returns:
    
    the cloned variable
    
    Throws:
    
    java.lang.Exception - if ...
  - clone
```
public java.lang.Object clone()
```
    clone the object
    
    Overrides:
    
    clone in class java.util.Vector<java.lang.Object>
    
    Returns:
    
    the cloned variable
  - setNRows
```
public void setNRows(int rows)
              throws java.lang.Exception
```
    sets the number of rows for the Variable
    
    Parameters:
    
    rows - new number of rows for the variable
    
    Throws:
    
    java.lang.Exception - if ...
  - getNRows
```
public int getNRows()
```
    returns the number of rows in the Variable
    
    Returns:
    
    number of rows in the variable
  - setOrganizer
```
public void setOrganizer(VariableOrganizer theOrganizer)
```
    sets a VariableOrganizer for the Variable
    
    Parameters:
    
    theOrganizer - an instance of VariableOrganizer class coordinates a set of variables with respect to number of data points available and the rows that are currently selected
  - getOrganizer
```
public VariableOrganizer getOrganizer()
```
    returns the VariableOrganizer for the Variable
    
    Returns:
    
    the variable's VariableOrganizer
  - setLock
```
public void setLock(boolean lock)
```
    sets whether a variable is locked for further selections, modifications, etc.
    
    Parameters:
    
    lock - marks whether a variable will be locked
  - isLocked
```
public boolean isLocked()
```
    returns whether a variable is locked for further selections, modifications, etc.
    
    Returns:
    
    whether variable is locked
  - setFormula
```
public void setFormula(java.lang.String aFormula)
                throws java.lang.Exception
```
    sets a formula for a given vector
    
    Parameters:
    
    aFormula - the formula to use
    
    Throws:
    
    java.lang.Exception - if ...
  - setNominalType
```
public void setNominalType()
                    throws java.lang.Exception
```
    sets the variable to type NOMINAL
    
    Throws:
    
    java.lang.Exception - if ...
  - setOrdinalType
```
public void setOrdinalType()
                    throws java.lang.Exception
```
    sets the variable to type ORDINAL
    
    Throws:
    
    java.lang.Exception - if ...
  - setAnglesType
```
public void setAnglesType()
                   throws java.lang.Exception
```
    sets the variable to type ANGLES
    
    Throws:
    
    java.lang.Exception - if ...
  - setLocationsType
```
public void setLocationsType()
                      throws java.lang.Exception
```
    sets the variable to type LOCATIONS
    
    Throws:
    
    java.lang.Exception - if ...
  - setVariableType
```
public void setVariableType(int vType)
                     throws java.lang.Exception
```
    sets the variable type
    
    Parameters:
    
    vType - the variable type to set
    
    Throws:
    
    java.lang.Exception - if ...
  - getVariableType
```
public int getVariableType()
```
    returns the variable type
    
    Returns:
    
    the variable type
  - isNominalType
```
public boolean isNominalType()
```
    returns whether the variable is of type NOMINAL
    
    Returns:
    
    the variable type
  - isOrdinalType
```
public boolean isOrdinalType()
```
    returns whether the variable is of type ORDINAL
    
    Returns:
    
    the variable type
  - isContinuousType
```
public boolean isContinuousType()
```
    returns whether the variable is of type CONTINUOUS
    
    Returns:
    
    the variable type
  - isLocationType
```
public boolean isLocationType()
```
    returns whether the variable is of type LOCATIONS
    
    Returns:
    
    the variable type
  - isAngleType
```
public boolean isAngleType()
```
    returns whether the variable is of type ANGLES
    
    Returns:
    
    the variable type
  - getVariableFormat
```
public int getVariableFormat()
```
    returns the variable format
    
    Returns:
    
    the variable type
  - setVariableFormat
```
public void setVariableFormat(int vFormat)
                       throws java.lang.Exception
```
    sets the variable format
    
    Parameters:
    
    vFormat - the variable format to set
    
    Throws:
    
    java.lang.Exception - if ...
  - isStringFormat
```
public boolean isStringFormat()
```
    returns whether the variable is of type STRING
    
    Returns:
    
    the variable format
  - isNumberFormat
```
public boolean isNumberFormat()
```
    returns whether the variable is of type NUMBER
    
    Returns:
    
    the variable format
  - isDateTimeFormat
```
public boolean isDateTimeFormat()
```
    returns whether the variable is of type DATETIME
    
    Returns:
    
    the variable format
  - getVariableDesignRole
```
public int getVariableDesignRole()
```
    returns the variable design role
    
    Returns:
    
    the variable design role
  - getVariableDesignRoleString
```
public java.lang.String getVariableDesignRoleString()
```
    returns the variable design role as a character string
    
    Returns:
    
    the variable design role as String
  - setVariableDesignRole
```
public void setVariableDesignRole(int vDesignRole)
                           throws java.lang.Exception
```
    sets the design role for the variable
    
    Parameters:
    
    vDesignRole - the variable design role
    
    Throws:
    
    java.lang.Exception - if ...
  - isXVariable
```
public boolean isXVariable()
```
    is the variable selected as an independent variable
    
    Returns:
    
    the variable design role
  - isYVariable
```
public boolean isYVariable()
```
    is the variable selected as a dependent variable
    
    Returns:
    
    the variable design role
  - setName
```
public void setName(java.lang.String varName)
```
    sets the name of the variable to the String provided
    
    Parameters:
    
    varName - new name of the Variable
  - getName
```
public java.lang.String getName()
```
    returns the name of the Variable
    
    Returns:
    
    the variable name
  - setNotes
```
public void setNotes(java.lang.String varNotes)
```
    sets the notes for the variable
    
    Parameters:
    
    varNotes - new Notes for the Variable
  - getNotes
```
public java.lang.String getNotes()
```
    returns the Notes of the Variable
    
    Returns:
    
    the variable notes
  - setRowOrder
```
public void setRowOrder(java.util.Vector<java.lang.Object> rowOrder)
```
    sets the rowOrder for the variable
    
    Parameters:
    
    rowOrder - the new rowOrder for the Variable
  - getRowOrder
```
public java.util.Vector<java.lang.Object> getRowOrder()
```
    returns the row order for the Variable
    
    Returns:
    
    the row order
  - addValue
```
public void addValue(int anInt)
              throws java.lang.Exception
```
    appends a number to the end of the Variable
    
    Parameters:
    
    anInt - the number to add
    
    Throws:
    
    java.lang.Exception - if ...
  - addValue
```
public void addValue(double aDouble)
              throws java.lang.Exception
```
    appends a number to the end of the Variable
    
    Parameters:
    
    aDouble - the number to add
    
    Throws:
    
    java.lang.Exception - if ...
  - addValue
```
public void addValue(float aFloat)
              throws java.lang.Exception
```
    appends a number to the end of the Variable
    
    Parameters:
    
    aFloat - the number to add
    
    Throws:
    
    java.lang.Exception - if ...
  - addValue
```
public void addValue(java.lang.Object anObject)
              throws java.lang.Exception
```
    appends an Object to the end of the Variable
    
    Parameters:
    
    anObject - the object to add
    
    Throws:
    
    java.lang.Exception - if ...
  - setValue
```
public void setValue(int row,
                     java.lang.Object anObject)
              throws java.lang.Exception
```
    sets a general object for a given row of the Vector
    
    Parameters:
    
    row - marks the row in the vector for which to set the value
    
    anObject - lists the Object to set for the row
    
    Throws:
    
    java.lang.Exception - if ...
  - setValue
```
public void setValue(int row,
                     int aInt)
              throws java.lang.Exception
```
    sets an integer value for a given row of the Vector
    
    Parameters:
    
    row - marks the row in the vector for which to set the value
    
    aInt - the int value to set for the row
    
    Throws:
    
    java.lang.Exception - if ...
  - setValue
```
public void setValue(int row,
                     float aFloat)
              throws java.lang.Exception
```
    sets a float value for a given row of the Vector
    
    Parameters:
    
    row - marks the row in the vector for which to set the value
    
    aFloat - the float value to set for the row
    
    Throws:
    
    java.lang.Exception - if ...
  - setValue
```
public void setValue(int row,
                     double aDouble)
              throws java.lang.Exception
```
    sets a double value for a given row of the Vector
    
    Parameters:
    
    row - marks the row in the vector for which to set the value
    
    aDouble - the double value to set for the row
    
    Throws:
    
    java.lang.Exception - if ...
  - setValue
```
public void setValue(int row,
                     char aChar)
              throws java.lang.Exception
```
    sets a char value for a given row in the Vector
    
    Parameters:
    
    row - marks the row in the vector for which to set the char
    
    aChar - the char to set for the row
    
    Throws:
    
    java.lang.Exception - if ...
  - setValue
```
public void setValue(int row,
                     boolean aBoolean)
              throws java.lang.Exception
```
    sets a boolean value for a given row of the Vector
    
    Parameters:
    
    row - marks the row in the vector for which to set the value
    
    aBoolean - lists the boolean value to set for the row
    
    Throws:
    
    java.lang.Exception - if ...
  - getValue
```
public java.lang.Object getValue(int row)
                          throws java.lang.Exception
```
    returns the object stored at a given row of the Vector
    
    Parameters:
    
    row - marks the row in the vector
    
    Returns:
    
    the returned object
    
    Throws:
    
    java.lang.Exception - if ...
  - getbooleanValue
```
public boolean getbooleanValue(int row)
                        throws java.lang.Exception
```
    returns the value stored at a given row of the Vector as a boolean
    
    Parameters:
    
    row - marks the row in the vector
    
    Returns:
    
    is boolean?
    
    Throws:
    
    java.lang.Exception - if ...
  - getStringValue
```
public java.lang.String getStringValue(int row)
                                throws java.lang.Exception
```
    returns the object stored at a given row of the Vector as a String
    
    Parameters:
    
    row - marks the row in the vector
    
    Returns:
    
    the string
    
    Throws:
    
    java.lang.Exception - if ...
  - getcharValue
```
public char getcharValue(int row)
                  throws java.lang.Exception
```
    returns the instance of char stored at a given row in the Vector
    
    Parameters:
    
    row - marks the row in the vector
    
    Returns:
    
    the returned char
    
    Throws:
    
    java.lang.Exception - if ...
  - getAbasedintValue
```
public int getAbasedintValue(int row)
                      throws java.lang.Exception
```
    returns the instance of char stored at a given row of the Vector and converts it into an integer starting with 0 at a char of 'A'
    
    Parameters:
    
    row - marks the row in the vector
    
    Returns:
    
    the returned int
    
    Throws:
    
    java.lang.Exception - if ...
  - getabasedintValue
```
public int getabasedintValue(int row)
                      throws java.lang.Exception
```
    returns the instance of char stored at a given row of the Vector and converts it into an integer starting with 0 at a char of 'a'
    
    Parameters:
    
    row - marks the row in the vector
    
    Returns:
    
    the returned int
    
    Throws:
    
    java.lang.Exception - if ...
  - getDoubleValue
```
public java.lang.Double getDoubleValue(int row)
                                throws java.lang.Exception
```
    returns the value stored at a given row of the Vector as a double
    
    Parameters:
    
    row - marks the row in the vector
    
    Returns:
    
    the returned Double
    
    Throws:
    
    java.lang.Exception - if ...
  - getdoubleValue
```
public double getdoubleValue(int row)
                      throws java.lang.Exception
```
    returns the value stored at a given row of the Vector as a double
    
    Parameters:
    
    row - marks the row in the vector
    
    Returns:
    
    the returned double
    
    Throws:
    
    java.lang.Exception - if ...
  - getintValue
```
public int getintValue(int row)
                throws java.lang.Exception
```
    returns the value stored at a given row of the Vector as an int
    
    Parameters:
    
    row - marks the row in the vector
    
    Returns:
    
    the returned int
    
    Throws:
    
    java.lang.Exception - if ...
  - getfloatValue
```
public float getfloatValue(int row)
                    throws java.lang.Exception
```
    returns the value stored at a given row of the Vector as a float
    
    Parameters:
    
    row - marks the row in the vector
    
    Returns:
    
    the returned float
    
    Throws:
    
    java.lang.Exception - if ...
  - getlongValue
```
public long getlongValue(int row)
                  throws java.lang.Exception
```
    returns the instance of long stored at a given row in the Vector
    
    Parameters:
    
    row - marks the row in the vector
    
    Returns:
    
    the returned long
    
    Throws:
    
    java.lang.Exception - if ...
  - getArray
```
public java.lang.Object[] getArray(boolean validRows)
                            throws java.lang.Exception
```
    returns an array of double values of the Vector
    
    Parameters:
    
    validRows - marks whether only valid rows should be included
    
    Returns:
    
    the object array
    
    Throws:
    
    java.lang.Exception - if ...
  - getdoubleArray
```
public double[] getdoubleArray(boolean validRows)
                        throws java.lang.Exception
```
    returns an array of double values of the Vector
    
    Parameters:
    
    validRows - marks whether only valid rows should be included
    
    Returns:
    
    the double array
    
    Throws:
    
    java.lang.Exception - if ...
  - getStringArray
```
public java.lang.String[] getStringArray(boolean selected)
                                  throws java.lang.Exception
```
    returns the object stored at a given row of the Vector as a String
    
    Parameters:
    
    selected - marks whether only selected row should be included
    
    Returns:
    
    the String array
    
    Throws:
    
    java.lang.Exception - if ...
  - fill
```
public void fill(int nRows,
                 java.lang.Object aValue)
          throws java.lang.Exception
```
    fills the variable with the given value in every row. This code provides the basic functionality for all sub-classes
    
    Parameters:
    
    nRows - the number of rows to fill
    
    aValue - the value to place in every row
    
    Throws:
    
    java.lang.Exception - if ...
  - fill
```
public void fill(int nRows,
                 double aValue)
          throws java.lang.Exception
```
    fills the variable with a constant
    
    Parameters:
    
    nRows - the number of rows to fill
    
    aValue - the double value to place in every row
    
    Throws:
    
    java.lang.Exception - if ...
  - fill
```
public Variable fill(java.lang.Object[] theData,
                     boolean ascending)
              throws java.lang.Exception
```
    fills the variable with the given value in every row. This code provides the basic funtionality for all sub-classes
    
    Parameters:
    
    theData - the values to place in the rows
    
    ascending - from top to bottom?
    
    Returns:
    
    the filled variable
    
    Throws:
    
    java.lang.Exception - if ...
  - fill
```
public Variable fill(java.lang.Object[] theData)
              throws java.lang.Exception
```
    fills the variable with the given value in every row. This code provides the basic functionality for all sub-classes
    
    Parameters:
    
    theData - the values to place in the rows
    
    Returns:
    
    the filled variable
    
    Throws:
    
    java.lang.Exception - if ...
  - fill
```
public Variable fill(double[] theData)
              throws java.lang.Exception
```
    fills the variable with individual datavalues from a double array
    
    Parameters:
    
    theData - a double array of data
    
    Returns:
    
    the filled variable
    
    Throws:
    
    java.lang.Exception - if ...
  - fill
```
public Variable fill(int[] theData)
              throws java.lang.Exception
```
    fills the variable with individual datavalues from a double array
    
    Parameters:
    
    theData - an int array of data
    
    Returns:
    
    the filled variable
    
    Throws:
    
    java.lang.Exception - if ...
  - fillWithParser
```
public void fillWithParser(DataFileParser aParser,
                           int varNum,
                           boolean firstRowAsLabels)
                    throws java.lang.Exception
```
    fills the variable with individual datavalues read from a textfile using a DataFileParser object. This code provides the basic functionality for all sub-classes.
    
    Parameters:
    
    aParser - the DataFileParser that was used to read data values from a text file
    
    varNum - marks the number of the column to be filled into the variable
    
    firstRowAsLabels - whether the first row contains a variable label
    
    Throws:
    
    java.lang.Exception - if ...
  - fillWithParser
```
public void fillWithParser(DataFileParser aParser,
                           int varNum)
                    throws java.lang.Exception
```
    fills the variable with individual datavalues read from a textfile using a DataFileParser object. This code provides the basic functionality for all sub-classes.
    
    Parameters:
    
    aParser - the DataFileParser that was used to read data values from a text file
    
    varNum - marks the number of the column to be filled into the variable
    
    Throws:
    
    java.lang.Exception - if ...
  - fillWithVariable
```
public void fillWithVariable(Variable aVar)
                      throws java.lang.Exception
```
    fills the variable as a clone of the variable
    
    Parameters:
    
    aVar - the variable to clone
    
    Throws:
    
    java.lang.Exception - if ...
  - append
```
public void append(java.lang.Object[] theData)
            throws java.lang.Exception
```
    appends the variable to the end of the variable
    
    Parameters:
    
    theData - the array of Objects to add to the end of the variable
    
    Throws:
    
    java.lang.Exception - if ...
  - getRandomValue
```
public java.lang.Object getRandomValue()
                                throws java.lang.Exception
```
    returns the object stored at a randomly selected row of the Vector
    
    Returns:
    
    a random item
    
    Throws:
    
    java.lang.Exception - if ...
  - getNSelectRows
```
public int getNSelectRows()
                   throws java.lang.Exception
```
    returns the number of currently selected rows for the variable
    
    Returns:
    
    the number of select rows
    
    Throws:
    
    java.lang.Exception - if ...
  - getNUseRows
```
public int getNUseRows()
                throws java.lang.Exception
```
    returns the number of currently selected rows for the variable which do not have missing values
    
    Returns:
    
    the number of usable rows
    
    Throws:
    
    java.lang.Exception - if ...
  - setSelectRow
```
public void setSelectRow(int row,
                         boolean select)
                  throws java.lang.Exception
```
    sets the select flag for a given row
    
    Parameters:
    
    row - marks the row in the vector
    
    select - select flag for the row
    
    Throws:
    
    java.lang.Exception - if ...
  - getSelectRow
```
public boolean getSelectRow(int row)
```
    returns whether a given row is currently selected. Returns false if not yet defined.
    
    Parameters:
    
    row - marks the row in the vector
    
    Returns:
    
    is selected row?
  - selectValue
```
public void selectValue(java.lang.Object whichValue,
                        boolean fromPrevSelected)
                 throws java.lang.Exception
```
    selects rows that match a given object from the currently selected set of rows
    
    Parameters:
    
    whichValue - the object to match
    
    fromPrevSelected - use selected set?
    
    Throws:
    
    java.lang.Exception - if ...
  - selectRows
```
public void selectRows(int start,
                       int end)
                throws java.lang.Exception
```
    sets the select flag for all rows to true
    
    Parameters:
    
    start - starting row to select
    
    end - ending row to select
    
    Throws:
    
    java.lang.Exception - if ...
  - selectEveryNthRow
```
public void selectEveryNthRow(int n)
                       throws java.lang.Exception
```
    sets the select flag for every nth row to true
    
    Parameters:
    
    n - select every nth row
    
    Throws:
    
    java.lang.Exception - if ...
  - setSelectRowsToMissing
```
public void setSelectRowsToMissing()
                            throws java.lang.Exception
```
    sets all selected rows to missing
    
    Throws:
    
    java.lang.Exception - if ...
  - setSelectRows
```
public void setSelectRows(java.lang.Object aVal)
                   throws java.lang.Exception
```
    sets all selected rows to a particular value
    
    Parameters:
    
    aVal - new value to use
    
    Throws:
    
    java.lang.Exception - if ...
  - restrictToValidRowsOnly
```
public void restrictToValidRowsOnly()
                             throws java.lang.Exception
```
    sets the select flag for all valid (non-missing) rows to true
    
    Throws:
    
    java.lang.Exception - if ...
  - restrictToMatchingUseRows
```
public void restrictToMatchingUseRows(Variable aVar)
                               throws java.lang.Exception
```
    restricts the select flag to those rows that are usable in both variables
    
    Parameters:
    
    aVar - the other variable
    
    Throws:
    
    java.lang.Exception - if ...
  - restrictToMatchingUseRows
```
public void restrictToMatchingUseRows(VariableOrganizer aVarOrg)
                               throws java.lang.Exception
```
    restricts the use flag to those rows that are usable in the variables as well as in the Organizer
    
    Parameters:
    
    aVarOrg - the VariableOrganizer
    
    Throws:
    
    java.lang.Exception - if ...
  - selectUseRows
```
public void selectUseRows()
                   throws java.lang.Exception
```
    restricts the select flag to those rows that are usable in both variables
    
    Throws:
    
    java.lang.Exception - if ...
  - selectAllRows
```
public void selectAllRows()
                   throws java.lang.Exception
```
    sets the select flag for all rows to true
    
    Throws:
    
    java.lang.Exception - if ...
  - deselectAllRows
```
public void deselectAllRows()
                     throws java.lang.Exception
```
    sets the select flag for all rows to false
    
    Throws:
    
    java.lang.Exception - if ...
  - copySelectStateFrom
```
public void copySelectStateFrom(Variable aVar)
                         throws java.lang.Exception
```
    sets the select flag for all rows based on select state of another variable
    
    Parameters:
    
    aVar - the Variable to copy from
    
    Throws:
    
    java.lang.Exception - if ...
  - replaceSelectedRows
```
public void replaceSelectedRows(java.lang.Object whichValue)
                         throws java.lang.Exception
```
    sets the select flag for all rows based on select state of another variable
    
    Parameters:
    
    whichValue - the object to match
    
    Throws:
    
    java.lang.Exception - if ...
  - selectDuplicateRows
```
public void selectDuplicateRows()
                         throws java.lang.Exception
```
    sets the select flag for all duplicate rows
    
    Throws:
    
    java.lang.Exception - if ...
  - combineSelectedWithSavedSelectedRows
```
public void combineSelectedWithSavedSelectedRows()
                                          throws java.lang.Exception
```
    combines the current set of selected rows with that set that has been saved earlier using saveSelectedRows()
    
    Throws:
    
    java.lang.Exception - if ...
  - invertSelectedRows
```
public void invertSelectedRows()
                        throws java.lang.Exception
```
    invert select rows
    
    Throws:
    
    java.lang.Exception - if ...
  - saveSelectedRows
```
public void saveSelectedRows()
                      throws java.lang.Exception
```
    saves the select flag for all currently selected rows
    
    Throws:
    
    java.lang.Exception - if ...
  - restoreSelectedRows
```
public void restoreSelectedRows()
                         throws java.lang.Exception
```
    restores the select flag for all rows from a previously saved set
    
    Throws:
    
    java.lang.Exception - if ...
  - findNextValue
```
public int findNextValue(int startSearchAt,
                         java.lang.Object aValue)
                  throws java.lang.Exception
```
    returns the next selected row after a given row
    
    Parameters:
    
    startSearchAt - start searching at this row
    
    aValue - search for such an object
    
    Returns:
    
    the next row index
    
    Throws:
    
    java.lang.Exception - if ...
  - findNextNonMissingRow
```
public int findNextNonMissingRow(int startSearchAt)
                          throws java.lang.Exception
```
    returns the next selected row after a given row
    
    Parameters:
    
    startSearchAt - start searching at this row
    
    Returns:
    
    the next non-missing row
    
    Throws:
    
    java.lang.Exception - if ...
  - findNextSelectRow
```
public int findNextSelectRow(int startSearchAt)
                      throws java.lang.Exception
```
    returns the next selected row after a given row
    
    Parameters:
    
    startSearchAt - start searching at this row
    
    Returns:
    
    the next selected row
    
    Throws:
    
    java.lang.Exception - if ...
  - findPreviousSelectRow
```
public int findPreviousSelectRow(int startSearchAt)
                          throws java.lang.Exception
```
    returns the next lower selected row before a given row
    
    Parameters:
    
    startSearchAt - start searching at this row
    
    Returns:
    
    the previous selected row
    
    Throws:
    
    java.lang.Exception - if ...
  - findFirstUseRow
```
public int findFirstUseRow()
                    throws java.lang.Exception
```
    returns the first selected row of the variable
    
    Returns:
    
    the first usable row
    
    Throws:
    
    java.lang.Exception - if ...
  - findLastUseRow
```
public int findLastUseRow()
                   throws java.lang.Exception
```
    returns the last selected row of the variable
    
    Returns:
    
    the last usable row
    
    Throws:
    
    java.lang.Exception - if ...
  - findNextUseRow
```
public int findNextUseRow(int startSearchAt)
                   throws java.lang.Exception
```
    returns the next selected row after a given row
    
    Parameters:
    
    startSearchAt - start searching at this row
    
    Returns:
    
    the next usable row
    
    Throws:
    
    java.lang.Exception - if ...
  - findPreviousUseRow
```
public int findPreviousUseRow(int startSearchAt)
                       throws java.lang.Exception
```
    returns the next lower selected row before a given row
    
    Parameters:
    
    startSearchAt - start searching at this row
    
    Returns:
    
    the previous usable row
    
    Throws:
    
    java.lang.Exception - if ...
  - findFirstSelectRow
```
public int findFirstSelectRow()
                       throws java.lang.Exception
```
    returns the first selected row of the variable
    
    Returns:
    
    the first select row
    
    Throws:
    
    java.lang.Exception - if ...
  - findLastSelectRow
```
public int findLastSelectRow()
                      throws java.lang.Exception
```
    returns the last selected row of the variable
    
    Returns:
    
    the last select row
    
    Throws:
    
    java.lang.Exception - if ...
  - getRowNumbers
```
public NumberVariable getRowNumbers()
                             throws java.lang.Exception
```
    returns the number of currently selected rows for the variable
    
    Returns:
    
    a Variable with row numbers
    
    Throws:
    
    java.lang.Exception - if ...
  - deleteRow
```
public void deleteRow(int row)
               throws java.lang.Exception
```
    delete a row from the Variable
    
    Parameters:
    
    row - the row to delete
    
    Throws:
    
    java.lang.Exception - if ...
  - deleteRowNoCheck
```
public void deleteRowNoCheck(int row)
                      throws java.lang.Exception
```
    delete a row from the Variable without coordinating a VartiableOrganizer
    
    Parameters:
    
    row - the row to delete
    
    Throws:
    
    java.lang.Exception - if ...
  - deleteAllRows
```
public void deleteAllRows()
                   throws java.lang.Exception
```
    delete all rows from the Variable
    
    Throws:
    
    java.lang.Exception - if ...
  - deleteMissingRows
```
public void deleteMissingRows()
                       throws java.lang.Exception
```
    deletes all missing rows
    
    Throws:
    
    java.lang.Exception - if ...
  - deleteSelectedRows
```
public void deleteSelectedRows()
                        throws java.lang.Exception
```
    deletes all selected rows
    
    Throws:
    
    java.lang.Exception - if ...
  - deleteNonSelectedRows
```
public void deleteNonSelectedRows()
                           throws java.lang.Exception
```
    delete all non-selected rows
    
    Throws:
    
    java.lang.Exception - if ...
  - deleteDuplicateRows
```
public void deleteDuplicateRows()
                         throws java.lang.Exception
```
    deletes duplicate rows
    
    Throws:
    
    java.lang.Exception - if ...
  - sort
```
public Variable sort()
              throws java.lang.Exception
```
    sorts the values for all rows using a map of hashcodes
    
    Returns:
    
    a Variable with sorted content
    
    Throws:
    
    java.lang.Exception - if ...
  - sort
```
public Variable sort(boolean ascending)
              throws java.lang.Exception
```
    sorts the values for all rows using a map of hashcodes
    
    Parameters:
    
    ascending - sort in ascending order?
    
    Returns:
    
    a Variable with sorted content
    
    Throws:
    
    java.lang.Exception - if ...
  - sort2
```
public Variable sort2(boolean ascending)
               throws java.lang.Exception
```
    sorts the values for all rows using a map of hashcodes
    
    Parameters:
    
    ascending - sort in ascending order?
    
    Returns:
    
    a Variable with sorted content
    
    Throws:
    
    java.lang.Exception - if ...
  - reverseRows
```
public void reverseRows(int a1,
                        int a2,
                        boolean checkForOrganizer)
                 throws java.lang.Exception
```
    reverses the values of two given rows
    
    Parameters:
    
    a1 - row one
    
    a2 - row two
    
    checkForOrganizer - should the function yield control to the VariableOrganizer
    
    Throws:
    
    java.lang.Exception - if ...
  - updateRowOrder
```
public void updateRowOrder()
                    throws java.lang.Exception
```
    updates the row order for the variable
    
    Throws:
    
    java.lang.Exception - if ...
  - setRowOrderRow
```
public void setRowOrderRow(int row,
                           double rowNum)
                    throws java.lang.Exception
```
    sets the number of rows for the Variable
    
    Parameters:
    
    row - marks the row in the vector
    
    rowNum - the ordered number for the row
    
    Throws:
    
    java.lang.Exception - if ...
  - getRowOrderRow
```
public double getRowOrderRow(int row)
                      throws java.lang.Exception
```
    returns the row order
    
    Parameters:
    
    row - marks the row in the vector
    
    Returns:
    
    the row order
    
    Throws:
    
    java.lang.Exception - if ...
  - getNMissingRows
```
public int getNMissingRows()
                    throws java.lang.Exception
```
    returns the number of missing rows in the currently selected set
    
    Returns:
    
    the number of missing rows
    
    Throws:
    
    java.lang.Exception - if ...
  - setMissingRow
```
public void setMissingRow(int row,
                          boolean missing)
                   throws java.lang.Exception
```
    sets the missing flag for a given row
    
    Parameters:
    
    row - marks the row in the vector
    
    missing - missing flag for the row
    
    Throws:
    
    java.lang.Exception - if ...
  - getMissingRow
```
public boolean getMissingRow(int row)
```
    returns whether a given row is currently missing. Returns true if missing or not yet defined.
    
    Parameters:
    
    row - marks the row in the vector
    
    Returns:
    
    is missing?
  - getUseRow
```
public boolean getUseRow(int row)
```
    returns whether a given row can be used. Returns true if not missing and selected. This does not coordinate with the VariableOrganizer
    
    Parameters:
    
    row - marks the row in the vector
    
    Returns:
    
    is usable?
  - getHighliteColor
```
public java.awt.Color getHighliteColor()
```
    returns the highlite color for the animal
    
    Returns:
    
    the color
  - setHighliteColor
```
public void setHighliteColor(java.awt.Color aColor)
```
    sets a highlite color for the animal
    
    Parameters:
    
    aColor - the color to set
  - getLocationColor
```
public java.awt.Color getLocationColor()
```
    returns the location color for the variable
    
    Returns:
    
    the color
  - setLocationColor
```
public void setLocationColor(java.awt.Color aColor)
```
    sets a location color for the animal
    
    Parameters:
    
    aColor - the color to set
  - getLineColor
```
public java.awt.Color getLineColor()
```
    returns the line color for the variable
    
    Returns:
    
    the color
  - setLineColor
```
public void setLineColor(java.awt.Color aColor)
```
    sets a line color for the animal
    
    Parameters:
    
    aColor - the color to set
  - setHighlitedRow
```
public void setHighlitedRow(int row,
                            boolean highlite)
                     throws java.lang.Exception
```
    sets the highlite flag for a given row
    
    Parameters:
    
    row - marks the row in the vector
    
    highlite - highlite flag for the row
    
    Throws:
    
    java.lang.Exception - if ...
  - getHighlitedRow
```
public boolean getHighlitedRow(int row)
                        throws java.lang.Exception
```
    returns whether a given row is currently highlited. Returns false if missing or not yet defined.
    
    Parameters:
    
    row - marks the row in the vector
    
    Returns:
    
    is high-lighted?
    
    Throws:
    
    java.lang.Exception - if ...
  - highliteSelectedRows
```
public void highliteSelectedRows()
                          throws java.lang.Exception
```
    highlites the selected rows only
    
    Throws:
    
    java.lang.Exception - if ...
  - highliteSelectedRows
```
public void highliteSelectedRows(boolean addToPreviousSet)
                          throws java.lang.Exception
```
    highlites all selected rows
    
    Parameters:
    
    addToPreviousSet - combine with previously highlited set
    
    Throws:
    
    java.lang.Exception - if ...
  - setCustomColorRow
```
public void setCustomColorRow(int row,
                              java.awt.Color aColor)
                       throws java.lang.Exception
```
    sets the custom color for a given row
    
    Parameters:
    
    row - marks the row in the vector
    
    aColor - the color to use for the row
    
    Throws:
    
    java.lang.Exception - if ...
  - getCustomColorRow
```
public java.awt.Color getCustomColorRow(int row)
                                 throws java.lang.Exception
```
    returns the custom color for a given row
    
    Parameters:
    
    row - marks the row in the vector
    
    Returns:
    
    the color
    
    Throws:
    
    java.lang.Exception - if ...
  - customColorSelectedRows
```
public void customColorSelectedRows(java.awt.Color aColor)
                             throws java.lang.Exception
```
    sets a custom colors for all selected rows
    
    Parameters:
    
    aColor - the color to use for the rows
    
    Throws:
    
    java.lang.Exception - if ...
  - customColorSelectedRows
```
public void customColorSelectedRows(java.awt.Color aColor,
                                    boolean resetOtherColors)
                             throws java.lang.Exception
```
    sets a custom colors for all selected rows
    
    Parameters:
    
    aColor - the color to use for the rows
    
    resetOtherColors - combine with previously highlited set
    
    Throws:
    
    java.lang.Exception - if ...
  - customColorFromData
```
public void customColorFromData(NumberVariable aVar,
                                java.awt.Color baseColor)
                         throws java.lang.Exception
```
    sets a custom colors for all selected rows
    
    Parameters:
    
    aVar - values in the variable determine the row's particular color
    
    baseColor - values in the variable determine the row's particular color
    
    Throws:
    
    java.lang.Exception - if ...
  - makeNewDescriptives
```
public void makeNewDescriptives()
```
    create a new set of descriptives for the variable the object
  - getDescriptives
```
public Descriptives getDescriptives()
                             throws java.lang.Exception
```
    returns the descriptives for the variable
    
    Returns:
    
    the descriptives
    
    Throws:
    
    java.lang.Exception - if ...
  - copyDescriptives
```
public Descriptives copyDescriptives()
                              throws java.lang.Exception
```
    returns the descriptives for the variable
    
    Returns:
    
    the descriptives
    
    Throws:
    
    java.lang.Exception - if ...
  - invalidDescriptives
```
public void invalidDescriptives()
```
    descriptive statistics need to be updated
  - fillDescriptives
```
public void fillDescriptives()
                      throws java.lang.Exception
```
    fills the descriptive statistics for the variable, at the root level only a check for valid data points is performed
    
    Throws:
    
    java.lang.Exception - if ...
  - fillDescriptives
```
public void fillDescriptives(java.lang.Double hypVal)
                      throws java.lang.Exception
```
    fills the descriptive statistics for the variable, at the root level only a check for valid data points is performed
    
    Parameters:
    
    hypVal - the value of the a-priori hypothesis mean
    
    Throws:
    
    java.lang.Exception - if ...
  - fillMoreDescriptives
```
public void fillMoreDescriptives()
                          throws java.lang.Exception
```
    fills additional descriptive statistics for the variable
    
    Throws:
    
    java.lang.Exception - if ...
  - getNIDs
```
public int getNIDs()
```
    returns the number of different values present in the currently selected set of rows
    
    Returns:
    
    the number of IDs
  - getIDString
```
public java.lang.String getIDString(int theIndex)
                             throws java.lang.Exception
```
    returns a single entry for a key in the TreeMap as a String
    
    Parameters:
    
    theIndex - marks the position in the TreeMap
    
    Returns:
    
    the ID string
    
    Throws:
    
    java.lang.Exception - if ...
  - getIDStrings
```
public java.lang.String[] getIDStrings()
                                throws java.lang.Exception
```
    returns the keys in the TreeMap as strings
    
    Returns:
    
    the string array
    
    Throws:
    
    java.lang.Exception - if ...
  - getIDMap
```
public java.util.TreeMap<java.lang.Object,java.lang.Integer> getIDMap()
```
    returns a TreeMap containing all different values found in the variable using the currently selected set of rows
    
    Returns:
    
    the ID map
  - getIDs
```
public java.lang.Object[] getIDs()
```
    returns a TreeMap containing all different values found in the variable using the currently selected set of rows
    
    Returns:
    
    the object array
  - getCombinedIDs
```
public java.util.TreeMap<java.lang.Object,java.lang.Integer> getCombinedIDs(Variable theOtherVariable)
```
    returns a TreeMap containing all different values found in either this variable using the currently selected set of rows or in the selected rows of a second variable
    
    Parameters:
    
    theOtherVariable - the other variable to combine with this one
    
    Returns:
    
    the IDs
  - matchedIDs
```
public boolean matchedIDs(java.util.TreeMap<java.lang.Object,java.lang.Integer> theOtherIDs)
                   throws java.lang.Exception
```
    returns whether there is a value in this variable that is not present in a given TreeMap
    
    Parameters:
    
    theOtherIDs - a second TreeMap
    
    Returns:
    
    are IDs matching
    
    Throws:
    
    java.lang.Exception - if ...
  - getFrequencies
```
public int[] getFrequencies()
                     throws java.lang.Exception
```
    returns the frequencies for different instances of the variable using the currently selected set of rows up to the specified number of maxInstances
    
    Returns:
    
    the ID frequencies
    
    Throws:
    
    java.lang.Exception - if ...
  - listSelectedRows
```
public void listSelectedRows()
```
    lists data values for all selected rows in the variable
  - listUseRows
```
public void listUseRows()
                 throws java.lang.Exception
```
    lists data values for all selected rows in the variable
    
    Throws:
    
    java.lang.Exception - if ...
  - listRow
```
public void listRow(int row)
             throws java.lang.Exception
```
    lists data value for a single row
    
    Parameters:
    
    row - start listing from this row on
    
    Throws:
    
    java.lang.Exception - if ...
  - listRows
```
public void listRows()
```
    lists all data values in the variable
  - listRows
```
public void listRows(boolean selectedOnly)
```
    lists all data values in the variable
    
    Parameters:
    
    selectedOnly - restrict to selected rows?
  - listRows
```
public void listRows(int startLine,
                     int endLine)
```
    lists data values for a range of rows regardless of selection
    
    Parameters:
    
    startLine - start listing from this row on
    
    endLine - stop listing at this row
  - listRows
```
public void listRows(int startLine,
                     int endLine,
                     boolean selectedOnly)
```
    lists data values for a range of rows
    
    Parameters:
    
    startLine - start listing from this row on
    
    endLine - stop listing at this row
    
    selectedOnly - restrict to selected rows?
  - saveRowsToFile
```
public void saveRowsToFile(java.lang.String name)
                    throws java.lang.Exception
```
    saves all data values to a text file
    
    Parameters:
    
    name - the name of the text file
    
    Throws:
    
    java.lang.Exception - if ...
  - saveRowsToFile
```
public void saveRowsToFile(int startLine,
                           int endLine,
                           boolean selectedOnly,
                           java.lang.String name)
                    throws java.lang.Exception
```
    saves data values for a range of rows to a text file
    
    Parameters:
    
    startLine - start listing from this row on
    
    endLine - stop listing at this row
    
    selectedOnly - restrict to selected rows?
    
    name - the name of the text file
    
    Throws:
    
    java.lang.Exception - if ...
  - listRowOrder
```
public void listRowOrder(int startLine,
                         int endLine,
                         boolean selectedOnly)
```
    lists data values for a range of rows
    
    Parameters:
    
    startLine - start listing from this row on
    
    endLine - stop listing at this row
    
    selectedOnly - restrict to selected rows?
  - listSelectState
```
public void listSelectState()
```
    lists for each row whether it is selected or not
  - listSelectState
```
public void listSelectState(int startLine,
                            int endLine)
```
    lists for a range of rows whether it is selected or not
    
    Parameters:
    
    startLine - start listing from this row on
    
    endLine - stop listing at this row
  - listDescriptives
```
public void listDescriptives()
                      throws java.lang.Exception
```
    lists the descriptive statistics for the variable using the currently selected set of rows
    
    Throws:
    
    java.lang.Exception - if ...
  - listDescriptives
```
public void listDescriptives(java.lang.Double hypMean)
                      throws java.lang.Exception
```
    lists the descriptive statistics for the variable using the currently selected set of rows
    
    Parameters:
    
    hypMean - the hypothetical mean
    
    Throws:
    
    java.lang.Exception - if ...
  - listGroupDescriptives
```
public void listGroupDescriptives(Variable theXVariable)
                           throws java.lang.Exception
```
    lists the descriptives for the groups identified by X
    
    Parameters:
    
    theXVariable - provides the information on how to form the groups
    
    Throws:
    
    java.lang.Exception - if ...
  - listGroupDescriptivesNoDia
```
public void listGroupDescriptivesNoDia(Variable theXVariable)
                                throws java.lang.Exception
```
    lists the descriptives for the groups identified by X
    
    Parameters:
    
    theXVariable - provides the information on how to form the groups
    
    Throws:
    
    java.lang.Exception - if ...
  - checkLocked
```
public void checkLocked()
                 throws java.lang.Exception
```
    examine whether this variables is locked
    
    Throws:
    
    java.lang.Exception - if ...
  - checkAllUseRows
```
public boolean checkAllUseRows()
                        throws java.lang.Exception
```
    examines whether all rows contain valid and selected data
    
    Returns:
    
    are all rows usable?
    
    Throws:
    
    java.lang.Exception - if ...
  - checkMatchingRows
```
public boolean checkMatchingRows(ContingencyTable aMat)
                          throws java.lang.Exception
```
    examine whether this variables has the same number of rows as the provided ContingencyTable
    
    Parameters:
    
    aMat - the ContingencyTable to compare with
    
    Returns:
    
    are cell numbers matching?
    
    Throws:
    
    java.lang.Exception - if ...
  - checkMinUseRows
```
public boolean checkMinUseRows(int minRows)
                        throws java.lang.Exception
```
    examines whether a minimum number rows is selected
    
    Parameters:
    
    minRows - the minimum number of rows
    
    Returns:
    
    are minimum number of rows?
    
    Throws:
    
    java.lang.Exception - if ...
  - checkSameNRows
```
public boolean checkSameNRows(Variable theVar)
                       throws java.lang.Exception
```
    examines whether the variable has the same number of rows as another variable
    
    Parameters:
    
    theVar - the Variable to compare with
    
    Returns:
    
    are same number of rows?
    
    Throws:
    
    java.lang.Exception - if ...
  - checkSameNSelectRows
```
public boolean checkSameNSelectRows(Variable theVar)
                             throws java.lang.Exception
```
    examines whether the same rows are selected as in another variable
    
    Parameters:
    
    theVar - the Variable to compare with
    
    Returns:
    
    are same matching rows?
    
    Throws:
    
    java.lang.Exception - if ...
  - checkSameSelectRows
```
public boolean checkSameSelectRows(Variable theVar)
                            throws java.lang.Exception
```
    examines whether the same rows are selected as in another variable
    
    Parameters:
    
    theVar - the other variable to compare with
    
    Returns:
    
    are same selected rows?
    
    Throws:
    
    java.lang.Exception - if ...
  - checkSameSelectRows
```
public boolean checkSameSelectRows(VariableOrganizer theVarOrganizer)
                            throws java.lang.Exception
```
    examines whether the same rows are selected as in another variable
    
    Parameters:
    
    theVarOrganizer - the VariableOrganizer to compare with
    
    Returns:
    
    are same selected rows?
    
    Throws:
    
    java.lang.Exception - if ...
  - checkSameUseRows
```
public boolean checkSameUseRows(Variable theVar)
                         throws java.lang.Exception
```
    examines whether the same rows are selected and not missing as in another variable
    
    Parameters:
    
    theVar - the Variable to compare with
    
    Returns:
    
    are same usable rows?
    
    Throws:
    
    java.lang.Exception - if ...
  - checkSameUseRows
```
public boolean checkSameUseRows(VariableOrganizer theVarOrganizer)
                         throws java.lang.Exception
```
    examines whether the same rows are selected and not missing as in another variable
    
    Parameters:
    
    theVarOrganizer - the VariableOrganizer to compare with
    
    Returns:
    
    are same usable rows?
    
    Throws:
    
    java.lang.Exception - if ...
  - checkNumberIDs
```
public void checkNumberIDs(int compareTo)
                    throws java.lang.Exception
```
    checks whether there is a given number of distinct IDs present in the currently selected set of rows
    
    Parameters:
    
    compareTo - number of distinct IDs to compare to
    
    Throws:
    
    java.lang.Exception - if ...
  - checkSameIDs
```
public void checkSameIDs(Variable theOtherVariable)
                  throws java.lang.Exception
```
    checks whether two variables have identical sets of distinct IDs in the currently selected set of rows
    
    Parameters:
    
    theOtherVariable - the other variable to compare with
    
    Throws:
    
    java.lang.Exception - if ...
  - checkValidRowRange
```
public boolean checkValidRowRange(int row)
                           throws java.lang.Exception
```
    checks whether a given row is within a valid range
    
    Parameters:
    
    row - marks the row in the vector
    
    Returns:
    
    is valid row range?
    
    Throws:
    
    java.lang.Exception - if ...
  - isValidRowRange
```
public boolean isValidRowRange(int row)
                        throws java.lang.Exception
```
    checks whether a given row is within a valid range
    
    Parameters:
    
    row - marks the row in the vector
    
    Returns:
    
    is valid row range?
    
    Throws:
    
    java.lang.Exception - if ...
  - getCrossTabulation
```
public ContingencyTable getCrossTabulation(Variable theXVariable,
                                           boolean sameIDs,
                                           boolean includeDiagonal)
```
    returns a crosstabulation of values for two variables in form of a matrix
    
    Parameters:
    
    theXVariable - the variable contains information on how to form the groups
    
    sameIDs - do the same variable states exist in both x and y variable
    
    includeDiagonal - should it include the diagonal?
    
    Returns:
    
    te crosstabs
  - getCrossTabulation
```
public ContingencyTable getCrossTabulation(Variable theXVariable,
                                           java.util.TreeMap<java.lang.Object,java.lang.Integer> xHash,
                                           java.util.TreeMap<java.lang.Object,java.lang.Integer> yHash,
                                           boolean includeDiagonal)
```
    returns a crosstabulation of values for two variables in form of a matrix
    
    Parameters:
    
    theXVariable - the variable contains information on how to form the groups
    
    xHash - use these states for the x variable
    
    yHash - use these states for the y variable
    
    includeDiagonal - should it include the diagonal?
    
    Returns:
    
    the crosstabs
  - getInteractions
```
public InteractionTable getInteractions(Variable theXVariable)
                                 throws java.lang.Exception
```
    returns a crosstabulation of values for two variables in form of an interaction matrix
    
    Parameters:
    
    theXVariable - a second variable
    
    Returns:
    
    the crosstabs for interactions
    
    Throws:
    
    java.lang.Exception - if ...
  - getTransitions
```
public ContingencyTable getTransitions()
```
    returns the transitions among consecutive values in form of a matrix
    
    Returns:
    
    the transitions
  - getManhattan
```
public double getManhattan(Variable aVar)
                    throws java.lang.Exception
```
    returns the Manhattan proximity measure to another variable
    
    Parameters:
    
    aVar - a second variable
    
    Returns:
    
    the distance
    
    Throws:
    
    java.lang.Exception - if ...
  - getJaccard
```
public double getJaccard(Variable aVar)
                  throws java.lang.Exception
```
    returns the Manhattan proximity measure to another variable
    
    Parameters:
    
    aVar - a second variable
    
    Returns:
    
    the distance
    
    Throws:
    
    java.lang.Exception - if ...
  - getProximity
```
public double getProximity(Variable aVar)
                    throws java.lang.Exception
```
    returns the proximity measure to another variable
    
    Parameters:
    
    aVar - a second variable
    
    Returns:
    
    the distance
    
    Throws:
    
    java.lang.Exception - if ...
  - getProximity
```
public double getProximity(Variable aVar,
                           int proxType)
                    throws java.lang.Exception
```
    returns the proximity measure to another variable
    
    Parameters:
    
    aVar - a second variable
    
    proxType - the type of proximity to calculate
    
    Returns:
    
    the distance
    
    Throws:
    
    java.lang.Exception - if ...
  - asJAMAMatrix
```
public com.lobsterman.JavaGrinders.Jama.Matrix asJAMAMatrix()
                                                     throws java.lang.Exception
```
    returns a matrix for the variables in the variableorganizer which have been selected as dependent variables (i.e., VariableDesignRole.Y) and which are ordinal or nominal
    
    Returns:
    
    the jama matrix
    
    Throws:
    
    java.lang.Exception - if ...
  - asVariableOrganizer
```
public VariableOrganizer asVariableOrganizer()
                                      throws java.lang.Exception
```
    returns the variable as a variable organizer filled with this variable
    
    Returns:
    
    the VariableOrganizer
    
    Throws:
    
    java.lang.Exception - if ...
  - makeTableSubSet
```
public ContingencyTable makeTableSubSet(ContingencyTable aTable)
                                 throws java.lang.Exception
```
    returns a subset of row data values for the ContingencyTable as a ContingencyTable.
    
    Parameters:
    
    aTable - the independent ContingencyTable
    
    Returns:
    
    the table subset
    
    Throws:
    
    java.lang.Exception - if ...

Class Variable

Field Summary

Fields inherited from class java.util.Vector

Fields inherited from class java.util.AbstractList

Constructor Summary

Method Summary

Methods inherited from class java.util.Vector

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Collection

Field Detail

kSquEuclidian

kEuclidian

kManhattan

kJaccard

kGower

rand

itsDescriptives

isSorted

itsFormula

autoExtracted

hasDefaultColors

itsLocationColor

itsLineColor

plotMarker

Constructor Detail

Variable

Variable

Method Detail

cloneVariableFrom

cloneSelectedRowsOnly

clone

setNRows

getNRows

setOrganizer

getOrganizer

setLock

isLocked

setFormula

setNominalType

setOrdinalType

setAnglesType

setLocationsType

setVariableType

getVariableType

isNominalType

isOrdinalType

isContinuousType

isLocationType

isAngleType

getVariableFormat

setVariableFormat

isStringFormat

isNumberFormat

isDateTimeFormat

getVariableDesignRole

getVariableDesignRoleString

setVariableDesignRole

isXVariable

isYVariable

setName

getName

setNotes

getNotes

setRowOrder

getRowOrder

addValue

addValue

addValue

addValue

setValue

setValue

setValue

setValue

setValue

setValue

getValue

getbooleanValue

getStringValue

getcharValue

getAbasedintValue