net.sf.flatpack

Interface Record

All Known Subinterfaces:

DataSet

All Known Implementing Classes:

BuffReaderDataSet, DefaultDataSet, RowRecord

public interface Record

Since:

3.4

Method Summary

Modifier and Type	Method and Description
boolean	contains(String column) Does this DataSet contain a column with the given name?
BigDecimal	getBigDecimal(String column) Returns the BigDecimal value of a specified column
BigDecimal	getBigDecimal(String column, Supplier<BigDecimal> defaultSupplier) Returns the BigDecimal value of a specified column
String[]	getColumns() Returns a String array of column names in the DataSet.
String[]	getColumns(String recordID) Returns a String array of column names in the DataSet for a given <RECORD> id
Date	getDate(String column) Returns the date value of a specified column.
Date	getDate(String column, SimpleDateFormat sdf) Returns the date value of a specified column.
Date	getDate(String column, SimpleDateFormat sdf, Supplier<Date> defaultSupplier) Returns the date value of a specified column.
Date	getDate(String column, Supplier<Date> defaultSupplier) Returns the date value of a specified column.
double	getDouble(String column) Returns the double value of a specified column
double	getDouble(String column, DoubleSupplier defaultSupplier) Returns the double value of a specified column
int	getInt(String column) Returns the integer value of a specified column
int	getInt(String column, IntSupplier defaultSupplier) Returns the integer value of a specified column
LocalDate	getLocalDate(String column) Returns the local date value of a specified column.
LocalDate	getLocalDate(String column, DateTimeFormatter formatter) Returns the local date value of a specified column.
LocalDate	getLocalDate(String column, String dateFormat) Returns the lcoal date value of a specified column.
LocalDate	getLocalDate(String column, String dateFormat, Supplier<LocalDate> defaultSupplier) Returns the local date value of a specified column.
LocalDate	getLocalDate(String column, Supplier<LocalDate> defaultSupplier) Returns the date value of a specified column.
long	getLong(String column) Returns the long value of a specified column
long	getLong(String column, LongSupplier defaultSupplier) Returns the long value of a specified column
Object	getObject(String column, Class<?> classToConvertTo) Returns the value of the column with the type of object specified
String	getRawData()
String	getRecordID() Show the record ID (default is 'detail')
int	getRowNo() Returns the line number the pointer is on.
String	getString(String column) Returns the string value of a specified column
String	getString(String column, Supplier<String> defaultSupplier) Returns the string value of a specified column
boolean	isRecordID(String recordID) Checks to see if the row has the given <RECORD> id
boolean	isRowEmpty() Checks to see if there was no data on the row which was parsed.

Method Detail

getString

String getString(String column)

Returns the string value of a specified column

Parameters:

column - - Name of the column

Returns:

String

getString

String getString(String column,
                 Supplier<String> defaultSupplier)

Returns the string value of a specified column

Parameters:

column - - Name of the column

defaultSupplier - for default value if result in column is null/empty

Returns:

String

Throws:

NoSuchElementException - if col does not exist

Since:

4.0

getDouble

double getDouble(String column,
                 DoubleSupplier defaultSupplier)

Returns the double value of a specified column

Parameters:

column - - Name of the column

defaultSupplier - for default value if result in column is null/empty

Returns:

double

Throws:

NoSuchElementException - if no such record

NumberFormatException - if wrong number format

Since:

4.0

getDouble

double getDouble(String column)

Returns the double value of a specified column

Parameters:

column - - Name of the column

Returns:

double

Throws:

NoSuchElementException - if no such record

NumberFormatException - if wrong number format

getBigDecimal

BigDecimal getBigDecimal(String column,
                         Supplier<BigDecimal> defaultSupplier)

Returns the BigDecimal value of a specified column

Parameters:

column - - Name of the column

defaultSupplier - for default value if result in column is null/empty

Returns:

BigDecimal

Throws:

NoSuchElementException - if no such record

NumberFormatException - if wrong number format

Since:

4.0

getBigDecimal

BigDecimal getBigDecimal(String column)

Returns the BigDecimal value of a specified column

Parameters:

column - - Name of the column

Returns:

BigDecimal

Throws:

NoSuchElementException - if no such record

NumberFormatException - if wrong number format

getInt

int getInt(String column,
           IntSupplier defaultSupplier)

Returns the integer value of a specified column

Parameters:

column - - Name of the column

defaultSupplier - for default value if result in column is null/empty

Returns:

double

Throws:

NoSuchElementException - if no such record

NumberFormatException - if wrong number format

Since:

4.0

getInt

int getInt(String column)

Returns the integer value of a specified column

Parameters:

column - - Name of the column

Returns:

double

Throws:

NoSuchElementException - if no such record

NumberFormatException - if wrong number format

getLong

long getLong(String column,
             LongSupplier defaultSupplier)

Returns the long value of a specified column

Parameters:

column - - Name of the column

defaultSupplier - for default value if result in column is null/empty

Returns:

long

Throws:

NoSuchElementException - if no such record

NumberFormatException - if wrong number format

Since:

4.0

getLong

long getLong(String column)

Returns the long value of a specified column

Parameters:

column - - Name of the column

Returns:

long

Throws:

NoSuchElementException - if no such record

NumberFormatException - if wrong number format

getDate

Date getDate(String column,
             Supplier<Date> defaultSupplier)
      throws ParseException

Returns the date value of a specified column. This assumes the date is in yyyyMMdd. If your date is not in this format, see getDate(String,SimpleDateFormat) Will return "null" on empty Strings

