com.thelastcheck.io.base

Class RecordImpl

java.lang.Object

com.thelastcheck.io.base.RecordImpl

All Implemented Interfaces:

Record, Cloneable

public abstract class RecordImpl
extends Object
implements Record, Cloneable

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	INVALID_FIELD_NUMBER

Constructor Summary

Constructors

Constructor and Description
RecordImpl()
RecordImpl(ByteArray record)
RecordImpl(int recordLength, String encoding)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	allocateNewRecord(int currentLength, int newLength, int replaceLengthField, int replacedField) This is a routine that is used to allocate a new record for a field that has changed length.
Object	clone() clone this record, including the underlying ByteArray and it's wrapped bytes.
Object	duplicate() Create a copy of this record, including the underlying ByteArray, but keeping the same underlying bytes.
protected abstract Field	field(int fieldNumber) Get the field definition for a specified field based on the field number.
String	fieldName(int fieldNumber) The name of the field.
protected Object	getField(Field field)
Object	getField(int fieldNumber) The field value.
protected ByteArray	getFieldAsByteArray(Field field)
protected Date	getFieldAsDate(Field field)
protected Date	getFieldAsDate(Field field, TimeZone zone)
protected int	getFieldAsInt(Field field)
protected long	getFieldAsLong(Field field)
protected OnUsField	getFieldAsOnUsField(Field field)
protected RoutingNumber	getFieldAsRoutingNumber(Field field)
protected String	getFieldAsString(Field field)
protected Date	getFieldAsTime(Field field)
protected Date	getFieldAsTime(Field field, TimeZone zone)
int	length() This is the length of the current record.
abstract int	numberOfFields() The number of fields defined for this record.
long	offsetPosition() The offset of this record in an input stream.
Record	offsetPosition(long offset) This is used to set the current record offset of this record in the input stream.
ByteArray	record()
protected void	record(ByteArray record) Certain records are variable in size and can change size based on the values placed in the fields.
int	recordPosition() The position of this record in an input stream.
Record	recordPosition(int position) This is used to set the current record position of this record in the input stream.
protected abstract void	resetDynamicFields() This method is intended to allow the reset of dynamic fields back to their initial state.
protected void	setField(ByteArray value, Field field)
protected void	setField(int value, Field field)
Record	setField(int value, int fieldNumber) Set the contents of the field to the specified int value.
protected void	setField(long value, Field field)
Record	setField(long value, int fieldNumber) Set the contents of the field to the specified long value.
protected void	setField(OnUsField value, Field field)
protected void	setField(RoutingNumber value, Field field)
protected void	setField(String value, Field field)
Record	setField(String value, int fieldNumber) Set the contents of the field to the specified string value.
protected void	setFieldDate(Date value, Field field)
protected void	setFieldDate(Date value, Field field, TimeZone zone)
protected void	setFieldRight(String value, Field field)
protected void	setFieldTime(Date value, Field field)
protected void	setFieldTime(Date value, Field field, TimeZone zone)
String	toString()
String	toXml() Creates an XML representation of the record based on it's fields.
String	toXml(boolean useAttributes) Creates an XML representation of the record based on it's fields.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.thelastcheck.io.base.Record

clearRecord

Field Detail

INVALID_FIELD_NUMBER

protected static final String INVALID_FIELD_NUMBER

See Also:

Constant Field Values

Constructor Detail

RecordImpl

public RecordImpl()

RecordImpl

public RecordImpl(int recordLength,
          String encoding)

RecordImpl

public RecordImpl(ByteArray record)

Method Detail

clone

public Object clone()

Description copied from interface: Record

clone this record, including the underlying ByteArray and it's wrapped bytes.

Specified by:

clone in interface Record

Overrides:

clone in class Object

Returns:

cloned copy of this record

duplicate

public Object duplicate()

Description copied from interface: Record

Create a copy of this record, including the underlying ByteArray, but keeping the same underlying bytes. Changes to the duplicated version will change the bytes underlying the original and vice versa.

Specified by:

duplicate in interface Record

Returns:

duplicated copy of this record, but sharing the underlying bytes

getField

public Object getField(int fieldNumber)
                throws InvalidDataException

Description copied from interface: Record

The field value.

Specified by:

getField in interface Record

Returns:

An object containing the value of the field for the specified field number.

Throws:

InvalidDataException

setField

public Record setField(String value,
              int fieldNumber)

Description copied from interface: Record

Set the contents of the field to the specified string value.

Specified by:

setField in interface Record

setField

public Record setField(long value,
              int fieldNumber)

Description copied from interface: Record

Set the contents of the field to the specified long value.

Specified by:

setField in interface Record

setField

public Record setField(int value,
              int fieldNumber)

Description copied from interface: Record

Set the contents of the field to the specified int value.

Specified by:

setField in interface Record

fieldName

public String fieldName(int fieldNumber)

Description copied from interface: Record

The name of the field.

Specified by:

fieldName in interface Record

Returns:

A String containing the name of the field for the specified field number.

getField

protected Object getField(Field field)
                   throws InvalidDataException

Parameters:

field - The field to be obtained.

Returns:

A string containing the field from the buffer converted based on the defined encoding.

Throws:

InvalidDataException

