fr.cnes.genius.vts

Class AbstractVTSWriter

java.lang.Object

fr.cnes.genius.vts.AbstractVTSWriter

Direct Known Subclasses:

VTSATTWriter, VTSEPHWriter, VTSEVEWriter, VTSMEMWriter

public abstract class AbstractVTSWriter
extends Object

Abstract Result Writer.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractVTSWriter.ColumnId Column identifiers.

Constructor Summary

Constructors

Constructor and Description
AbstractVTSWriter(File resultFilePath) This method initialise the ResultWriter.

Method Summary

Modifier and Type	Method and Description
protected void	addColumn(AbstractVTSWriter.ColumnId columnId) Add a column to the output file.
void	addValue(AbstractVTSWriter.ColumnId columnId, Object value) This method adds a value to a column.
void	close() This method closes the output stream.
File	getResultFilePath() Get the output file.
protected boolean	isHeaderWritten() Get the header that has been written.
protected void	open(VTSHeaderInfo headerInfo) This method opens the result file.
void	setDoubleFormatParams(int size, int precission) Set the double format size and preccission.
protected void	writef(boolean writeEOL, String format, Object... args) Write a line with format.
protected abstract void	writeHeader(VTSHeaderInfo headerInfo) Write Header.
protected void	writeHeaderComment(VTSHeaderInfo headerInfo, VTSHeaderInfo.VTSHeaderItemIterface headerItem) Write a header comment.
protected void	writeHeaderField(VTSHeaderInfo headerInfo, VTSHeaderInfo.VTSHeaderItemIterface headerItem) Write a header item.
void	writeLine() This method writes a line with the values for each column.
protected void	writeLn() This method writes as a printf in the output stream.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractVTSWriter

public AbstractVTSWriter(File resultFilePath)

This method initialise the ResultWriter.

Parameters:

resultFilePath - Path of the file where values will be written.

Method Detail

setDoubleFormatParams

public void setDoubleFormatParams(int size,
                                  int precission)

Set the double format size and preccission.

Parameters:

size - double format size.

precission - double format precission.

getResultFilePath

public File getResultFilePath()

Get the output file.

Returns:

the output file.

addColumn

protected void addColumn(AbstractVTSWriter.ColumnId columnId)
                  throws GVTSException

Add a column to the output file.

Parameters:

columnId - The ID of the column.

Throws:

GVTSException - When the header is already written.

addValue

public void addValue(AbstractVTSWriter.ColumnId columnId,
                     Object value)

This method adds a value to a column.

Parameters:

columnId - The ID of the column.

value - The Value to enter in the column.

open

protected void open(VTSHeaderInfo headerInfo)
             throws GVTSException

This method opens the result file.

Parameters:

headerInfo - header information fields.

Throws:

GVTSException - If the input stream cannot be open.

writeHeader

protected abstract void writeHeader(VTSHeaderInfo headerInfo)

Write Header.

Parameters:

headerInfo - header information fields.

writeLine

public void writeLine()
               throws GVTSException

This method writes a line with the values for each column.

Throws:

GVTSException - If the results cannot be written.

close

public void close()

This method closes the output stream.

writeLn

protected void writeLn()

This method writes as a printf in the output stream.

writef

protected void writef(boolean writeEOL,
                      String format,
                      Object... args)

Write a line with format.

Parameters:

writeEOL - write end of line.

format - format string.

args - arguments.

writeHeaderField

protected void writeHeaderField(VTSHeaderInfo headerInfo,
                                VTSHeaderInfo.VTSHeaderItemIterface headerItem)

Write a header item. It the field value is null and the field is required a GRuntimeException is thrown.

Parameters:

headerInfo - header info map.

headerItem - item to write.

writeHeaderComment

protected void writeHeaderComment(VTSHeaderInfo headerInfo,
                                  VTSHeaderInfo.VTSHeaderItemIterface headerItem)

Write a header comment. It the field value is null and the field is required a GRuntimeException is thrown.

Parameters:

headerInfo - header info map.

headerItem - item to write.

isHeaderWritten

protected boolean isHeaderWritten()

Get the header that has been written.

Returns:

Written header.