TextTableInput (reportengine 0.13.2 API)

java.lang.Object
- net.sf.reportengine.in.AbstractTableInput
- - net.sf.reportengine.in.TextTableInput

All Implemented Interfaces:

ColumnMetadataHolder, TableInput
```
public class TextTableInput
extends AbstractTableInput
implements ColumnMetadataHolder
```
Report input implementation for streams (files, urls, etc) backed by a java.io.BufferedReader
By default this implementation expects a comma (,) as data separator but you can use the #setSeparator(String) method to specify whatever separator you want

Since:

0.2

Author:

dragos balan (dragos dot balan at gmail dot com)

Field Summary
- Fields inherited from class net.sf.reportengine.in.AbstractTableInput
  DEFAULT_COLUMN_HEADER

Constructor Summary

Constructors
Constructor and Description
`TextTableInput()` empty text imput constructor.
`TextTableInput(InputStream is)` creates a report input for the given input stream using the utf-8 encoding and comma as data-separator
`TextTableInput(InputStream is, String separator)` creates a report input for the given InputStream using the utf-8 encoding and the specified data-separator
`TextTableInput(InputStream is, String separator, String encoding)` creates a report input for the given InputStream using the specified encoding and data-separator
`TextTableInput(InputStream is, String separator, String encoding, boolean firstLineIsHeader)` creates a report input for the given InputStream using the specified encoding and data-separator
`TextTableInput(Reader inReader)` creates a report-input based on the provided reader using comma as data-separator
`TextTableInput(Reader reader, String separator)` creates a report-input based on the provided reader and using separator to distinguish between data/columns
`TextTableInput(Reader inReader, String separator, boolean firstLineIsHeaderFlag)` creates a report-input based on the provided reader and using separator to distinguish between data/columns
`TextTableInput(String filePath)` creates a report input for the given file with comma as separator in the default encoding
`TextTableInput(String filePath, String separator)` Creates a report input from the given fileName (in the default encoding) using the separator
`TextTableInput(String filePath, String separator, String encoding)` Creates an input for the given fileName using the provided separator.
`TextTableInput(String filePath, String separator, String encoding, boolean firstLineIsHeader)` Creates an input for the given fileName using the provided separator.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` closes the input and releases all resources
`List<ColumnMetadata>`	`getColumnMetadata()` getter for columns metadata (column label/header, horizontal alignment, etc.)
`Reader`	`getInputReader()` returns the input reader
`String`	`getSeparator()` getter for separator
`boolean`	`hasMoreRows()` returns true if there are more rows to read otherwise false
`boolean`	`isFirstLineHeader()`
`List<Object>`	`nextRow()` returns the next row of data if any row available otherwise returns null You should combine this method with #hasMoreRows() or you can iterate through the rows until null is returned Example: while (input.hasMoreRows()) { Object[] dataRow = input.nextRow(); // do something with data }
`void`	`open()` prepares the reader for further usaga.
`void`	`setFilePath(String filePath)`
`void`	`setFirstLineHeader(boolean flag)`
`void`	`setInputReader(Reader reader)` registers the provided input reader
`void`	`setSeparator(String separator)` registers the data-separator which is used to differentiate among colums-data

Methods inherited from class net.sf.reportengine.in.AbstractTableInput
getStatus

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TextTableInput
```
public TextTableInput()
```
    empty text imput constructor. Please use one of the setInputReader(Reader)
  - TextTableInput
```
public TextTableInput(String filePath)
```
    creates a report input for the given file with comma as separator in the default encoding
    
    Parameters:
    
    filePath - the path name of the file containing data
    
    Throws:
    
    FileNotFoundException
  - TextTableInput
```
public TextTableInput(String filePath,
                      String separator)
```
    Creates a report input from the given fileName (in the default encoding) using the separator
    
    Parameters:
    
    filePath - path and filename
    
    separator - data-separator
  - TextTableInput
```
public TextTableInput(String filePath,
                      String separator,
                      String encoding)
```
    Creates an input for the given fileName using the provided separator. When reading the specified encoding is used.
    
    Parameters:
    
    filePath - the path of the file containing data
    
    separator - the separator used to identify data/column
    
    encoding - the encoding used when reading the file
    
    Throws:
    
    FileNotFoundException
  - TextTableInput
```
public TextTableInput(String filePath,
                      String separator,
                      String encoding,
                      boolean firstLineIsHeader)
```
    Creates an input for the given fileName using the provided separator. When reading the specified encoding is used.
    
    Parameters:
    
    filePath - the path of the file containing data
    
    separator - the separator used to identify data/column
    
    encoding - the encoding used when reading the file
    
    firstLineIsHeader - specifies whether the first line contains the column headers or not
  - TextTableInput
```
public TextTableInput(InputStream is)
```
    creates a report input for the given input stream using the utf-8 encoding and comma as data-separator
    
    Parameters:
    
    is - the input stream
  - TextTableInput
```
public TextTableInput(InputStream is,
                      String separator)
