com.thelastcheck.io.base

Interface Record

All Known Implementing Classes:

RecordImpl

public interface Record

Method Summary

Methods

Modifier and Type	Method and Description
void	clearRecord() Clear the entire record area to the fill character required.
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.
String	fieldName(int fieldNumber) The name of the field.
Object	getField(int fieldNumber) The field value.
int	length() This is the length of the current record.
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()
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.
Record	setField(int value, int fieldNumber) Set the contents of the field to the specified int value.
Record	setField(long value, int fieldNumber) Set the contents of the field to the specified long value.
Record	setField(String value, int fieldNumber) Set the contents of the field to the specified string value.
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.

Method Detail

clone

Object clone()

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

Returns:

cloned copy of this record

duplicate

Object duplicate()

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.

Returns:

duplicated copy of this record, but sharing the underlying bytes

clearRecord

void clearRecord()

Clear the entire record area to the fill character required. Typically this is spaces or nulls. If a space is the value, then the space value should be based on the encoding.

numberOfFields

int numberOfFields()

The number of fields defined for this record.

Returns:

an int for the number of fields.

getField

Object getField(int fieldNumber)
                throws InvalidDataException

The field value.

Parameters:

fieldNumber -

Returns:

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

Throws:

InvalidDataException

setField

Record setField(String value,
              int fieldNumber)

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

Parameters:

value -

fieldNumber -

setField

Record setField(long value,
              int fieldNumber)

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

Parameters:

value -

fieldNumber -

setField

Record setField(int value,
              int fieldNumber)

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

Parameters:

value -

fieldNumber -

length

int length()

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.

Returns:

the length of the record.

record

ByteArray record()

Returns:

the record

fieldName

String fieldName(int fieldNumber)

The name of the field.

Parameters:

fieldNumber -

Returns:

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

recordPosition

int recordPosition()

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.

Returns:

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

recordPosition

Record recordPosition(int position)

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

Parameters:

position -

offsetPosition

long offsetPosition()

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.

Returns:

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

offsetPosition

Record offsetPosition(long offset)

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

Parameters:

offset -

toXml

String toXml()

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

Returns:

a string of XML data

toXml

String toXml(boolean useAttributes)

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

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