org.yamcs.xtce

Class XtceLoader

java.lang.Object

org.yamcs.xtce.XtceLoader

All Implemented Interfaces:

DatabaseLoader, SpaceSystemLoader

public class XtceLoader
extends Object
implements SpaceSystemLoader

XTCE XML loader

Author:

mu

Constructor Summary

Constructors

Constructor and Description
XtceLoader(Map<String,Object> config)
XtceLoader(String xtceFileName) Constructor

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.
SpaceSystem	load() loads the SpaceSystem database in memory.
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

Constructor Detail

XtceLoader

public XtceLoader(String xtceFileName)

Constructor

XtceLoader

public XtceLoader(Map<String,Object> config)

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

load

public SpaceSystem load()
                 throws ConfigurationException,
                        DatabaseLoadException

Description copied from interface: SpaceSystemLoader

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

Specified by:

load in interface SpaceSystemLoader

Throws:

DatabaseLoadException

ConfigurationException

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

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