```
    creates a report input for the given InputStream using the utf-8 encoding and the specified data-separator
    
    Parameters:
    
    is - the input stream
    
    separator - data-separator
    
    Throws:
    
    UnsupportedEncodingException
  - TextTableInput
```
public TextTableInput(InputStream is,
                      String separator,
                      String encoding)
```
    creates a report input for the given InputStream using the specified encoding and data-separator
    
    Parameters:
    
    is - the input stream
    
    separator - data separator
    
    encoding - the encoding
    
    Throws:
    
    UnsupportedEncodingException
  - TextTableInput
```
public TextTableInput(InputStream is,
                      String separator,
                      String encoding,
                      boolean firstLineIsHeader)
```
    creates a report input for the given InputStream using the specified encoding and data-separator
    
    Parameters:
    
    is - the input stream
    
    separator - data separator
    
    encoding - the encoding
    
    encoding - this flag specifies whether or not the first line contains the column headers
    
    Throws:
    
    UnsupportedEncodingException
  - TextTableInput
```
public TextTableInput(Reader inReader)
```
    creates a report-input based on the provided reader using comma as data-separator
    
    Parameters:
    
    inReader - the reader
  - TextTableInput
```
public TextTableInput(Reader reader,
                      String separator)
```
    creates a report-input based on the provided reader and using separator to distinguish between data/columns
    
    Parameters:
    
    inReader - the reader
    
    separator - the separator used to identify data/columns
  - TextTableInput
```
public TextTableInput(Reader inReader,
                      String separator,
                      boolean firstLineIsHeaderFlag)
```
    creates a report-input based on the provided reader and using separator to distinguish between data/columns
    
    Parameters:
    
    inReader - the reader
    
    separator - the separator used to identify data/columns
    
    firstLineIsHeaderFlag - this flag specifies if the first line contains the column headers
- Method Detail
  - open
```
public void open()
```
    prepares the reader for further usaga. Actually this implementation already reads the first line in order to be prepared for calls to #hasMoreRows() and #nextRow()
    
    Specified by:
    
    open in interface TableInput
    
    Overrides:
    
    open in class AbstractTableInput
  - close
```
public void close()
```
    closes the input and releases all resources
    
    Specified by:
    
    close in interface TableInput
    
    Overrides:
    
    close in class AbstractTableInput
  - nextRow
```
public List<Object> nextRow()
```
    returns the next row of data if any row available otherwise returns null
    You should combine this method with #hasMoreRows() or you can iterate through the rows until null is returned
    Example:
```
 while (input.hasMoreRows()) {
     Object[] dataRow = input.nextRow();
     // do something with data
 }
 
```
    Specified by:
    
    nextRow in interface TableInput
    
    Returns:
    
    an array of data objects
  - hasMoreRows
```
public boolean hasMoreRows()
```
    returns true if there are more rows to read otherwise false
    
    Specified by:
    
    hasMoreRows in interface TableInput
    
    Returns:
    
    true if the input has more rows to return
  - getSeparator
```
public String getSeparator()
```
    getter for separator
    
    Returns:
    
    the
  - setSeparator
```
public void setSeparator(String separator)
```
    registers the data-separator which is used to differentiate among colums-data
    
    Parameters:
    
    separator - the data/column separator
  - setInputReader
```
public void setInputReader(Reader reader)
```
    registers the provided input reader
    
    Parameters:
    
    reader -
  - getInputReader
```
public Reader getInputReader()
```
    returns the input reader
    
    Returns:
    
    a reader
  - setFirstLineHeader
```
public void setFirstLineHeader(boolean flag)
```
    Parameters:
    
    flag -
  - isFirstLineHeader
```
public boolean isFirstLineHeader()
```
    Returns:
  - setFilePath
```
public void setFilePath(String filePath)
```
    Parameters:
    
    filePath - the filePath to set
  - getColumnMetadata
```
public List<ColumnMetadata> getColumnMetadata()
```
    Description copied from interface: ColumnMetadataHolder
    
    getter for columns metadata (column label/header, horizontal alignment, etc.)
    This is an optional method. If your input doesn't contain any meta data then return an empty array.
    
    Specified by:
    
    getColumnMetadata in interface ColumnMetadataHolder
    
    Returns:
    
    the column meta data if this input supports metadata otherwise an empty array

Class TextTableInput

Field Summary

Fields inherited from class net.sf.reportengine.in.AbstractTableInput

Constructor Summary

Method Summary

Methods inherited from class net.sf.reportengine.in.AbstractTableInput

Methods inherited from class java.lang.Object

Constructor Detail

TextTableInput

TextTableInput

TextTableInput

TextTableInput

TextTableInput

TextTableInput

TextTableInput

TextTableInput

TextTableInput

TextTableInput

TextTableInput

TextTableInput

Method Detail

open

close

nextRow

hasMoreRows

getSeparator

setSeparator

setInputReader

getInputReader

setFirstLineHeader

isFirstLineHeader

setFilePath

getColumnMetadata