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

Class Facet

java.lang.Object
org.gsusers.gsmv.model.Facet
public class Facet extends Object
the class 'Facet' encapsulates the various parameters for each facet; as well as the various methods required
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    Facet(Nest _nest)
    Constructor for empty facet
    Facet(Nest _nest, String _sName, char _cDesignation, Boolean _bIsNested)
    Constructor for defined facet.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addNestee(char cNestee)
    adds 'Nestee', facets nested in the current facet.
    Double
    dGetLevel()
    Getter of FacetLevel (Double).
    void
    doNesting(String sComponent)
    Sets up nesting configuration based on the nesting input, this method determines the nestor/nestees relationships
    char
    getDesignation()
    Returns facet designation.
    String
    getDesignationString()
    Getter of cDesignation as String.
    String
    getDiagDesignation()
    Getter for facet designation, whether it is fixed or random, and Level (average sample size).
    Double
    getFacetLevel()
    Getter for FacetLevel, the appropriate sample size average for a given facet, used in D-Studies.
    char
    getFacetType()
    Getter for facet type.
    Boolean
    getFixed()
    Getter of 'Fixed' status.
    String
    getName()
    Getter for facet name.
    Boolean
    getNested()
    Getter of 'nested status'.
    Character
    getNestor()
    Getter of 'Nestor'.
    Integer
    getOrder()
    Getter for facet order within sHDirectory.
    void
    setAsterisk(Boolean _bAsterisk)
    Setter of bAsterisk.
    void
    setDesignation(char _cDesignation)
    Setter for symbolic character designating the facet, usually the lower case initial of the name.
    void
    setdFacetLevel(Double _dLevel)
    Setter of FacetLevel (Double).
    void
    setFacetLevel()
    Calculates levels for G studies for facets of generalization: simple mean of sample sizes for 1 level of nesting, harmonic mean for higher levels of nesting.
    void
    setFacetType(char _cFacetType)
    Setter of 'facetType', defined above in the variable list.
    void
    setFixed(Boolean _bFixed)
    Setter for bFixed.
    void
    setID(Integer _id)
    Setter for the hierarchical order in which the facets increment in the data file, and it is in 'sHDictionary'.
    void
    setName(String _sName)
    Setter for facet name, descriptive single word with upper case initial.
    void
    setNested(Boolean _bIsNested)
    Setter for 'isNested', 'true' if facet nested in another.
    void
    setNestor(char cFacet)
    Setter of 'Nestor', i.e.
    Boolean
    starred()
    Getter for presence of facet asterisk.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Facet

      public Facet(Nest _nest)
      Constructor for empty facet
      Parameters:
      _nest - ;

    • Facet

      public Facet(Nest _nest, String _sName, char _cDesignation, Boolean _bIsNested)
      Constructor for defined facet.
      Parameters:
      _nest - ;
      _sName - ;
      _cDesignation - ;
      _bIsNested - ;

  • Method Details

    • setName

      public void setName(String _sName)
      Setter for facet name, descriptive single word with upper case initial.
      Parameters:
      _sName - ;

    • setDesignation

      public void setDesignation(char _cDesignation)
      Setter for symbolic character designating the facet, usually the lower case initial of the name.
      Parameters:
      _cDesignation - ;

    • setNested

      public void setNested(Boolean _bIsNested)
      Setter for 'isNested', 'true' if facet nested in another.
      Parameters:
      _bIsNested - ;

    • setID

      public void setID(Integer _id)
      Setter for the hierarchical order in which the facets increment in the data file, and it is in 'sHDictionary'.
      Parameters:
      _id - ;

    • setNestor

      public void setNestor(char cFacet)
      Setter of 'Nestor', i.e. the facet in which the current facet is nested.
      Parameters:
      cFacet - ;

    • setFacetType

      public void setFacetType(char _cFacetType)
      Setter of 'facetType', defined above in the variable list. The facet type is essential for the calculation of variance components and G-coefficients.
      Parameters:
      _cFacetType - ;

    • setAsterisk

      public void setAsterisk(Boolean _bAsterisk)
      Setter of bAsterisk.
      Parameters:
      _bAsterisk - ;

    • setFixed

      public void setFixed(Boolean _bFixed)
      Setter for bFixed.
      Parameters:
      _bFixed - ;

    • getName

      public String getName()
      Getter for facet name.
      Returns:
      sName;

    • getDesignation

      public char getDesignation()
      Returns facet designation.
      Returns:
      cDesignation;

    • getDiagDesignation

      public String getDiagDesignation()
      Getter for facet designation, whether it is fixed or random, and Level (average sample size).
      Returns:
      sb.toString;

    • getDesignationString

      public String getDesignationString()
      Getter of cDesignation as String.
      Returns:
      String.valueOf(cDesignation);

    • getNested

      public Boolean getNested()
      Getter of 'nested status'.
      Returns:
      bIsNested;

    • getNestor

      public Character getNestor()
      Getter of 'Nestor'.
      Returns:
      cNestor;

    • getFixed

      public Boolean getFixed()
      Getter of 'Fixed' status.
      Returns:
      bFixed;

    • getOrder

      public Integer getOrder()
      Getter for facet order within sHDirectory.
      Returns:
      iOrder;

    • getFacetType

      public char getFacetType()
      Getter for facet type.
      Returns:
      cFacetType;

    • getFacetLevel

      public Double getFacetLevel()
      Getter for FacetLevel, the appropriate sample size average for a given facet, used in D-Studies.
      Returns:
      Double value of level

    • starred

      public Boolean starred()
      Getter for presence of facet asterisk.
      Returns:
      bAsterisk;

    • setFacetLevel

      public void setFacetLevel()
      Calculates levels for G studies for facets of generalization: simple mean of sample sizes for 1 level of nesting, harmonic mean for higher levels of nesting.

    • setdFacetLevel

      public void setdFacetLevel(Double _dLevel)
      Setter of FacetLevel (Double).
      Parameters:
      _dLevel - ;

    • dGetLevel

      public Double dGetLevel()
      Getter of FacetLevel (Double).
      Returns:
      dFacetLevel;

    • doNesting

      public void doNesting(String sComponent)
      Sets up nesting configuration based on the nesting input, this method determines the nestor/nestees relationships
      Parameters:
      sComponent - ;

    • addNestee

      public void addNestee(char cNestee)
      adds 'Nestee', facets nested in the current facet.
      Parameters:
      cNestee - ;