org.omegahat.DataStructures.Data
Interface BasicFrameInt

All Superinterfaces:
Activable, Database
All Known Subinterfaces:
DataFrameInt

public interface BasicFrameInt
extends Database

Primitive, top-level interface for defining elementary methods for data frame concepts, such as subsetting, indexing by variable name.


Fields inherited from interface org.omegahat.Environment.Databases.Database
ALL, ASSIGN, ATTACH, DETACH, NULL_ENTRY, READ, READ_WRITE, REMOVE
 
Fields inherited from interface org.omegahat.Environment.Databases.Activable
ACTIVE, INACTIVE
 
Method Summary
 VariableInt addVariable(java.lang.String name, VariableInt var)
          Extract the specified variable identified by name.
 VariableInt getVariable(java.lang.String name)
          Extract the specified variable identified by name.
 java.lang.String[] getVariableNames()
          Return a (ordered) list of the names of the variables contained in this collection.
 long numObservations()
          Return the number of observations available in each of the variables.
 long numVariables()
          Return the number of variables contained in this frame.
 java.lang.String rowName(java.lang.String name, int which)
           
 java.lang.String[] rowNames()
          Returns an array of the identifiers of the row names.
 java.lang.String[] rowNames(java.io.InputStream stream)
           
 
Methods inherited from interface org.omegahat.Environment.Databases.Database
assign, attach, clear, detach, exists, get, getName, objects, remove, setName, size
 
Methods inherited from interface org.omegahat.Environment.Databases.Activable
getState, setState
 

Method Detail

getVariableNames

public java.lang.String[] getVariableNames()
Return a (ordered) list of the names of the variables contained in this collection.

numVariables

public long numVariables()
Return the number of variables contained in this frame.

numObservations

public long numObservations()
Return the number of observations available in each of the variables. This assumes that the variables have the same number of records/observations.

rowNames

public java.lang.String[] rowNames()
Returns an array of the identifiers of the row names.

rowNames

public java.lang.String[] rowNames(java.io.InputStream stream)
                            throws java.io.IOException

rowName

public java.lang.String rowName(java.lang.String name,
                                int which)

getVariable

public VariableInt getVariable(java.lang.String name)
Extract the specified variable identified by name.

addVariable

public VariableInt addVariable(java.lang.String name,
                               VariableInt var)
Extract the specified variable identified by name.