net.sf.flatpack

Class DefaultDataSet

java.lang.Object

net.sf.flatpack.DefaultDataSet

All Implemented Interfaces:

DataSet, Record, RecordDataSet

Direct Known Subclasses:

BuffReaderDataSet

public class DefaultDataSet
extends Object
implements DataSet

Author:

Benoit Xhenseval, Paul Zepernick

Constructor Summary

Constructors

Constructor and Description
DefaultDataSet(MetaData pzMetaData, Parser pzparser)

Method Summary

Modifier and Type	Method and Description
void	absolute(int localPointer) Sets the absolute position of the record pointer
void	addError(DataError dataError)
void	addRow(Row row)
void	clearAll() Clears both the errors and rows from memory
void	clearErrors() Clears out the parse errors from memory
void	clearRows() Clears out the rows in memory from the last parse.
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	getErrorCount() Returns total number of records which contained a parse error in the file.
List<DataError>	getErrors() Returns A Collection Of DataErrors that happened during processing
int	getIndex() Returns the index the pointer is on for the array
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 dtf) 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
MetaData	getMetaData()
Object	getObject(String column, Class<?> classToConvertTo) Returns the value of the column with the type of object specified
String	getRawData()
Optional<Record>	getRecord()
String	getRecordID() Show the record ID (default is 'detail')
int	getRowCount() Returns the total number of rows parsed in from the file
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
void	goBottom() Goes to the last record in the dataset
void	goTop() Goes to the top of the data set.
boolean	isAnError(int lineNo) Returns true or false as to whether or not the line number contains an error.
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.
boolean	next() Returns true if it has one more record.
void	orderRows(OrderBy ob) Orders the data by column(s) specified.
boolean	previous() Moves back to the previous record in the set return true if move was a success, false if not
void	remove() Removes a row from the dataset.
void	setLowerCase() Sets data in the DataSet to lowercase
void	setMetaData(MetaData metaData)
protected void	setPointer(int pointer)
void	setPZConvertProps(Properties props) Sets the properties from the pzconvert.properties file.
void	setStrictNumericParse(boolean strictNumericParse) Setting this to True will parse text as is and throw a NumberFormatException.
void	setUpperCase() Sets data in the DataSet to uppercase
void	setValue(String column, String value) Changes the value of the given column only for the given row which the pointer is currently sitting on.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultDataSet

public DefaultDataSet(MetaData pzMetaData,
                      Parser pzparser)

Method Detail

addRow

public void addRow(Row row)

addError

public void addError(DataError dataError)

getColumns

public String[] getColumns()

Description copied from interface: Record

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

Specified by:

getColumns in interface Record

Returns:

String[]

getColumns

public String[] getColumns(String recordID)

Description copied from interface: Record

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

Specified by:

getColumns in interface Record

Returns:

String[]

getDate

public Date getDate(String column)
             throws ParseException

Description copied from interface: Record

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

Specified by:

getDate in interface Record

Parameters:

column - - Name of the column

Returns:

Date

Throws:

ParseException - if date format incorrect

getDate

public Date getDate(String column,
                    SimpleDateFormat sdf)
             throws ParseException

Description copied from interface: Record

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

Specified by:

getDate in interface Record

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

getDouble

public double getDouble(String column)

Description copied from interface: Record

Returns the double value of a specified column

Specified by:

getDouble in interface Record

Parameters:

column - - Name of the column

Returns:

double

getBigDecimal

public BigDecimal getBigDecimal(String column)

Description copied from interface: Record

Returns the BigDecimal value of a specified column

Specified by:

getBigDecimal in interface Record

Parameters:

column - - Name of the column

Returns:

BigDecimal

getObject

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

Description copied from interface: Record

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

Specified by:

getObject in interface Record

Parameters:

column - Name of the column

classToConvertTo - Class type to convert to

Returns:

Object Value of the column in the specified object

getBigDecimal

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

Description copied from interface: Record

Returns the BigDecimal value of a specified column

Specified by:

getBigDecimal in interface Record

Parameters:

column - - Name of the column

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

Returns:

BigDecimal

getDate

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

Description copied from interface: Record

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

Specified by:

getDate in interface Record

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

See Also:

SimpleDateFormat

getDate

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

Description copied from interface: Record

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

Specified by:

