JavaGrinders
Class StrVariable

java.lang.Object
  java.util.AbstractCollection<E>
      java.util.AbstractList<E>
          java.util.Vector
              JavaGrinders.Variable
                  JavaGrinders.StrVariable

All Implemented Interfaces:

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

Direct Known Subclasses:

CharVariable, StringVariable

public class StrVariable
extends Variable

handles a variable of Strings. It sets or retrieves individual entries, and selects rows by comparing the entry to a given String.

See Also:

Serialized Form

Field Summary

Fields inherited from class JavaGrinders.Variable

autoExtracted, df, doWarnings, itsDescriptives, itsHighlitedColor, itsLineColor, itsLocationColor, rand

Fields inherited from class java.util.Vector

capacityIncrement, elementCount, elementData

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

StrVariable(java.lang.String varName, VariableOrganizer theOwner)
Standard constructor for the root string Variable class using a VariableOrganizer

Method Summary

Variable	cloneSelectedRowsOnly() returns a NumberVariable with only the selected rows
void	fillWithParser(DataFileParser aParser, int varNum, boolean firstRowAsLabels) fills the variable with individual datavalues read from a textfile using a * DataFileParser object
void	selectRows(java.lang.String matchString, boolean fromPrevSelected) select all rows with a String that matches the one provided
void	sort(boolean ascending) sorts the values for all rows (this is a place holder for all subclasses)

Methods inherited from class JavaGrinders.Variable

addValue, asJAMAMatrix, asVariableOrganizer, checkMinUseRows, checkNumberIDs, checkSameIDs, checkSameSelectRows, checkSameSelectRows, checkSameUseRows, checkSameUseRows, checkValidRowRange, combineSelectedWithSavedSelectedRows, copySelectStateFrom, customColorSelectedRows, deleteMissingRows, deleteNonSelectedRows, deleteRow, deleteRows, deleteSelectedRows, deselectAllRows, deselectRows, fill, fill, fill, fill, fill, fillDescriptives, fillWithParser, fillWithVariable, findFirstValidRow, findLastValidRow, findNextNonMissingRow, findNextValidRow, findPreviousValidRow, getabasedintValue, getAbasedintValue, getbooleanValue, getcharValue, getCombinedIDs, getCrossTabulation, getCrossTabulation, getCustomColorRow, getDescriptives, getdoubleArray, getdoubleValue, getfloatValue, getHighlitedRow, getIDs, getIDString, getIDStrings, getInteractions, getintValue, getJaccard, getlongValue, getManhattan, getMissingRow, getName, getNIDs, getNMissingRows, getNotes, getNRows, getNSelectRows, getNUseRows, getNValidRows, getOrganizer, getProximity, getProximity, getRandomValue, getSelectRow, getSquEuclidian, getStringArray, getStringValue, getTransitions, getUseRow, getValue, getVariableDesignRole, getVariableDesignRoleString, getVariableFormat, getVariableType, highliteSelectedRows, invalidDescriptives, invertSelectedRows, isAngleType, isContinuousType, isLocationType, isLocked, isNominalType, isOrdinalType, isXVariable, isYVariable, listBasics, listDescriptives, listFrequencies, listGroupDescriptives, listGroupDescriptivesNoDia, listIDs, listRows, listRows, listSelectedRows, listSelectState, listSelectState, listUseRows, matchedIDs, reportWarnings, restoreSelectedRows, restrictToMatchingUseRows, restrictToMatchingUseRows, reverseRows, saveSelectedRows, selectAllRows, selectRows, selectStringValue, selectUseRows, selectValue, setAnglesType, setCustomColorRow, setFormula, setHighliteColor, setHighlitedRow, setLineColor, setLocationColor, setLock, setMissingRow, setName, setNominalType, setNotes, setNRows, setOrdinalType, setOrganizer, setSelectRow, setSelectRowsToMissing, setValue, setValue, setValue, setValue, setValue, setValue, setVariableDesignRole, setVariableFormat, setVariableType, setWarnings

Methods inherited from class java.util.Vector

add, add, addAll, addAll, addElement, capacity, clear, clone, contains, containsAll, copyInto, elementAt, elements, ensureCapacity, equals, firstElement, get, hashCode, indexOf, indexOf, insertElementAt, isEmpty, lastElement, lastIndexOf, lastIndexOf, remove, remove, removeAll, removeAllElements, removeElement, removeElementAt, removeRange, retainAll, set, setElementAt, setSize, size, subList, toArray, toArray, toString, trimToSize

Methods inherited from class java.util.AbstractList

iterator, listIterator, listIterator

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

iterator, listIterator, listIterator

Constructor Detail

StrVariable

public StrVariable(java.lang.String varName,
                   VariableOrganizer theOwner)
            throws java.lang.Exception

Standard constructor for the root string Variable class using a VariableOrganizer

Parameters:

varName - assigns a name 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

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

Overrides:

fillWithParser in class Variable

Parameters:

aParser - the DataFileParser that was used to read data values from a text file * @param varNum marks the number of the column to be filled into the variable * @param firstRowAsLabels whether the first row contains a variable label

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

cloneSelectedRowsOnly

public Variable cloneSelectedRowsOnly()
                               throws java.lang.Exception

returns a NumberVariable with only the selected rows

Throws:

java.lang.Exception

sort

public void sort(boolean ascending)
          throws java.lang.Exception

sorts the values for all rows (this is a place holder for all subclasses)

Overrides:

sort in class Variable

Parameters:

ascending - in ascending order

Throws:

java.lang.Exception

selectRows

public void selectRows(java.lang.String matchString,
                       boolean fromPrevSelected)
                throws java.lang.Exception

select all rows with a String that matches the one provided

Parameters:

matchString - lists the String to compare with * @param fromPrevSelected notes whether the search should only be performed on currently selected rows

Throws:

java.lang.Exception