org.yamcs.xtce

Class SpreadsheetLoader

java.lang.Object

org.yamcs.xtce.AbstractFileLoader

org.yamcs.xtce.SpreadsheetLoader

All Implemented Interfaces:

DatabaseLoader, SpaceSystemLoader

public class SpreadsheetLoader
extends AbstractFileLoader

This class loads database from excel spreadsheets. Used for the Solar instruments for which the TM database is too complicated to store in the MDB.

Author:

nm, ddw

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	SpreadsheetLoader.EnumerationDefinition Temporary value holder for the enumeration definition (because enumerations are read before parameters, and reading sharing the same EPT among all parameters is not a good approach (think different alarm definitions)

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	CALIB_TYPE_ENUMERATION
protected static String	CALIB_TYPE_JAVA_EXPRESSION
protected static String	CALIB_TYPE_POLYNOMIAL
protected static String	CALIB_TYPE_SPLINE
protected HashMap<String,Calibrator>	calibrators
protected SpreadsheetLoadContext	ctx
protected HashMap<String,SpreadsheetLoader.EnumerationDefinition>	enumerations
protected static int	IDX_CMD_ARG_ASSIGNMENT
protected static int	IDX_CMD_ARGNAME
protected static int	IDX_CMD_CALIBRATION
protected static int	IDX_CMD_DEFVALUE
protected static int	IDX_CMD_DESCRIPTION
protected static int	IDX_CMD_ENGTYPE
protected static int	IDX_CMD_ENGUNIT
protected static int	IDX_CMD_FLAGS
protected static int	IDX_CMD_NAME
protected static int	IDX_CMD_PARENT
protected static int	IDX_CMD_RANGEHIGH
protected static int	IDX_CMD_RANGELOW
protected static int	IDX_CMD_RAWTYPE
protected static int	IDX_CMD_RELPOS
protected static int	IDX_CMD_SIZEINBITS
protected static int	IDX_CMDOPT_NAME
protected static int	IDX_CMDOPT_SIGNIFICANCE
protected static int	IDX_CMDOPT_SIGNIFICANCE_REASON
protected static int	IDX_CMDOPT_TXCONST
protected static int	IDX_CMDOPT_TXCONST_TIMEOUT
protected static int	IDX_CMDVERIF_CHECKWINDOW
protected static int	IDX_CMDVERIF_CHECKWINDOW_RELATIVETO
protected static int	IDX_CMDVERIF_NAME
protected static int	IDX_CMDVERIF_ONFAIL
protected static int	IDX_CMDVERIF_ONSUCCESS
protected static int	IDX_CMDVERIF_ONTIMEOUT
protected static int	IDX_CMDVERIF_STAGE
protected static int	IDX_CMDVERIF_TEXT
protected static int	IDX_CMDVERIF_TYPE
protected static int	IDX_LOG_DATE
protected static int	IDX_LOG_MESSAGE
protected static int	IDX_LOG_VERSION
protected static int	IDX_PP_ALIAS
protected static int	IDX_PP_GROUP
protected static int	IDX_PP_UMI
protected HashMap<String,String>	javaFormulas
protected HashSet<Parameter>	outputParameters
protected static String	PARAM_ENGTYPE_BINARY
protected static String	PARAM_ENGTYPE_BOOLEAN
protected static String	PARAM_ENGTYPE_DOUBLE
protected static String	PARAM_ENGTYPE_ENUMERATED
protected static String	PARAM_ENGTYPE_FLOAT
protected static String	PARAM_ENGTYPE_INT32
protected static String	PARAM_ENGTYPE_INT64
protected static String	PARAM_ENGTYPE_STRING
protected static String	PARAM_ENGTYPE_UINT32
protected static String	PARAM_ENGTYPE_UINT64
protected HashMap<String,Parameter>	parameters
protected HashSet<org.yamcs.xtce.SpreadsheetLoader.PotentialExtractionError>	potentialErrors
protected SpaceSystem	rootSpaceSystem
protected static String	SHEET_ALARMS
protected static String	SHEET_ALGORITHMS
protected static String	SHEET_CALIBRATION
protected static String	SHEET_CHANGELOG
protected static String	SHEET_COMMANDOPTIONS
protected static String	SHEET_COMMANDS
protected static String	SHEET_COMMANDVERIFICATION
protected static String	SHEET_CONTAINERS
protected static String	SHEET_DERIVED_PARAMETERS
protected static String	SHEET_GENERAL
protected static String	SHEET_LOCAL_PARAMETERS
protected static String	SHEET_TELEMETERED_PARAMETERS
protected jxl.Workbook	workbook

Fields inherited from class org.yamcs.xtce.AbstractFileLoader

configName, log, path

Constructor Summary

Constructors

Constructor and Description
SpreadsheetLoader(String filename)

Method Summary

Modifier and Type	Method and Description
String	getConfigName() The filename used to save the database after all the loaders have loaded it, is based on a concatenation of the config names returned by the loaders.
protected boolean	hasColumn(jxl.Cell[] cells, int idx)
protected jxl.Cell[]	jumpToRow(jxl.Sheet sheet, int row)
SpaceSystem	load() loads the SpaceSystem database in memory.
protected void	loadAlarmsSheet(SpaceSystem spaceSystem, String sheetName)
protected void	loadAlgorithmsSheet(SpaceSystem spaceSystem, String sheetName)
protected void	loadCalibrationSheet(SpaceSystem spaceSystem, String sheetName)
protected void	loadChangelogSheet(boolean required)
protected void	loadCommandOptionsSheet(SpaceSystem spaceSystem, String sheetName)
protected void	loadCommandSheet(SpaceSystem spaceSystem, String sheetName)
protected void	loadCommandVerificationSheet(SpaceSystem spaceSystem, String sheetName)
protected void	loadContainersSheet(SpaceSystem spaceSystem, String sheetName)
protected void	loadGeneralSheet(boolean required)
protected void	loadParametersSheet(SpaceSystem spaceSystem, String sheetName, DataSource dataSource)
protected void	loadSheets()
protected void	loadSpaceSystem(String sheetNamePrefix, SpaceSystem spaceSystem)
protected String	requireString(jxl.Cell[] cells, int column)
protected jxl.Sheet	switchToSheet(String sheetName, boolean required)

Methods inherited from class org.yamcs.xtce.AbstractFileLoader

needsUpdate, writeConsistencyDate

Methods inherited from class java.lang.Object

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

Field Detail

calibrators

protected HashMap<String,Calibrator> calibrators

javaFormulas

protected HashMap<String,String> javaFormulas

enumerations

protected HashMap<String,SpreadsheetLoader.EnumerationDefinition> enumerations

parameters

protected HashMap<String,Parameter> parameters

outputParameters

protected HashSet<Parameter> outputParameters

potentialErrors

protected HashSet<org.yamcs.xtce.SpreadsheetLoader.PotentialExtractionError> potentialErrors

ctx

protected SpreadsheetLoadContext ctx

SHEET_GENERAL

protected static final String SHEET_GENERAL

See Also:

Constant Field Values

SHEET_CHANGELOG

protected static final String SHEET_CHANGELOG

See Also:

Constant Field Values

SHEET_CALIBRATION

protected static final String SHEET_CALIBRATION

See Also:

Constant Field Values

SHEET_TELEMETERED_PARAMETERS

protected static final String SHEET_TELEMETERED_PARAMETERS

See Also:

Constant Field Values

SHEET_LOCAL_PARAMETERS

protected static final String SHEET_LOCAL_PARAMETERS

See Also:

Constant Field Values

SHEET_DERIVED_PARAMETERS

protected static final String SHEET_DERIVED_PARAMETERS

See Also:

Constant Field Values

SHEET_CONTAINERS

protected static final String SHEET_CONTAINERS

See Also:

Constant Field Values

SHEET_ALGORITHMS

protected static final String SHEET_ALGORITHMS

See Also:

Constant Field Values

SHEET_ALARMS

protected static final String SHEET_ALARMS

See Also:

Constant Field Values

SHEET_COMMANDS

protected static final String SHEET_COMMANDS

See Also:

Constant Field Values

SHEET_COMMANDOPTIONS

protected static final String SHEET_COMMANDOPTIONS

See Also:

Constant Field Values

SHEET_COMMANDVERIFICATION

protected static final String SHEET_COMMANDVERIFICATION

See Also:

Constant Field Values

IDX_PP_UMI

protected static final int IDX_PP_UMI

See Also:

Constant Field Values

IDX_PP_GROUP

protected static final int IDX_PP_GROUP

See Also:

Constant Field Values

IDX_PP_ALIAS

protected static final int IDX_PP_ALIAS

See Also:

Constant Field Values

IDX_CMD_NAME

protected static final int IDX_CMD_NAME

See Also:

Constant Field Values

IDX_CMD_PARENT

protected static final int IDX_CMD_PARENT

See Also:

Constant Field Values

IDX_CMD_ARG_ASSIGNMENT

protected static final int IDX_CMD_ARG_ASSIGNMENT

See Also:

Constant Field Values

IDX_CMD_FLAGS

protected static final int IDX_CMD_FLAGS

See Also:

Constant Field Values

IDX_CMD_ARGNAME

protected static final int IDX_CMD_ARGNAME

See Also:

Constant Field Values

IDX_CMD_RELPOS

protected static final int IDX_CMD_RELPOS

See Also:

Constant Field Values

IDX_CMD_SIZEINBITS

protected static final int IDX_CMD_SIZEINBITS

See Also:

Constant Field Values

IDX_CMD_ENGTYPE

protected static final int IDX_CMD_ENGTYPE

See Also:

Constant Field Values

IDX_CMD_RAWTYPE

protected static final int IDX_CMD_RAWTYPE

See Also:

Constant Field Values

IDX_CMD_DEFVALUE

protected static final int IDX_CMD_DEFVALUE

See Also:

Constant Field Values

IDX_CMD_ENGUNIT

protected static final int IDX_CMD_ENGUNIT

See Also:

Constant Field Values

IDX_CMD_CALIBRATION

protected static final int IDX_CMD_CALIBRATION

See Also:

Constant Field Values

IDX_CMD_RANGELOW

protected static final int IDX_CMD_RANGELOW

See Also:

Constant Field Values

IDX_CMD_RANGEHIGH

protected static final int IDX_CMD_RANGEHIGH

See Also:

Constant Field Values

IDX_CMD_DESCRIPTION

protected static final int IDX_CMD_DESCRIPTION

See Also:

Constant Field Values

IDX_CMDOPT_NAME

protected static final int IDX_CMDOPT_NAME

See Also:

Constant Field Values

IDX_CMDOPT_TXCONST

protected static final int IDX_CMDOPT_TXCONST

See Also:

Constant Field Values

IDX_CMDOPT_TXCONST_TIMEOUT

protected static final int IDX_CMDOPT_TXCONST_TIMEOUT

See Also:

Constant Field Values

IDX_CMDOPT_SIGNIFICANCE

protected static final int IDX_CMDOPT_SIGNIFICANCE

See Also:

Constant Field Values

IDX_CMDOPT_SIGNIFICANCE_REASON

protected static final int IDX_CMDOPT_SIGNIFICANCE_REASON

See Also:

Constant Field Values

IDX_CMDVERIF_NAME

protected static final int IDX_CMDVERIF_NAME

See Also:

Constant Field Values

IDX_CMDVERIF_STAGE

protected static final int IDX_CMDVERIF_STAGE

See Also:

Constant Field Values

IDX_CMDVERIF_TYPE

protected static final int IDX_CMDVERIF_TYPE

See Also:

Constant Field Values

IDX_CMDVERIF_TEXT

protected static final int IDX_CMDVERIF_TEXT

See Also:

Constant Field Values

IDX_CMDVERIF_CHECKWINDOW

protected static final int IDX_CMDVERIF_CHECKWINDOW

See Also:

Constant Field Values

IDX_CMDVERIF_CHECKWINDOW_RELATIVETO

protected static final int IDX_CMDVERIF_CHECKWINDOW_RELATIVETO

See Also:

Constant Field Values

IDX_CMDVERIF_ONSUCCESS

protected static final int IDX_CMDVERIF_ONSUCCESS

See Also:

Constant Field Values

IDX_CMDVERIF_ONFAIL

protected static final int IDX_CMDVERIF_ONFAIL

See Also:

Constant Field Values

IDX_CMDVERIF_ONTIMEOUT

protected static final int IDX_CMDVERIF_ONTIMEOUT

See Also:

Constant Field Values

IDX_LOG_VERSION

protected static final int IDX_LOG_VERSION

See Also:

Constant Field Values

IDX_LOG_DATE

protected static final int IDX_LOG_DATE

See Also:

Constant Field Values

IDX_LOG_MESSAGE

protected static final int IDX_LOG_MESSAGE

See Also:

Constant Field Values

CALIB_TYPE_ENUMERATION

protected static final String CALIB_TYPE_ENUMERATION

See Also:

Constant Field Values

CALIB_TYPE_POLYNOMIAL

protected static final String CALIB_TYPE_POLYNOMIAL

See Also:

Constant Field Values

CALIB_TYPE_SPLINE

protected static final String CALIB_TYPE_SPLINE

See Also:

Constant Field Values

CALIB_TYPE_JAVA_EXPRESSION

protected static final String CALIB_TYPE_JAVA_EXPRESSION

See Also:

Constant Field Values

PARAM_ENGTYPE_STRING

protected static final String PARAM_ENGTYPE_STRING

See Also:

Constant Field Values

PARAM_ENGTYPE_BOOLEAN

protected static final String PARAM_ENGTYPE_BOOLEAN

See Also:

Constant Field Values

PARAM_ENGTYPE_BINARY

protected static final String PARAM_ENGTYPE_BINARY

See Also:

Constant Field Values

PARAM_ENGTYPE_ENUMERATED

protected static final String PARAM_ENGTYPE_ENUMERATED

See Also:

Constant Field Values

PARAM_ENGTYPE_DOUBLE

protected static final String PARAM_ENGTYPE_DOUBLE

See Also:

Constant Field Values

PARAM_ENGTYPE_UINT32

protected static final String PARAM_ENGTYPE_UINT32

See Also:

Constant Field Values

PARAM_ENGTYPE_INT32

protected static final String PARAM_ENGTYPE_INT32

See Also:

Constant Field Values

PARAM_ENGTYPE_UINT64

protected static final String PARAM_ENGTYPE_UINT64

See Also:

Constant Field Values

PARAM_ENGTYPE_INT64

protected static final String PARAM_ENGTYPE_INT64

See Also:

Constant Field Values

PARAM_ENGTYPE_FLOAT

protected static final String PARAM_ENGTYPE_FLOAT

See Also:

Constant Field Values

workbook

protected jxl.Workbook workbook

rootSpaceSystem

protected SpaceSystem rootSpaceSystem

Constructor Detail

SpreadsheetLoader

public SpreadsheetLoader(String filename)

Method Detail

getConfigName

public String getConfigName()

Description copied from interface: DatabaseLoader

The filename used to save the database after all the loaders have loaded it, is based on a concatenation of the config names returned by the loaders. Thus if a loader can have multiple versions of the database, they should be saved in multiple files.

Specified by:

getConfigName in interface DatabaseLoader

Overrides:

getConfigName in class AbstractFileLoader

Returns:

a string to be used as the filename where the serialized instance will be stored.

load

public SpaceSystem load()

Description copied from interface: SpaceSystemLoader

loads the SpaceSystem database in memory. Some references may be unresolved

loadSheets

protected void loadSheets()
                   throws SpreadsheetLoadException

Throws:

SpreadsheetLoadException

loadSpaceSystem

protected void loadSpaceSystem(String sheetNamePrefix,
                               SpaceSystem spaceSystem)

loadGeneralSheet

protected void loadGeneralSheet(boolean required)

loadCalibrationSheet

protected void loadCalibrationSheet(SpaceSystem spaceSystem,
                                    String sheetName)

loadParametersSheet

protected void loadParametersSheet(SpaceSystem spaceSystem,
                                   String sheetName,
                                   DataSource dataSource)

loadContainersSheet

protected void loadContainersSheet(SpaceSystem spaceSystem,
                                   String sheetName)

loadCommandSheet

protected void loadCommandSheet(SpaceSystem spaceSystem,
                                String sheetName)

loadCommandOptionsSheet

protected void loadCommandOptionsSheet(SpaceSystem spaceSystem,
                                       String sheetName)

loadCommandVerificationSheet

protected void loadCommandVerificationSheet(SpaceSystem spaceSystem,
                                            String sheetName)

loadChangelogSheet

protected void loadChangelogSheet(boolean required)

loadAlgorithmsSheet

protected void loadAlgorithmsSheet(SpaceSystem spaceSystem,
                                   String sheetName)

loadAlarmsSheet

protected void loadAlarmsSheet(SpaceSystem spaceSystem,
                               String sheetName)

hasColumn

protected boolean hasColumn(jxl.Cell[] cells,
                            int idx)

switchToSheet

protected jxl.Sheet switchToSheet(String sheetName,
                                  boolean required)

jumpToRow

protected jxl.Cell[] jumpToRow(jxl.Sheet sheet,
                               int row)

requireString

protected String requireString(jxl.Cell[] cells,
                               int column)