Parameters:

column - - Name of the column

defaultSupplier - for default value if result in column is null/empty

Returns:

Date

Throws:

ParseException - if date format incorect

Since:

4.0

getDate

Date getDate(String column)
      throws ParseException

Returns the date value of a specified column. This assumes the date is in yyyyMMdd. If your date is not in this format, see getDate(String,SimpleDateFormat) Will return "null" on empty Strings

Parameters:

column - - Name of the column

Returns:

Date

Throws:

ParseException - if date format incorrect

getDate

Date getDate(String column,
             SimpleDateFormat sdf,
             Supplier<Date> defaultSupplier)
      throws ParseException

Returns the date value of a specified column. This should be used if the date is NOT in yyyyMMdd format. The SimpleDateFormat object will specify what kind of format the date is in. Will return "null" on empty Strings

Parameters:

column - - Name of the column

sdf - - SimpleDateFormat of the date

defaultSupplier - for default value if result in column is null/empty

Returns:

Date

Throws:

ParseException

Since:

4.0

See Also:

SimpleDateFormat

getDate

Date getDate(String column,
             SimpleDateFormat sdf)
      throws ParseException

Returns the date value of a specified column. This should be used if the date is NOT in yyyyMMdd format. The SimpleDateFormat object will specify what kind of format the date is in. Will return "null" on empty Strings

Parameters:

column - - Name of the column

sdf - - SimpleDateFormat of the date

Returns:

Date

Throws:

ParseException - if date format does not match the SimpleDateFormat

See Also:

SimpleDateFormat

getLocalDate

LocalDate getLocalDate(String column,
                       Supplier<LocalDate> defaultSupplier)
                throws ParseException

Returns the date value of a specified column. This assumes the date is in yyy-mm-dd. If your date is not in this format, see getDate(String,SimpleDateFormat) Will return "null" on empty Strings

Parameters:

column - - Name of the column

defaultSupplier - for default value if result in column is null/empty

Returns:

Date

Throws:

ParseException - if date format does not match

Since:

4.0

getLocalDate

LocalDate getLocalDate(String column)
                throws ParseException

Returns the local date value of a specified column. This assumes the date is in yyyy-MM-dd. If your date is not in this format, see getLocalDate(String,SimpleDateFormat) Will return "null" on empty Strings

Parameters:

column - - Name of the column

Returns:

Date

Throws:

ParseException - if date format does not match

getLocalDate

LocalDate getLocalDate(String column,
                       DateTimeFormatter formatter)
                throws ParseException

Returns the local date value of a specified column. This assumes the date is in yyyy-MM-dd. If your date is not in this format, see getLocalDate(String,SimpleDateFormat) Will return "null" on empty Strings

Parameters:

column - - Name of the column formatter - formatter for the date parsing

Returns:

Date

Throws:

ParseException - if date format does not match

getLocalDate

LocalDate getLocalDate(String column,
                       String dateFormat,
                       Supplier<LocalDate> defaultSupplier)
                throws ParseException

Returns the local date value of a specified column. This should be used if the date is NOT in yyyyMMdd format. The SimpleDateFormat object will specify what kind of format the date is in. Will return "null" on empty Strings

Parameters:

column - - Name of the column

dateFormat - - dateFormat of the date

defaultSupplier - for default value if result in column is null/empty

Returns:

Date

Throws:

ParseException - if date format does not match

Since:

4.0

See Also:

SimpleDateFormat

getLocalDate

LocalDate getLocalDate(String column,
                       String dateFormat)
                throws ParseException

Returns the lcoal date value of a specified column. This should be used if the date is NOT in yyy-mm-dd format. The SimpleDateFormat object will specify what kind of format the date is in. Will return "null" on empty Strings

Parameters:

column - - Name of the column

dateFormat - - dateFormat of the date

Returns:

Date

Throws:

ParseException - if date format does not match

See Also:

SimpleDateFormat

getObject

Object getObject(String column,
                 Class<?> classToConvertTo)

Returns the value of the column with the type of object specified

Parameters:

column - Name of the column

classToConvertTo - Class type to convert to

Returns:

Object Value of the column in the specified object

getColumns

String[] getColumns()

Returns a String array of column names in the DataSet. This will assume 'detail' <RECORD> ID.

Returns:

String[]

getColumns

String[] getColumns(String recordID)

Returns a String array of column names in the DataSet for a given <RECORD> id

Parameters:

recordID -

Returns:

String[]

getRowNo

int getRowNo()

Returns the line number the pointer is on. These are the actual line numbers from the flat file, before any sorting.

Returns:

int

Throws:

NoSuchElementException

NumberFormatException

isRecordID

boolean isRecordID(String recordID)

Checks to see if the row has the given <RECORD> id

Parameters:

recordID -

Returns:

boolean

getRecordID

String getRecordID()

Show the record ID (default is 'detail')

Returns:

the record ID (default is 'detail')

contains

boolean contains(String column)

Does this DataSet contain a column with the given name?

Parameters:

column - Column name to check for

Returns:

boolean true if the row contain that column name.

isRowEmpty

boolean isRowEmpty()

Checks to see if there was no data on the row which was parsed. This will thrown an exception if Parser.FlagEmptyRows() is not set to true.

Returns:

true if the row has no data

getRawData

String getRawData()

Returns:

the raw data used to create this Row in the DataSet. Parser.setStoreRawDataToDataSet(true) must be specified before calling this method.