Module org.gsusers.gsmv
Package org.gsusers.gsmv.model

Class Nest

java.lang.Object
org.gsusers.gsmv.model.Nest
public class Nest extends Object
class Nest Encapsulates the major parameters of the assessment design, and the central variables required for analysis. Nest is used in most other classes as common repository to access central variables and parameters.
See Also:

  • Constructor Details

    • Nest

      public Nest(gsLogger _logger, GS_Application _myMain, Preferences _prefs)
      Constructor for class Nest
      Parameters:
      _logger - - pointer org.gs_users.gs_lv.GS_Application logger
      _myMain - - pointer to Main class
      _prefs - - pointer to Preferences API

  • Method Details

    • getFacet

      public Facet getFacet(int iOrder)
      facet from order number
      Parameters:
      iOrder - - order in sDictionary
      Returns:
      facets.get(iOrder)- Facet object

    • getFacet

      public Facet getFacet(char _cDesignation)
      facet from char designation
      Parameters:
      _cDesignation - - char designation
      Returns:
      facets.get(index);

    • getSimulate

      public Boolean getSimulate()
      getter for bSimulate.
      Returns:
      bSimulate

    • getDictionary

      public String getDictionary()
      getter for sDictionary.
      Returns:
      sDictionary

    • getHDictionary

      public String getHDictionary()
      getter for sHDictionary.
      Returns:
      sHDictionary

    • setHDictionary

      public void setHDictionary(String _sHDictionary)
      setter for sHDictionary.
      Parameters:
      _sHDictionary - hierarchic facet dictionary

    • setAsterisk

      public void setAsterisk(char _cAsterisk)
      setter of iAsterisk by facet char Designation.
      Parameters:
      _cAsterisk - char facet designation

    • getAsterisk

      public char getAsterisk()
      getter of iAsterisk as hierarchical facet order.
      Returns:
      iAsterisk facet index of asterisk

    • get_iMinRep

      public int get_iMinRep()
      getter for minimal number of replications.
      Returns:
      iRepMinimum

    • getRepRange

      public Double getRepRange()
      getter for Replication range (variance)
      Returns:
      dRepRange

    • incrementSteps

      public void incrementSteps()
      conditional iStep incrementer. Depending on the iProblem switch: -1: exit the program 0: go to the next step greater than 0: go and explain problem

    • getStep

      public Integer getStep()
      getter for iStep, i.e. position in data entry sequence.
      Returns:
      iStep

    • setDoOver

      public void setDoOver(Boolean _bDoOver)
      setter for bDoOver, i.e. 'script' vs 'manual' parameter entry.
      Parameters:
      _bDoOver - flag to get input parameters from script

    • getDoOver

      public Boolean getDoOver()
      getter for bDoOver, i.e. 'script' vs 'manual' parameter entry.
      Returns:
      bDoOver

    • setSimulate

      public void setSimulate(Boolean _bSimulate)
      setter for bSimulate - flag 'Simulate' vs 'Analyze'.
      Parameters:
      _bSimulate - flag to do synthesis

    • setTitle

      public void setTitle(String _sTitle)
      Setter for script title
      Parameters:
      _sTitle - String title of control file

    • getFacetCount

      public Integer getFacetCount()
      getter for iFacetCount.
      Returns:
      iFacetCount

    • setFacetCount

      public void setFacetCount(Integer _iFacetCount)
      setter for iFacetCount.
      Parameters:
      _iFacetCount - count of facets

    • setSubject

      public void setSubject(Facet _fSubject)
      Setter for subject facet
      Parameters:
      _fSubject - subject facet

    • setFacetDesignation

      public void setFacetDesignation(int iFacetID, char cDesignation)
      Sets designation char of current facet
      Parameters:
      iFacetID - ID of current facet
      cDesignation - new facet designation char

    • setFacetName

      public void setFacetName(int iFacetID, String sFacetName)
      Sets name of current facet
      Parameters:
      iFacetID - iFacetID ID of current facet
      sFacetName - new facet name

    • setFacetNested

      public void setFacetNested(int iFacetID, Boolean bFacetNested)
      Sets nested status of current facet
      Parameters:
      iFacetID - iFacetID ID of current facet
      bFacetNested - new facet status

    • getTitle

      public String getTitle()
      getter for sScriptTitle.
      Returns:
      sScriptTitle

    • getComments

      public String[] getComments()
      getter for script comments.
      Returns:
      string array of comments

    • setComments

      public void setComments(String _comments)
      setter for script comments.
      Parameters:
      _comments - flowing text with carriage returns.

    • addComment

      public void addComment(String _sCommentLine)
      add commentLine to salComments.
      Parameters:
      _sCommentLine - line of comment to be included in script

    • addFacet

      public void addFacet(Facet _f)
      method to collect facet information from scripts
      Parameters:
      _f - facet to be added

    • addEffect

      public void addEffect(String _sEffect)
      parser for 'Effect' line in analyze script
      Parameters:
      _sEffect - EFFECT describes nested or un-nested configuration of Facets

    • addFormat

      public void addFormat()
      setter for sFormat.

    • addProcess

      public void addProcess()
      setter for sProcess

    • getNests

      public javafx.collections.ObservableList<String> getNests()
      creates observable list of primary nesting from facet input for use in 'nesting grab and drop' (Step 7)
      Returns:
      ObservableList

    • setNests

      public void setNests(String[] _nests)
      translates string array from AnaGroups step 7 into Nest, and SampleSizeTree data structures
      Parameters:
      _nests - primary nested facet combinations

    • setScene

      public void setScene(javafx.scene.Scene _scene)
      setter of Scene.
      Parameters:
      _scene - Scene to be displayed

    • getScene

      public javafx.scene.Scene getScene()
      getter of Scene.
      Returns:
      scene to be displayed

    • setStage

      public void setStage()
      setter of primary Stage.

    • setFileName

      public void setFileName()
      setter of sFileName.

    • getDawdle

      public Boolean getDawdle()
      getter of bDawdle.
      Returns:
      bDawdle flag to stepper

    • getVarianceDawdle

      public Boolean getVarianceDawdle()
      getter of bVarianceDawdle.
      Returns:
      bVarianceDawdle

    • setDawdle

      public void setDawdle(Boolean _dawdle)
      setter of bDawdle.
      Parameters:
      _dawdle - flag to stepper

    • setVarianceDawdle

      public void setVarianceDawdle(Boolean _Dawdle)
      setter of bVarianceDawdle.
      Parameters:
      _Dawdle - flag to stepper

    • show

      public void show(javafx.scene.Group _group)
      passes _group via myMain to controller, i.e. GUI.
      Parameters:
      _group - display group

    • getControlFileName

      public String getControlFileName()
      getter of sControlFileName.
      Returns:
      sControlFileName

    • getDataFileName

      public String getDataFileName()
      getter of sDataFileName.
      Returns:
      sDataFileName

    • setGrandMeans

      public void setGrandMeans(Double _means)
      setter of dGrandMeans.
      Parameters:
      _means - value of grand mean

    • getGreatMeans

      public Double getGreatMeans()
      getter of dGrandMeans.
      Returns:
      dGrandMeans

    • setVariance

      public void setVariance(String _line)
      adds new VarianceComponent to salVarianceComponents by parsing ANOVA line from urGENOVA output.
      Parameters:
      _line - string from ANOVA table

    • setOrder

      public void setOrder()
      Essential routine to establish the logic of facet organization. Is called from AnaGroups and SynthGroups after Nesting step

    • fillEffects

      public void fillEffects()

    • getFacets

      public Facet[] getFacets()
      getter for array of all facets.
      Returns:
      farFacets all facets of the study

    • getNestCount

      public Integer getNestCount()
      getter for number of primary Effects (facet nestings)
      Returns:
      iNestCount number of primary Effects

    • G_setFacets

      public void G_setFacets()
      sets up facet types for generalizability calculations

    • createFacets

      public void createFacets()
      Setter of Facet array

    • createDictionary

      public void createDictionary()
      Create basic dictionary (in original order of facets)

    • setLevels

      public void setLevels()
      Sets facet levels of all facets (for D-Studies

    • saveVariable

      public void saveVariable(String _sType, String _sTarget, String _sValue)
      General purpose variable saving method.
      Parameters:
      _sType - variable type
      _sTarget - variable name
      _sValue - variable value

    • formatResults

      public void formatResults(StringBuilder sbResult)
      This method should probably be in org.gs_users.gs_lv.utilities..filer from a logic point of view but was placed in nests for convenience. It redacts and formats the prose for G- and D-Studies into the StringBuilder 'sbResult'.
      Parameters:
      sbResult - StringBuilder, to which the prose has to be added

    • getRho

      public Double getRho()
      getter for Generalizability Coefficient.
      Returns:
      dRel Double value of Generalizability Coefficient

    • getPhi

      public Double getPhi()
      getter for Index of Reliability.
      Returns:
      dAbs Double value of Index of Reliability

    • setStep

      public void setStep(Integer _iStep)
      setter for step used in AnaGroups and SynthGroups respectively.
      Parameters:
      _iStep - step in data entry sequence

    • getNestedName

      public String getNestedName(Integer iSAR)
      getter of primary Effect name.
      Parameters:
      iSAR - index to string array
      Returns:
      sarNestedNames[iSAR] primary effect name

    • getNestedNames

      public String[] getNestedNames()
      Getter of nested names array
      Returns:
      nested names array

    • getNestor

      public Character getNestor(char cF)
      getter of a facet's 'Nestor' facet.
      Parameters:
      cF - char designation of facet
      Returns:
      char designation of Nestor facet

    • setVariancecoefficient

      public void setVariancecoefficient(int i, Double _dVC)
      setter of individual variance coefficient in array.
      Parameters:
      i - position in array
      _dVC - value of variance coefficient.

    • getVarianceCoefficient

      public Double getVarianceCoefficient(int i)
      getter of variance coefficient from array.
      Parameters:
      i - position in array
      Returns:
      Double value of variance coefficient

    • getCeiling

      public Integer getCeiling()
      getter of score ceiling value
      Returns:
      iCeiling

    • getFloor

      public Integer getFloor()
      getter of score floor value.
      Returns:
      iFloor

    • getMean

      public Double getMean()
      getter of intended score mean
      Returns:
      Double value

    • addAnchors

      public void addAnchors(String sValue)
      parser for reading score anchors from script (SynthGroups).
      Parameters:
      sValue - text line from script

    • addVariances

      public void addVariances(String sValue)
      parser for reading variance components from script (SynthGroups).
      Parameters:
      sValue - text line from script

    • getVcDim

      public Integer getVcDim()
      getter of variance coefficient array size.
      Returns:
      array size

    • getTree

      public SampleSizeTree getTree()
      getter for SampleSizeTree.
      Returns:
      current SampleSizeTree

    • doComponents

      public void doComponents()
      Generates facet combinations responsible for variance components, including their appropriate syntax. The object is somewhat occult. It gets only called once in steps.SynthGroups.VarianceComponentsGroup line 887. It sets up the string array sarNestedNames in Nest and the 'aNode' array 'nodes' in 'nest'.

    • setReplicate

      public void setReplicate(Boolean _bReplicate)
      Setter for replication flag.
      Parameters:
      _bReplicate - replication flag

    • getReplicate

      public Boolean getReplicate()
      Getter for replication flag.
      Returns:
      replication flag.

    • get_cRep

      public char get_cRep()
      Getter for cReplicate
      Returns:
      cReplicate

    • setProblem

      public void setProblem(int _iProblem)
      Setter of termination flag (bAbandon).
      Parameters:
      _iProblem - problem identifier in replication

    • getProblem

      public int getProblem()
      Getter of termination flag (iProblem).
      Returns:
      bAbandon

    • set_cRep

      public void set_cRep(char _cRep)
      Setter for cReplicate
      Parameters:
      _cRep - cReplicate

    • getRepChar

      public char getRepChar()
      Returns designation of replicating facet, or '-' if none.
      Returns:
      cReplicate, or '-'

    • getRepMin

      public Integer getRepMin()
      Getter for lowest possible value for number of replications.
      Returns:
      iRepMinimum

    • setHighlight

      public void setHighlight(int _iHighLight)
      Setter for number of index columns in data file.
      Parameters:
      _iHighLight - offset after index columns

    • getHighLight

      public int getHighLight()
      Getter for number of index columns in data file.
      Returns:
      iHighLight offset after index columns;

    • setResume

      public void setResume(int _iResume)
      Sets step, at which AnaGroups has to resume after a design problem
      Parameters:
      _iResume - set number to resume at.

    • setReNest

      public void setReNest(Boolean _bReNest)
      Setter for bReNest (whether nesting info is reused)
      Parameters:
      _bReNest - boolean flag

    • getStackTraceMode

      public Boolean getStackTraceMode()
      Dummy switch constant for internal control This is a VERY IMPORTANT SWITCH! It can only be changed by directly entering the value here. It controls, whether exceptions get logged, or cause a stack trace printout in debugging mode.
      Returns:
      Boolean switch for trace mode

    • complete

      public Boolean complete()
      Test if previous nest setup was complete
      Returns:
      true, if complete

    • incrementMissing

      public void incrementMissing()
      increments missing data count

    • getMissingDataCount

      public int getMissingDataCount()
      Returns missing data count
      Returns:
      int missing data count