org.yamcs.xtce

Class AbstractFileLoader

java.lang.Object

org.yamcs.xtce.AbstractFileLoader

All Implemented Interfaces:

DatabaseLoader, SpaceSystemLoader

Direct Known Subclasses:

SpreadsheetLoader

public abstract class AbstractFileLoader
extends Object
implements SpaceSystemLoader

Abstract class for MDB loaders that load data from files (or directories with files)

Author:

nm

Field Summary

Fields

Modifier and Type	Field and Description
protected String	configName
protected org.slf4j.Logger	log
protected String	path

Constructor Summary

Constructors

Constructor and Description
AbstractFileLoader(String path)

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.
boolean	needsUpdate(RandomAccessFile consistencyDateFile)
void	writeConsistencyDate(FileWriter consistencyDateFile)

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

Field Detail

log

protected final org.slf4j.Logger log

configName

protected String configName

path

protected String path

Constructor Detail

AbstractFileLoader

public AbstractFileLoader(String path)
                   throws ConfigurationException

Throws:

ConfigurationException

Method Detail

needsUpdate

public boolean needsUpdate(RandomAccessFile consistencyDateFile)
                    throws IOException,
                           ConfigurationException

Specified by:

needsUpdate in interface DatabaseLoader

Parameters:

consistencyDateFile - check in this file when the last databse has been loaded

Returns:

if this loader has to reload the database from its source

Throws:

IOException - if the consistencyDateFile can not be read for some reason

ConfigurationException

writeConsistencyDate

public void writeConsistencyDate(FileWriter consistencyDateFile)
                          throws IOException

Specified by:

writeConsistencyDate in interface DatabaseLoader

Parameters:

consistencyDateFile - the file in which the consistency date should be written

Throws:

IOException - if the consistency date file can't be written for some reason

getConfigName

public String getConfigName()
                     throws ConfigurationException

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

Returns:

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

Throws:

ConfigurationException - in case some of the configuration properties do not exist