Package com.redwood.scheduler.api.rtx

Class RTXWriter

java.lang.Object

com.redwood.scheduler.api.rtx.RTXWriter

All Implemented Interfaces:

RTXConsumer, Closeable, AutoCloseable

public class RTXWriter
extends Object
implements RTXConsumer

Writer for RTX format.

Constructor Summary

Constructors

Constructor	Description
RTXWriter(OutputStream newOutputStream)
RTXWriter(Writer newWriter)
RTXWriter(String filename)

Method Summary

Modifier and Type	Method	Description
void	addColumn(RTXColumn column)	Add a new column with the name and type of an existing column, the column will be added to the end of this metadata (i.e.
void	addColumn(String columnName, RTXType columnType)	Add a new column with the specified name and type, the column will be added to the end of this metadata.
void	addColumn(String columnName, String columnType)	Add a new column with the specified name and type, the column will be added to the end of this metadata.
void	addColumns(Collection<RTXColumn> newColumns)	Add new columns based on the input columns, the columns will be added in the order that they occur in the list, to the end of this metadata (i.e.
void	addRow(RTXRow row)	Adds a row
void	addRow(Object[] data)	Adds a row with the supplied data, where the row will not have a key.
void	addRow(Object[] data, String key)	Adds a row with the supplied data and key.
void	addSource(RTXSource source)	Add a source to the RTXMetadata, which is set previously with RTXConsumer.setMetadata(RTXMetadata)
void	addSources(Collection<RTXSource> sources, String prefix)	Convenience method to add multiple sources, with a prefix, to the RTXMetadata, which is set previously with RTXConsumer.setMetadata(RTXMetadata)
void	close()
void	flush()	Write any cached data to the underlying output mechanism.
RTXMetadata	getMetadata()
int	getRowNumber()
void	setLogger(Logger newLog)	Replace the default logger with another Logger.
void	setMetadata(RTXMetadata newMetadata)	Sets the RTXMetadata.
void	setWriteComments(boolean newValue)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.redwood.scheduler.api.rtx.RTXConsumer

addSources, addSources, addSources, copyColumns, newRow

Constructor Detail

RTXWriter

public RTXWriter(OutputStream newOutputStream)
          throws RTXWriterException

Throws:

RTXWriterException

RTXWriter

public RTXWriter(Writer newWriter)
          throws RTXWriterException

Throws:

RTXWriterException

RTXWriter

public RTXWriter(String filename)
          throws RTXWriterException,
                 FileNotFoundException

Throws:

RTXWriterException

FileNotFoundException

Method Detail

setWriteComments

public void setWriteComments(boolean newValue)

setLogger

public void setLogger(Logger newLog)

Description copied from interface: RTXConsumer

Replace the default logger with another Logger.

Specified by:

setLogger in interface RTXConsumer

addColumn

public void addColumn(RTXColumn column)
               throws RTXMetadataRuntimeException,
                      RTXInRowDataRuntimeException,
                      RTXMetadataReadOnlyRuntimeException

Description copied from interface: RTXConsumer

Add a new column with the name and type of an existing column, the column will be added to the end of this metadata (i.e. the index of the input column is ignored).

Specified by:

addColumn in interface RTXConsumer

Parameters:

column - the column to get the name and type from.

Throws:

RTXMetadataRuntimeException - if an error occurs.

RTXInRowDataRuntimeException - when already data have been added. It is not allowed to add a new column to the RTXMetadata, when already RTXRows have been added.

RTXMetadataReadOnlyRuntimeException - if the metadata is read-only.

addColumn

public void addColumn(String columnName,
                      String columnType)
               throws RTXMetadataRuntimeException,
                      RTXInRowDataRuntimeException,
                      RTXMetadataReadOnlyRuntimeException

Description copied from interface: RTXConsumer

Add a new column with the specified name and type, the column will be added to the end of this metadata.

Specified by:

addColumn in interface RTXConsumer

Parameters:

columnName - the column name.

columnType - the column type.

Throws:

RTXMetadataRuntimeException - if an error occurs.

RTXInRowDataRuntimeException - when already data have been added. It is not allowed to add a new column to the RTXMetadata, when already RTXRows have been added.

RTXMetadataReadOnlyRuntimeException - if the metadata is read-only.

addColumn

public void addColumn(String columnName,
                      RTXType columnType)
               throws RTXMetadataRuntimeException,
                      RTXInRowDataRuntimeException,
                      RTXMetadataReadOnlyRuntimeException

Description copied from interface: RTXConsumer

Add a new column with the specified name and type, the column will be added to the end of this metadata.

Specified by:

addColumn in interface RTXConsumer

Parameters:

columnName - the column name.

columnType - the column type.

Throws:

RTXMetadataRuntimeException - if an error occurs.

RTXInRowDataRuntimeException - when already data have been added. It is not allowed to add a new column to the RTXMetadata, when already RTXRows have been added.

RTXMetadataReadOnlyRuntimeException - if the metadata is read-only.

addColumns

public void addColumns(Collection<RTXColumn> newColumns)
                throws RTXMetadataRuntimeException,
                       RTXMetadataReadOnlyRuntimeException

Description copied from interface: RTXConsumer

Add new columns based on the input columns, the columns will be added in the order that they occur in the list, to the end of this metadata (i.e. the index of on each input column is ignored).

Specified by:

addColumns in interface RTXConsumer

Parameters:

newColumns - the columns to get the name and type from.

Throws:

RTXMetadataRuntimeException - if an error occurs.

RTXMetadataReadOnlyRuntimeException - if the metadata is read-only.

addRow

public void addRow(Object[] data)
            throws RTXWriterException,
                   RTXColumnRuntimeException

Description copied from interface: RTXConsumer

Adds a row with the supplied data, where the row will not have a key.

Specified by:

addRow in interface RTXConsumer

Parameters:

data - the values for the different cells in the new row. When the row has more columns than supplied in data, then the rest of the cells will be empty.

Throws:

RTXWriterException

RTXColumnRuntimeException

addRow

public void addRow(Object[] data,
                   String key)
            throws RTXWriterException,
                   RTXColumnRuntimeException

Description copied from interface: RTXConsumer

Adds a row with the supplied data and key.

Specified by:

addRow in interface RTXConsumer

Parameters:

data -

key - the optional key of this row, which is only a label and can be used as reference to other data structures. No uniqueness is provided and keys cannot be used to access rows directly.

Throws:

RTXWriterException

RTXColumnRuntimeException

addRow

public void addRow(RTXRow row)
            throws RTXWriterException,
                   RTXColumnRuntimeException

Description copied from interface: RTXConsumer

Adds a row

Specified by:

addRow in interface RTXConsumer

Throws:

RTXWriterException

RTXColumnRuntimeException

addSource

public void addSource(RTXSource source)
               throws RTXMetadataRuntimeException,
                      RTXInRowDataRuntimeException,
                      RTXMetadataReadOnlyRuntimeException

Description copied from interface: RTXConsumer

Add a source to the RTXMetadata, which is set previously with RTXConsumer.setMetadata(RTXMetadata)

Specified by:

addSource in interface RTXConsumer

Throws:

RTXMetadataRuntimeException - if an error occurs.

RTXInRowDataRuntimeException - when already data have been added. It is not allowed to add a new source to the RTXMetadata, when already RTXRows have been added.

RTXMetadataReadOnlyRuntimeException - if the metadata is read-only.

See Also:

RTXConsumer.setMetadata(RTXMetadata)

addSources

public void addSources(Collection<RTXSource> sources,
                       String prefix)
                throws RTXMetadataRuntimeException,
                       RTXInRowDataRuntimeException,
                       RTXMetadataReadOnlyRuntimeException

Description copied from interface: RTXConsumer

Convenience method to add multiple sources, with a prefix, to the RTXMetadata, which is set previously with RTXConsumer.setMetadata(RTXMetadata)

Specified by:

addSources in interface RTXConsumer

Throws:

RTXMetadataRuntimeException - if an error occurs.

RTXInRowDataRuntimeException - when already data have been added. It is not allowed to add a new source to the RTXMetadata, when already RTXRows have been added.

RTXMetadataReadOnlyRuntimeException - if the metadata is read-only.

See Also:

RTXConsumer.addSource(RTXSource), RTXConsumer.setMetadata(RTXMetadata)

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface RTXConsumer

flush

public void flush()
           throws XMLStreamException

Description copied from interface: RTXConsumer

Write any cached data to the underlying output mechanism.

Specified by:

flush in interface RTXConsumer

Throws:

XMLStreamException

getMetadata

public RTXMetadata getMetadata()

Specified by:

getMetadata in interface RTXConsumer

Returns:

the RTXMetadata

See Also:

RTXConsumer.setMetadata(RTXMetadata)

setMetadata

public void setMetadata(RTXMetadata newMetadata)
                 throws RTXColumnRuntimeException,
                        RTXInRowDataRuntimeException

Description copied from interface: RTXConsumer

Sets the RTXMetadata. This is not allowed anymore, when data was already added, but needs to be set before any data is added.

Specified by:

setMetadata in interface RTXConsumer

Throws:

RTXColumnRuntimeException

RTXInRowDataRuntimeException - when already data have been added. It is not allowed to set new RTXMetadata, when already RTXRows have been added.

See Also:

RTXConsumer.getMetadata()

getRowNumber

public final int getRowNumber()

Specified by:

getRowNumber in interface RTXConsumer

Returns:

the current row number, i.e. the row number of added rows. Initially it returns 0, meaning no row has been added.