repicea.stats.data

Class GenericHierarchicalStatisticalDataStructure

java.lang.Object

repicea.stats.data.GenericStatisticalDataStructure

repicea.stats.data.GenericHierarchicalStatisticalDataStructure

All Implemented Interfaces:

HierarchicalStatisticalDataStructure, StatisticalDataStructure

Direct Known Subclasses:

GenericHierarchicalSpatialDataStructure

public class GenericHierarchicalStatisticalDataStructure
extends GenericStatisticalDataStructure
implements HierarchicalStatisticalDataStructure

This class is the basic class for hierarchical data structure.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,DataBlock>	hierarchicalStructure
protected java.util.Map<java.lang.String,Matrix>	matricesZ The string represents the hierarchical level.
protected java.util.Map<java.lang.String,java.util.List<java.lang.String>>	randomEffectsSpecifications

Fields inherited from class repicea.stats.data.GenericStatisticalDataStructure

dataSet, isInterceptModel, matrixX, vectorY

Constructor Summary

Constructors

Constructor and Description
GenericHierarchicalStatisticalDataStructure(DataSet dataSet) General constructor.

Method Summary

Modifier and Type	Method and Description
void	constructMatrices(java.lang.String modelDefinition) This method builds the matrices that are required to fit the model.
java.util.Map<java.lang.String,DataBlock>	getHierarchicalStructure() This method returns the index of the observations by levels and id within the level.
java.util.Set<java.lang.String>	getHierarchicalStructureLevel() This method returns the list of the different levels of the hierarchical structure.
java.util.Map<java.lang.String,Matrix>	getMatrixZ() This method returns a Map of Matrix instance.
boolean	isThereAnyHierarchicalStructure() Return true if the hierarchical structure has been set or false otherwise.
protected void	recordRandomEffects(java.lang.String effectName)
void	setHierarchicalStructureLevel(java.util.List<java.lang.String> hierarchicalStructureLevels) This method set the hierarchical structures of the data set.
protected void	setRandomEffectStructure()

Methods inherited from class repicea.stats.data.GenericStatisticalDataStructure

computeDummyVariables, getDataSet, getMatrixX, getNumberOfObservations, getVectorY, isInterceptModel, setInterceptModel

Methods inherited from class java.lang.Object

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

Methods inherited from interface repicea.stats.data.StatisticalDataStructure

getDataSet, getMatrixX, getNumberOfObservations, getVectorY, isInterceptModel, setInterceptModel

Field Detail

hierarchicalStructure

protected java.util.Map<java.lang.String,DataBlock> hierarchicalStructure

randomEffectsSpecifications

protected java.util.Map<java.lang.String,java.util.List<java.lang.String>> randomEffectsSpecifications

matricesZ

protected java.util.Map<java.lang.String,Matrix> matricesZ

The string represents the hierarchical level.

Constructor Detail

GenericHierarchicalStatisticalDataStructure

public GenericHierarchicalStatisticalDataStructure(DataSet dataSet)

General constructor. To be defined in derived class.

Parameters:

dataSet - a DataSet instance

Method Detail

constructMatrices

public void constructMatrices(java.lang.String modelDefinition)
                       throws StatisticalDataException

Description copied from interface: StatisticalDataStructure

This method builds the matrices that are required to fit the model.

Specified by:

constructMatrices in interface StatisticalDataStructure

Overrides:

constructMatrices in class GenericStatisticalDataStructure

Parameters:

modelDefinition - the definition of the model that serves to design the matrices

Throws:

StatisticalDataException

recordRandomEffects

protected void recordRandomEffects(java.lang.String effectName)
                            throws StatisticalDataException

Throws:

StatisticalDataException

setRandomEffectStructure

protected void setRandomEffectStructure()
                                 throws StatisticalDataException

Throws:

StatisticalDataException

getHierarchicalStructureLevel

public java.util.Set<java.lang.String> getHierarchicalStructureLevel()

Description copied from interface: HierarchicalStatisticalDataStructure

This method returns the list of the different levels of the hierarchical structure.

Specified by:

getHierarchicalStructureLevel in interface HierarchicalStatisticalDataStructure

Returns:

a Set of String instances

getHierarchicalStructure

public java.util.Map<java.lang.String,DataBlock> getHierarchicalStructure()

Description copied from interface: HierarchicalStatisticalDataStructure

This method returns the index of the observations by levels and id within the level.

Specified by:

getHierarchicalStructure in interface HierarchicalStatisticalDataStructure

Returns:

a Map instance that contains the outer subject levels as keys and DataBlock instances as values

setHierarchicalStructureLevel

public void setHierarchicalStructureLevel(java.util.List<java.lang.String> hierarchicalStructureLevels)
                                   throws StatisticalDataException

Description copied from interface: HierarchicalStatisticalDataStructure

This method set the hierarchical structures of the data set.

Specified by:

setHierarchicalStructureLevel in interface HierarchicalStatisticalDataStructure

Parameters:

hierarchicalStructureLevels - a List of Strings that contains the field names that serve as hierarchical index

Throws:

StatisticalDataException

isThereAnyHierarchicalStructure

public boolean isThereAnyHierarchicalStructure()

Description copied from interface: HierarchicalStatisticalDataStructure

Return true if the hierarchical structure has been set or false otherwise.

Specified by:

isThereAnyHierarchicalStructure in interface HierarchicalStatisticalDataStructure

Returns:

a boolean instance

getMatrixZ

public java.util.Map<java.lang.String,Matrix> getMatrixZ()

Description copied from interface: HierarchicalStatisticalDataStructure

This method returns a Map of Matrix instance. The key refers to the hierarchical level.

Specified by:

getMatrixZ in interface HierarchicalStatisticalDataStructure

Returns:

a Map instance