getDate in interface Record

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

getDouble

public double getDouble(String column,
                        DoubleSupplier defaultSupplier)

Description copied from interface: Record

Returns the double value of a specified column

Specified by:

getDouble in interface Record

Parameters:

column - - Name of the column

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

Returns:

double

getInt

public int getInt(String column,
                  IntSupplier defaultSupplier)

Description copied from interface: Record

Returns the integer value of a specified column

Specified by:

getInt in interface Record

Parameters:

column - - Name of the column

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

Returns:

double

getLong

public long getLong(String column,
                    LongSupplier defaultSupplier)

Description copied from interface: Record

Returns the long value of a specified column

Specified by:

getLong in interface Record

Parameters:

column - - Name of the column

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

Returns:

long

getString

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

Description copied from interface: Record

Returns the string value of a specified column

Specified by:

getString in interface Record

Parameters:

column - - Name of the column

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

Returns:

String

getErrorCount

public int getErrorCount()

Description copied from interface: RecordDataSet

Returns total number of records which contained a parse error in the file.

Specified by:

getErrorCount in interface RecordDataSet

Returns:

int - Record Error Count

getErrors

public List<DataError> getErrors()

Description copied from interface: RecordDataSet

Returns A Collection Of DataErrors that happened during processing

Specified by:

getErrors in interface RecordDataSet

Returns:

Vector

getIndex

public int getIndex()

Description copied from interface: DataSet

Returns the index the pointer is on for the array

Specified by:

getIndex in interface DataSet

Returns:

int

getInt

public int getInt(String column)

Description copied from interface: Record

Returns the integer value of a specified column

Specified by:

getInt in interface Record

Parameters:

column - - Name of the column

Returns:

double

getLong

public long getLong(String column)

Description copied from interface: Record

Returns the long value of a specified column

Specified by:

getLong in interface Record

Parameters:

column - - Name of the column

Returns:

long

getRowCount

public int getRowCount()

Description copied from interface: DataSet

Returns the total number of rows parsed in from the file

Specified by:

getRowCount in interface DataSet

Returns:

int - Row Count

getRowNo

public int getRowNo()

Description copied from interface: Record

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

Specified by:

getRowNo in interface Record

Returns:

int

getString

public String getString(String column)

Description copied from interface: Record

Returns the string value of a specified column

Specified by:

getString in interface Record

Parameters:

column - - Name of the column

Returns:

String

setValue

public void setValue(String column,
                     String value)

Description copied from interface: DataSet

Changes the value of the given column only for the given row which the pointer is currently sitting on.

Specified by:

setValue in interface DataSet

Parameters:

column - Column name to set the value for

value - Value to change the column to

goBottom

public void goBottom()

Description copied from interface: DataSet

Goes to the last record in the dataset

Specified by:

goBottom in interface DataSet

goTop

public void goTop()

Description copied from interface: DataSet

Goes to the top of the data set. This will put the pointer one record before the first in the set. Next() will have to be called to get the first record after this call.

Specified by:

goTop in interface DataSet

isAnError

public boolean isAnError(int lineNo)

Description copied from interface: DataSet

Returns true or false as to whether or not the line number contains an error. The import will skip the line if it contains an error and it will not be processed

Specified by:

isAnError in interface DataSet

Parameters:

lineNo - - int line number

Returns:

boolean

next

public boolean next()

Description copied from interface: RecordDataSet

Returns true if it has one more record. false if not

Specified by:

next in interface RecordDataSet

Returns:

boolean

getRecord

public Optional<Record> getRecord()

Specified by:

getRecord in interface RecordDataSet

orderRows

public void orderRows(OrderBy ob)

Description copied from interface: DataSet

Orders the data by column(s) specified. This will reposition the cursor to the top of the DataSet when executed. This is currently not supported when specifying <RECORD> elements in the mapping. An exception will be thrown if this situation occurs

Specified by:

orderRows in interface DataSet

Parameters:

ob - - OrderBy object

See Also:

OrderBy, OrderColumn

previous

public boolean previous()

Description copied from interface: DataSet

Moves back to the previous record in the set return true if move was a success, false if not

Specified by:

previous in interface DataSet

Returns:

boolean

setLowerCase

public void setLowerCase()

Sets data in the DataSet to lowercase

Specified by:

setLowerCase in interface DataSet

