Package org.yamcs.xtce.xlsv6

Class V6Loader

java.lang.Object

org.yamcs.xtce.AbstractFileLoader

org.yamcs.xtce.BaseSpreadsheetLoader

org.yamcs.xtce.xlsv6.V6LoaderBase

org.yamcs.xtce.xlsv6.V6Loader

All Implemented Interfaces:

SpaceSystemLoader

public class V6Loader
extends V6LoaderBase

This class loads database from excel spreadsheets.

Nested Class Summary

Nested classes/interfaces inherited from class org.yamcs.xtce.BaseSpreadsheetLoader

BaseSpreadsheetLoader.BasicPrefFactory, BaseSpreadsheetLoader.EnumerationDefinition, BaseSpreadsheetLoader.Range

Field Summary

Fields

Modifier and Type	Field	Description
protected HashMap<String,Calibrator>	calibrators
protected HashMap<String,List<ContextCalibrator>>	contextCalibrators
protected HashMap<String,BaseSpreadsheetLoader.EnumerationDefinition>	enumerations
protected HashSet<Parameter>	outputParameters
protected HashMap<String,Parameter>	parameters
protected SpaceSystem	rootSpaceSystem
protected HashMap<String,SpreadsheetLoadContext>	timeCalibContexts
protected HashMap<String,String>	timeCalibEpochs
protected HashMap<String,String>	timeCalibScales

Fields inherited from class org.yamcs.xtce.xlsv6.V6LoaderBase

IDX_CMD_ARG_ASSIGNMENT, IDX_CMD_ARGNAME, IDX_CMD_CALIBRATION, IDX_CMD_DEFVALUE, IDX_CMD_DESCRIPTION, IDX_CMD_ENCODING, IDX_CMD_ENGTYPE, IDX_CMD_ENGUNIT, IDX_CMD_FLAGS, IDX_CMD_NAME, IDX_CMD_PARENT, IDX_CMD_RANGEHIGH, IDX_CMD_RANGELOW, IDX_CMD_RAWTYPE, IDX_CMD_RELPOS, IDX_CMDOPT_NAME, IDX_CMDOPT_SIGNIFICANCE, IDX_CMDOPT_SIGNIFICANCE_REASON, IDX_CMDOPT_TXCONST, IDX_CMDOPT_TXCONST_TIMEOUT, IDX_CMDVERIF_CHECKWINDOW, IDX_CMDVERIF_CHECKWINDOW_RELATIVETO, IDX_CMDVERIF_NAME, IDX_CMDVERIF_ONFAIL, IDX_CMDVERIF_ONSUCCESS, IDX_CMDVERIF_ONTIMEOUT, IDX_CMDVERIF_STAGE, IDX_CMDVERIF_TEXT, IDX_CMDVERIF_TYPE, IDX_LOG_AUTHOR, IDX_LOG_DATE, IDX_LOG_MESSAGE, IDX_LOG_VERSION, IDX_PP_ALIAS, IDX_PP_GROUP, IDX_PP_UMI, PARAM_RAWTYPE_STRING_FIXED, PARAM_RAWTYPE_STRING_PREPENDED, PARAM_RAWTYPE_STRING_TERMINATED

Fields inherited from class org.yamcs.xtce.BaseSpreadsheetLoader

CALIB_TYPE_ENUMERATION, CALIB_TYPE_JAVA_EXPRESSION, CALIB_TYPE_POLYNOMIAL, CALIB_TYPE_SPLINE, CALIB_TYPE_TIME, CN_CALIB_CALIB1, CN_CALIB_CALIB2, CN_CALIB_DESCRIPTION, CN_CALIB_NAME, CN_CALIB_TYPE, ctx, enableXtceNameRestrictions, h, headers, PARAM_ENGTYPE_BINARY, PARAM_ENGTYPE_BOOLEAN, PARAM_ENGTYPE_DOUBLE, PARAM_ENGTYPE_ENUMERATED, PARAM_ENGTYPE_FLOAT, PARAM_ENGTYPE_INT32, PARAM_ENGTYPE_INT64, PARAM_ENGTYPE_STRING, PARAM_ENGTYPE_TIME, PARAM_ENGTYPE_UINT32, PARAM_ENGTYPE_UINT64, PARAM_RAWTYPE_BINARY, PARAM_RAWTYPE_BINARY_PREPENDED, PARAM_RAWTYPE_BINARY_TERMINATED, PARAM_RAWTYPE_BOOLEAN, PARAM_RAWTYPE_DOUBLE, PARAM_RAWTYPE_FLOAT, PARAM_RAWTYPE_INT, PARAM_RAWTYPE_STRING, PARAM_RAWTYPE_UINT, SHEET_ALARMS, SHEET_ALGORITHMS, SHEET_CALIBRATION, SHEET_CHANGELOG, SHEET_COMMANDOPTIONS, SHEET_COMMANDS, SHEET_COMMANDVERIFICATION, SHEET_CONTAINERS, SHEET_DERIVED_PARAMETERS, SHEET_GENERAL, SHEET_LOCAL_PARAMETERS, SHEET_TELEMETERED_PARAMETERS, workbook

Fields inherited from class org.yamcs.xtce.AbstractFileLoader

configName, log, path

Constructor Summary

Constructors

Constructor	Description
V6Loader(String filename)
V6Loader(YConfiguration config)
V6Loader(YConfiguration config, jxl.Workbook workbook)

Method Summary

Modifier and Type	Method	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.
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)

Methods inherited from class org.yamcs.xtce.xlsv6.V6LoaderBase

oldToNewEncoding, readHeaders

Methods inherited from class org.yamcs.xtce.BaseSpreadsheetLoader

findRange, getCell, getContent, getContent, getParameterReference, hasColumn, hasColumn, isCellEmpty, isEmptyOrCommentedOut, isRowEmpty, jumpToRow, loadWorkbook, parseByte, parseDouble, parseDouble, parseInt, parseInt, switchToSheet, validateNameType

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

Methods inherited from interface org.yamcs.xtce.SpaceSystemLoader

loadList

Field Detail

calibrators

protected HashMap<String,Calibrator> calibrators

contextCalibrators

protected HashMap<String,List<ContextCalibrator>> contextCalibrators

timeCalibEpochs

protected HashMap<String,String> timeCalibEpochs

timeCalibScales

protected HashMap<String,String> timeCalibScales

timeCalibContexts

protected HashMap<String,SpreadsheetLoadContext> timeCalibContexts

enumerations

protected HashMap<String,BaseSpreadsheetLoader.EnumerationDefinition> enumerations

parameters

protected HashMap<String,Parameter> parameters

outputParameters

protected HashSet<Parameter> outputParameters

rootSpaceSystem

protected SpaceSystem rootSpaceSystem

Constructor Detail

V6Loader

public V6Loader(YConfiguration config,
                jxl.Workbook workbook)

V6Loader

public V6Loader(YConfiguration config)

V6Loader

public V6Loader(String filename)

Method Detail

getConfigName

public String getConfigName()

Description copied from interface: SpaceSystemLoader

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 SpaceSystemLoader

Overrides:

getConfigName in class AbstractFileLoader

Returns:

a string to be used as the filename where the serialised 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)