repicea.stats.data

Interface HierarchicalStatisticalDataStructure

All Superinterfaces:

StatisticalDataStructure

All Known Subinterfaces:

HierarchicalSpatialDataStructure

All Known Implementing Classes:

GenericHierarchicalSpatialDataStructure, GenericHierarchicalStatisticalDataStructure

public interface HierarchicalStatisticalDataStructure
extends StatisticalDataStructure

Method Summary

Modifier and Type	Method and Description
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.
void	setHierarchicalStructureLevel(java.util.List<java.lang.String> hierarchicalStructureLevels) This method set the hierarchical structures of the data set.

Methods inherited from interface repicea.stats.data.StatisticalDataStructure

constructMatrices, getDataSet, getMatrixX, getNumberOfObservations, getVectorY, isInterceptModel, setInterceptModel

Method Detail

getHierarchicalStructureLevel

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

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

Returns:

a Set of String instances

getHierarchicalStructure

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

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

Returns:

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

setHierarchicalStructureLevel

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

This method set the hierarchical structures of the data set.

Parameters:

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

Throws:

StatisticalDataException

isThereAnyHierarchicalStructure

boolean isThereAnyHierarchicalStructure()

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

Returns:

a boolean instance

getMatrixZ

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

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

Returns:

a Map instance