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.

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 HashMap<String,Calibrator>	calibrators
protected SpreadsheetLoadContext	ctx
protected HashMap<String,SpreadsheetLoader.EnumerationDefinition>	enumerations
protected HashMap<String,String>	javaFormulas
protected HashSet<Parameter>	outputParameters
protected HashMap<String,Parameter>	parameters
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 HashMap<String,String>	stringEncodings
protected jxl.Workbook	workbook

Fields inherited from class org.yamcs.xtce.AbstractFileLoader

configName, log, path

Constructor Summary

Constructors

Constructor and Description
SpreadsheetLoader(Map<String,Object> config)
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

stringEncodings

protected HashMap<String,String> stringEncodings

enumerations

protected HashMap<String,SpreadsheetLoader.EnumerationDefinition> enumerations

parameters

protected HashMap<String,Parameter> parameters

outputParameters

protected HashSet<Parameter> outputParameters

ctx

protected final 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

workbook

protected jxl.Workbook workbook

rootSpaceSystem

protected SpaceSystem rootSpaceSystem

Constructor Detail

SpreadsheetLoader

public SpreadsheetLoader(Map<String,Object> config)

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)