Package com.redwood.agent.api.rtx

Class RTXReader

java.lang.Object

com.redwood.agent.api.rtx.RTXReader

All Implemented Interfaces:

RTXProducer, Closeable, AutoCloseable, Iterable<RTXRow>

public class RTXReader
extends Object
implements RTXProducer

Reader for RTX format.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RTXReader.StrictMode	Control over how strictly the specification is interpreted.

Constructor Summary

Constructors

Constructor	Description
RTXReader(InputStream newInputStream)
RTXReader(Reader newInputReader)
RTXReader(String filename)

Method Summary

Modifier and Type	Method	Description
void	close()
RTXMetadata	getMetadata()
int	getRowNumber()
RTXReader.StrictMode	getStrictMode()
boolean	hasNext()
Iterator<RTXRow>	iterator()
Iterator<RTXRow>	iterator(String... cols)	Return an iterator with a subset of columns.
RTXRow	next()
Iterable<RTXRow>	rows()	Return an Iterable for rows from the current position on, this can only be used to retrieve a single iterator.
Iterable<RTXRow>	rows(String... cols)	Return an Iterable for rows from the current position on, with a subset of columns, this can only be used to retrieve a single iterator.
void	setStrictMode(RTXReader.StrictMode newStrictMode)	Sets the RTXReader.StrictMode, that is, when this RTXProducer does support strictMode.
boolean	supportsStrictMode(RTXReader.StrictMode newStrictMode)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

RTXReader

public RTXReader(InputStream newInputStream)
          throws RTXReaderException,
                 RTXMetadataRuntimeException

Throws:

RTXReaderException

RTXMetadataRuntimeException

RTXReader

public RTXReader(Reader newInputReader)
          throws RTXReaderException,
                 RTXMetadataRuntimeException

Throws:

RTXReaderException

RTXMetadataRuntimeException

RTXReader

public RTXReader(String filename)
          throws FileNotFoundException,
                 RTXReaderException,
                 RTXMetadataRuntimeException

Throws:

FileNotFoundException

RTXReaderException

RTXMetadataRuntimeException

Method Detail

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface RTXProducer

getMetadata

public RTXMetadata getMetadata()

Specified by:

getMetadata in interface RTXProducer

Returns:

the metadata of the data, describing the column definitions and sources.

hasNext

public boolean hasNext()
                throws RTXReaderException

Specified by:

hasNext in interface RTXProducer

Returns:

true, when there is a next row, false otherwise

Throws:

RTXReaderException

next

public RTXRow next()
            throws RTXReaderException,
                   RTXMetadataRuntimeException,
                   RTXColumnRuntimeException

Specified by:

next in interface RTXProducer

Returns:

the next row.

Throws:

RTXReaderException

RTXMetadataRuntimeException

RTXColumnRuntimeException

getRowNumber

public int getRowNumber()

Specified by:

getRowNumber in interface RTXProducer

Returns:

the row-number of the current row. It starts with 0 and is increased by RTXProducer.hasNext(). The first row will have the row-number 1.

getStrictMode

public RTXReader.StrictMode getStrictMode()

Specified by:

getStrictMode in interface RTXProducer

setStrictMode

public void setStrictMode(RTXReader.StrictMode newStrictMode)

Description copied from interface: RTXProducer

Sets the RTXReader.StrictMode, that is, when this RTXProducer does support strictMode.

Specified by:

setStrictMode in interface RTXProducer

Parameters:

newStrictMode - the new mode

supportsStrictMode

public boolean supportsStrictMode(RTXReader.StrictMode newStrictMode)

Specified by:

supportsStrictMode in interface RTXProducer

iterator

public Iterator<RTXRow> iterator()

Specified by:

iterator in interface Iterable<RTXRow>

Specified by:

iterator in interface RTXProducer

rows

public Iterable<RTXRow> rows(String... cols)

Description copied from interface: RTXProducer

Return an Iterable for rows from the current position on, with a subset of columns, this can only be used to retrieve a single iterator.

Specified by:

rows in interface RTXProducer

Parameters:

cols - a list of columns

Returns:

an Iterable with a subset of columns.

rows

public Iterable<RTXRow> rows()

Description copied from interface: RTXProducer

Return an Iterable for rows from the current position on, this can only be used to retrieve a single iterator.

Specified by:

rows in interface RTXProducer

Returns:

an Iterable.

iterator

public Iterator<RTXRow> iterator(String... cols)

Description copied from interface: RTXProducer

Return an iterator with a subset of columns.

Specified by:

iterator in interface RTXProducer

Parameters:

cols - a list of columns

Returns:

an iterator with a subset of columns.