setUpperCase

public void setUpperCase()

Sets data in the DataSet to uppercase

Specified by:

setUpperCase in interface DataSet

isRecordID

public boolean isRecordID(String recordID)

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

Specified by:

isRecordID in interface Record

Parameters:

recordID - record to check

Returns:

boolean true if current record is of recordID

getRecordID

public String getRecordID()

Description copied from interface: Record

Show the record ID (default is 'detail')

Specified by:

getRecordID in interface Record

Returns:

the record ID (default is 'detail')

absolute

public void absolute(int localPointer)

Sets the absolute position of the record pointer

Specified by:

absolute in interface DataSet

Parameters:

localPointer - - int

Throws:

IndexOutOfBoundsException - if wrong index

setStrictNumericParse

public void setStrictNumericParse(boolean strictNumericParse)

Setting this to True will parse text as is and throw a NumberFormatException. Setting to false, which is the default, will remove any non numeric charcter from the field. The remaining numeric chars's will be returned. If it is an empty string,or there are no numeric chars, 0 will be returned for getInt() and getDouble()

Specified by:

setStrictNumericParse in interface DataSet

Parameters:

strictNumericParse - The strictNumericParse to set.

remove

public void remove()

Description copied from interface: DataSet

Removes a row from the dataset. Once the row is removed the pointer will be sitting on the record previous to the deleted row.

Specified by:

remove in interface DataSet

setPZConvertProps

public void setPZConvertProps(Properties props)

Description copied from interface: DataSet

Sets the properties from the pzconvert.properties file. This file specifies the PZConverter implementation to use for a particular class

Specified by:

setPZConvertProps in interface DataSet

Parameters:

props - Property mapping for String to Object conversion

setPointer

protected void setPointer(int pointer)

Parameters:

pointer - the pointer to set

clearRows

public void clearRows()

Description copied from interface: DataSet

Clears out the rows in memory from the last parse.

Specified by:

clearRows in interface DataSet

clearAll

public void clearAll()

Description copied from interface: DataSet

Clears both the errors and rows from memory

Specified by:

clearAll in interface DataSet

clearErrors

public void clearErrors()

Description copied from interface: DataSet

Clears out the parse errors from memory

Specified by:

clearErrors in interface DataSet

getMetaData

public MetaData getMetaData()

setMetaData

public void setMetaData(MetaData metaData)

toString

public String toString()

Overrides:

toString in class Object

contains

public boolean contains(String column)

Description copied from interface: Record

Does this DataSet contain a column with the given name?

Specified by:

contains in interface Record

Parameters:

column - Column name to check for

Returns:

boolean true if the row contain that column name.

isRowEmpty

public boolean isRowEmpty()

Description copied from interface: Record

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.

Specified by:

isRowEmpty in interface Record

Returns:

true if the row has no data

Throws:

FPInvalidUsageException - Parser.isFlagEmptyRows() must be set to true before using this

FPException - if cursor is on an invalid row

getRawData

public String getRawData()

Specified by:

getRawData in interface Record

Returns:

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

Throws:

FPInvalidUsageException

FPException - if cursor is on an invalid row

getLocalDate

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

Description copied from interface: Record

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

Specified by:

getLocalDate in interface Record

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

getLocalDate

public LocalDate getLocalDate(String column)
                       throws ParseException

Description copied from interface: Record

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

Specified by:

getLocalDate in interface Record

Parameters:

column - - Name of the column

Returns:

Date

Throws:

ParseException - if date format does not match

getLocalDate

public LocalDate getLocalDate(String column,
                              DateTimeFormatter dtf)
                       throws ParseException

Description copied from interface: Record

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

Specified by:

getLocalDate in interface Record

Parameters:

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

Returns:

Date

Throws:

ParseException - if date format does not match

getLocalDate

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

Description copied from interface: Record

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

Specified by:

getLocalDate in interface Record

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

See Also:

SimpleDateFormat

getLocalDate

public LocalDate getLocalDate(String column,
                              String dateFormat)
                       throws ParseException

Description copied from interface: Record

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

Specified by:

getLocalDate in interface Record

Parameters:

column - - Name of the column

dateFormat - - dateFormat of the date

Returns:

Date

Throws:

ParseException - if date format does not match

See Also:

SimpleDateFormat