getFieldAsString

protected String getFieldAsString(Field field)

getFieldAsRoutingNumber

protected RoutingNumber getFieldAsRoutingNumber(Field field)

getFieldAsOnUsField

protected OnUsField getFieldAsOnUsField(Field field)

getFieldAsByteArray

protected ByteArray getFieldAsByteArray(Field field)

getFieldAsDate

protected Date getFieldAsDate(Field field)
                       throws InvalidDataException

Throws:

InvalidDataException

getFieldAsDate

protected Date getFieldAsDate(Field field,
                  TimeZone zone)
                       throws InvalidDataException

Throws:

InvalidDataException

getFieldAsTime

protected Date getFieldAsTime(Field field)
                       throws InvalidDataException

Throws:

InvalidDataException

getFieldAsTime

protected Date getFieldAsTime(Field field,
                  TimeZone zone)
                       throws InvalidDataException

Throws:

InvalidDataException

getFieldAsLong

protected long getFieldAsLong(Field field)
                       throws InvalidDataException

Throws:

InvalidDataException

getFieldAsInt

protected int getFieldAsInt(Field field)
                     throws InvalidDataException

Throws:

InvalidDataException

setField

protected void setField(String value,
            Field field)

Parameters:

value - The new value to be stored in the buffer.

field - The field to be updated.

setFieldRight

protected void setFieldRight(String value,
                 Field field)

setField

protected void setField(ByteArray value,
            Field field)

setFieldDate

protected void setFieldDate(Date value,
                Field field)

setFieldDate

protected void setFieldDate(Date value,
                Field field,
                TimeZone zone)

setFieldTime

protected void setFieldTime(Date value,
                Field field)

setFieldTime

protected void setFieldTime(Date value,
                Field field,
                TimeZone zone)

setField

protected void setField(RoutingNumber value,
            Field field)

setField

protected void setField(OnUsField value,
            Field field)

setField

protected void setField(long value,
            Field field)

setField

protected void setField(int value,
            Field field)

allocateNewRecord

protected void allocateNewRecord(int currentLength,
                     int newLength,
                     int replaceLengthField,
                     int replacedField)

This is a routine that is used to allocate a new record for a field that has changed length. A new buffer is allocated and all of the defined fields for this record are copied, except for the field being replaced. It is up to the caller of this routine to actually store the new field value.

Parameters:

currentLength - the current length of the field

newLength - the new length of the field

replaceLengthField - the field number of the length field associated with the field

replacedField - the field number of field being replaced

length

public int length()

Description copied from interface: Record

This is the length of the current record. Normally this is the size of the record buffer area. However, we know we are going to allow the I/O routines to read short records and for those record types the subclass may override this to give the true size of the record, not just the in memory buffer area.

Specified by:

length in interface Record

Returns:

the length of the record.

record

public ByteArray record()

Specified by:

record in interface Record

Returns:

the record

record

protected void record(ByteArray record)

Certain records are variable in size and can change size based on the values placed in the fields. This method is for sub-classes who need to reset the record after a field manipulation requires a change in the record size.

Parameters:

record - the record to set

recordPosition

public int recordPosition()

Description copied from interface: Record

The position of this record in an input stream. If the record is not from a input stream, then this value will be 0. The first record is always record number 1.

Specified by:

recordPosition in interface Record

Returns:

an int indicating position of the record in an input stream.

recordPosition

public Record recordPosition(int position)

Description copied from interface: Record

This is used to set the current record position of this record in the input stream.

Specified by:

recordPosition in interface Record

offsetPosition

public long offsetPosition()

Description copied from interface: Record

The offset of this record in an input stream. If the record is not from a input stream, then this value will be 0. This offset is relative to 0 from the beginning of the stream. So the offset for the first record will be 0.

Specified by:

offsetPosition in interface Record

Returns:

a long indicating the offset of the record in an input stream.

offsetPosition

public Record offsetPosition(long offset)

Description copied from interface: Record

This is used to set the current record offset of this record in the input stream.

Specified by:

offsetPosition in interface Record

numberOfFields

public abstract int numberOfFields()

Description copied from interface: Record

The number of fields defined for this record.

Specified by:

numberOfFields in interface Record

Returns:

an int for the number of fields.

field

protected abstract Field field(int fieldNumber)

Get the field definition for a specified field based on the field number.

Parameters:

fieldNumber -

Returns:

An Field object defining the field.

resetDynamicFields

protected abstract void resetDynamicFields()

This method is intended to allow the reset of dynamic fields back to their initial state. This is for fields whose definition may depend on values of other fields. If those fields change, reseting the dynamic fields forces them to be recalculated when needed.

toString

public String toString()

Overrides:

toString in class Object

toXml

public String toXml()

Description copied from interface: Record

Creates an XML representation of the record based on it's fields. Default is to create field values as attributes.

Specified by:

toXml in interface Record

Returns:

a string of XML data

toXml

public String toXml(boolean useAttributes)

Description copied from interface: Record

Creates an XML representation of the record based on it's fields.

Specified by:

toXml in interface Record

Parameters:

useAttributes - if true, then fields are attributes, if false, then they are tagged and subordinate to the record tags.

Returns:

a string of XML data