org.xtce.toolkit

Class XTCEDatabaseExporterCsv

java.lang.Object

org.xtce.toolkit.XTCEDatabaseExporter

org.xtce.toolkit.XTCEDatabaseExporterCsv

public class XTCEDatabaseExporterCsv
extends XTCEDatabaseExporter

The XTCEDatabaseExporterCsv class is a specific implementation of the XTCEDatabaseExporter abstract base class for the purpose of exporting TM parameters to a CSV file.

Field Summary

Fields inherited from class org.xtce.toolkit.XTCEDatabaseExporter

charEncoding_, db_, properties_

Constructor Summary

Constructors

Constructor and Description
XTCEDatabaseExporterCsv(XTCEDatabase db, Properties properties, Charset charEncoding) Constructor

Method Summary

Modifier and Type	Method and Description
List<String>	exportContainers(File outFile) Export the containers in the XTCE file represented by an XTCEDatabase object.
List<String>	exportParameters(File outFile) Export the parameters in the XTCE file represented by an XTCEDatabase object.
List<String>	exportTelecommands(File outFile) Export the telecommands in the XTCE file represented by an XTCEDatabase object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XTCEDatabaseExporterCsv

public XTCEDatabaseExporterCsv(XTCEDatabase db,
                               Properties properties,
                               Charset charEncoding)
                        throws XTCEDatabaseException

Constructor

Parameters:

db - XTCEDatabase object to export from.

properties - Properties object containing potential modifiers for use by this exporter. See additional information about this class regarding which modifiers are applicable.

charEncoding - Charset to encode the output text as.

Throws:

XTCEDatabaseException - in the event that the database or the properties objects are not usable (null in this case).

Method Detail

exportParameters

public List<String> exportParameters(File outFile)
                              throws XTCEDatabaseException

Export the parameters in the XTCE file represented by an XTCEDatabase object. The XTCEDatabase object is provided to the constructor of this class, along with a Properties object that contains modifier information.

Overrides:

exportParameters in class XTCEDatabaseExporter

Parameters:

outFile - File object to export to the data to.

Returns:

List containing 0 or more error/warning messages. For this CSV implementation, no messages are produced. In the event that there are filesystem errors, those will be thrown by exception.

Throws:

XTCEDatabaseException - thrown in the event that the file cannot be opened/written/etc.

exportContainers

public List<String> exportContainers(File outFile)
                              throws XTCEDatabaseException

Export the containers in the XTCE file represented by an XTCEDatabase object. The XTCEDatabase object is provided to the constructor of this class, along with a Properties object that contains modifier information.

Overrides:

exportContainers in class XTCEDatabaseExporter

Parameters:

outFile - File object to export to the data to.

Returns:

List containing 0 or more error/warning messages. For this CSV implementation, no messages are produced. In the event that there are filesystem errors, those will be thrown by exception.

Throws:

XTCEDatabaseException - thrown in the event that the file cannot be opened/written/etc.

exportTelecommands

public List<String> exportTelecommands(File outFile)
                                throws XTCEDatabaseException

Export the telecommands in the XTCE file represented by an XTCEDatabase object. The XTCEDatabase object is provided to the constructor of this class, along with a Properties object that contains modifier information.

Overrides:

exportTelecommands in class XTCEDatabaseExporter

Parameters:

outFile - File object to export to the data to.

Returns:

List containing 0 or more error/warning messages. For this CSV implementation, no messages are produced. In the event that there are filesystem errors, those will be thrown by exception.

Throws:

XTCEDatabaseException - thrown in the event that the file cannot be opened/written/etc.