org.smooks.cartridges.flatfile.variablefield

Class VariableFieldRecordParser<T extends VariableFieldRecordParserFactory>

java.lang.Object

org.smooks.cartridges.flatfile.variablefield.VariableFieldRecordParser<T>

All Implemented Interfaces:

RecordParser<T>

Direct Known Subclasses:

RegexParser

public abstract class VariableFieldRecordParser<T extends VariableFieldRecordParserFactory>
extends Object
implements RecordParser<T>

Abstract variable field record parser.

Author:

tom.fennelly@gmail.com

Constructor Summary

Constructors

Constructor and Description
VariableFieldRecordParser()

Method Summary

Modifier and Type	Method and Description
T	getFactory() Get the parser factory instance that created this parser instance.
int	getRecordCount() Get the number of records read so far by this parser instance.
int	getUnignoredFieldCount(RecordMetaData recordMetaData) Get the unignored field count for the specified record.
void	initialize() Initialize the parser instance.
Record	nextRecord() Parse the next record from the message stream and produce a Record instance.
abstract List<String>	nextRecordFieldValues() Parse the next record from the flat file input stream and produce the set of record field values.
void	setRecordParserFactory(T factory) Set the parser factory that created the parser instance.
void	uninitialize() Uninitialize the parser instance.
protected void	validateHeader(List<String> headers)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.smooks.cartridges.flatfile.RecordParser

setDataSource

Constructor Detail

VariableFieldRecordParser

public VariableFieldRecordParser()

Method Detail

nextRecordFieldValues

public abstract List<String> nextRecordFieldValues()
                                            throws IOException

Parse the next record from the flat file input stream and produce the set of record field values.

Returns:

The next records field values.

Throws:

IOException - Error reading message stream.

setRecordParserFactory

public final void setRecordParserFactory(T factory)

Set the parser factory that created the parser instance.

Specified by:

setRecordParserFactory in interface RecordParser<T extends VariableFieldRecordParserFactory>

Parameters:

factory - The parser factory that created the parser instance.

initialize

public void initialize()
                throws IOException

Initialize the parser instance.

Specified by:

initialize in interface RecordParser<T extends VariableFieldRecordParserFactory>

Throws:

IOException - Error initializing the reader.

uninitialize

public void uninitialize()

Uninitialize the parser instance.

Specified by:

uninitialize in interface RecordParser<T extends VariableFieldRecordParserFactory>

getFactory

public T getFactory()

Get the parser factory instance that created this parser instance.

Returns:

The parser factory instance that created this parser instance.

getRecordCount

public int getRecordCount()

Get the number of records read so far by this parser instance.

Returns:

The number of records read so far by this parser instance.

nextRecord

public final Record nextRecord()
                        throws IOException

Parse the next record from the message stream and produce a Record instance.

Specified by:

nextRecord in interface RecordParser<T extends VariableFieldRecordParserFactory>

Returns:

The records instance.

Throws:

IOException - Error reading message stream.

getUnignoredFieldCount

public int getUnignoredFieldCount(RecordMetaData recordMetaData)

Get the unignored field count for the specified record.

Parameters:

recordMetaData - The record metadata.

Returns:

The unignored field count.

validateHeader

protected void validateHeader(List<String> headers)
                       throws IOException

Throws:

IOException