Package org.yamcs.xtce

Class BaseSpreadsheetLoader

java.lang.Object

org.yamcs.xtce.AbstractFileLoader

org.yamcs.xtce.BaseSpreadsheetLoader

All Implemented Interfaces:

SpaceSystemLoader

Direct Known Subclasses:

SpreadsheetLoader, V6LoaderBase, V7LoaderBase

public abstract class BaseSpreadsheetLoader
extends AbstractFileLoader

Base for spreadsheet loader - this contains common properties for both V6 and V7 loaders.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

Modifier and Type	Field	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 static String	CALIB_TYPE_TIME
protected static String	CN_CALIB_CALIB1
protected static String	CN_CALIB_CALIB2
protected static String	CN_CALIB_DESCRIPTION
protected static String	CN_CALIB_NAME
protected static String	CN_CALIB_TYPE
protected static String	CN_CONTEXT
protected SpreadsheetLoadContext	ctx
protected boolean	enableXtceNameRestrictions
protected Map<String,Integer>	h
protected Map<String,Map<String,Integer>>	headers
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_TIME
protected static String	PARAM_ENGTYPE_UINT32
protected static String	PARAM_ENGTYPE_UINT64
protected static String	PARAM_RAWTYPE_BINARY
protected static String	PARAM_RAWTYPE_BINARY_PREPENDED
protected static String	PARAM_RAWTYPE_BINARY_TERMINATED
protected static String	PARAM_RAWTYPE_BOOLEAN
protected static String	PARAM_RAWTYPE_DOUBLE
protected static String	PARAM_RAWTYPE_FLOAT
protected static String	PARAM_RAWTYPE_INT
protected static String	PARAM_RAWTYPE_STRING
protected static String	PARAM_RAWTYPE_UINT
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	Description
BaseSpreadsheetLoader(String path)

Method Summary

Modifier and Type	Method	Description
protected static BaseSpreadsheetLoader.Range	findRange(jxl.Sheet sheet, int startRow, int col1, int col2)
protected jxl.Cell	getCell(jxl.Cell[] cells, String colName)
protected String	getContent(jxl.Cell[] cells, String colName)
protected String	getContent(jxl.Cell[] cells, String colName, String defaultValue)
static NameReference	getParameterReference(SpaceSystem spaceSystem, String paramName, boolean typeRequired)
protected boolean	hasColumn(jxl.Cell[] cells, int idx)
protected boolean	hasColumn(jxl.Cell[] cells, String colName)
protected static boolean	isCellEmpty(jxl.Cell[] cells, int col)
protected boolean	isEmptyOrCommentedOut(jxl.Cell[] cells)
protected static boolean	isRowEmpty(jxl.Cell[] cells)
protected jxl.Cell[]	jumpToRow(jxl.Sheet sheet, int row)
protected void	loadWorkbook()
protected static byte	parseByte(SpreadsheetLoadContext ctx, String s)
protected double	parseDouble(jxl.Cell cell)
protected static double	parseDouble(SpreadsheetLoadContext ctx, jxl.Cell cell)
protected int	parseInt(String s)
protected static int	parseInt(SpreadsheetLoadContext ctx, String s)
protected jxl.Sheet	switchToSheet(String sheetName, boolean required)
protected void	validateNameType(String name)

Methods inherited from class org.yamcs.xtce.AbstractFileLoader

getConfigName, 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

load, loadList

Field Detail

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

CN_CONTEXT

protected static final String CN_CONTEXT

See Also:

Constant Field Values

CN_CALIB_NAME

protected static final String CN_CALIB_NAME

See Also:

Constant Field Values

CN_CALIB_TYPE

protected static final String CN_CALIB_TYPE

See Also:

Constant Field Values

CN_CALIB_CALIB1

protected static final String CN_CALIB_CALIB1

See Also:

Constant Field Values

CN_CALIB_CALIB2

protected static final String CN_CALIB_CALIB2

See Also:

Constant Field Values

CN_CALIB_DESCRIPTION

protected static final String CN_CALIB_DESCRIPTION

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

CALIB_TYPE_TIME

protected static final String CALIB_TYPE_TIME

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

PARAM_ENGTYPE_TIME

protected static final String PARAM_ENGTYPE_TIME

See Also:

Constant Field Values

PARAM_RAWTYPE_FLOAT

protected static final String PARAM_RAWTYPE_FLOAT

See Also:

Constant Field Values

PARAM_RAWTYPE_INT

protected static final String PARAM_RAWTYPE_INT

See Also:

Constant Field Values

PARAM_RAWTYPE_UINT

protected static final String PARAM_RAWTYPE_UINT

See Also:

Constant Field Values

PARAM_RAWTYPE_DOUBLE

protected static final String PARAM_RAWTYPE_DOUBLE

See Also:

Constant Field Values

PARAM_RAWTYPE_BOOLEAN

protected static final String PARAM_RAWTYPE_BOOLEAN

See Also:

Constant Field Values

PARAM_RAWTYPE_BINARY

protected static final String PARAM_RAWTYPE_BINARY

See Also:

Constant Field Values

PARAM_RAWTYPE_BINARY_PREPENDED

protected static final String PARAM_RAWTYPE_BINARY_PREPENDED

See Also:

Constant Field Values

PARAM_RAWTYPE_BINARY_TERMINATED

protected static final String PARAM_RAWTYPE_BINARY_TERMINATED

See Also:

Constant Field Values

PARAM_RAWTYPE_STRING

protected static final String PARAM_RAWTYPE_STRING

See Also:

Constant Field Values

ctx

protected final SpreadsheetLoadContext ctx

workbook

protected jxl.Workbook workbook

enableXtceNameRestrictions

protected boolean enableXtceNameRestrictions

headers

protected Map<String,Map<String,Integer>> headers

h

protected Map<String,Integer> h

Constructor Detail

BaseSpreadsheetLoader

public BaseSpreadsheetLoader(String path)
                      throws ConfigurationException

Throws:

ConfigurationException

Method Detail

jumpToRow

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

loadWorkbook

protected void loadWorkbook()

switchToSheet

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

isEmptyOrCommentedOut

protected boolean isEmptyOrCommentedOut(jxl.Cell[] cells)

hasColumn

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

hasColumn

protected boolean hasColumn(jxl.Cell[] cells,
                            String colName)

parseInt

protected int parseInt(String s)

parseDouble

protected double parseDouble(jxl.Cell cell)

parseInt

protected static int parseInt(SpreadsheetLoadContext ctx,
                              String s)

parseDouble

protected static double parseDouble(SpreadsheetLoadContext ctx,
                                    jxl.Cell cell)

parseByte

protected static byte parseByte(SpreadsheetLoadContext ctx,
                                String s)

getContent

protected String getContent(jxl.Cell[] cells,
                            String colName)

getContent

protected String getContent(jxl.Cell[] cells,
                            String colName,
                            String defaultValue)

getCell

protected jxl.Cell getCell(jxl.Cell[] cells,
                           String colName)

findRange

protected static BaseSpreadsheetLoader.Range findRange(jxl.Sheet sheet,
                                                       int startRow,
                                                       int col1,
                                                       int col2)

isCellEmpty

protected static boolean isCellEmpty(jxl.Cell[] cells,
                                     int col)

isRowEmpty

protected static boolean isRowEmpty(jxl.Cell[] cells)

getParameterReference

public static NameReference getParameterReference(SpaceSystem spaceSystem,
                                                  String paramName,
                                                  boolean typeRequired)

validateNameType

protected void validateNameType(String name)