org.safs.tools.input

Interface InputRecordInterface

All Known Implementing Classes:

InputRecordInfo, InputRecordInvalid

public interface InputRecordInterface

This is the required interface for any InputInterface function that returns an input record to the calling Driver. In general, null or values less than 1 indicate unsuccessful attempts to retrieve the desired record, or that the source has reached the end of input (EOF).

For this reason, the InputRecordInvalid concrete implementation is provided and an instance of this should be returned to indicate invalid data.

See Also:

InputRecordInvalid

Method Summary

Modifier and Type	Method and Description
java.lang.String	getRecordData() Return the actual string data of the input record.
long	getRecordNumber() Return the row# or line# of the encapsulated data.
boolean	isValid() Returns TRUE if the values for recordnum and recorddata are valid.

Method Detail

getRecordNumber

long getRecordNumber()

Return the row# or line# of the encapsulated data. Values less than 1 indicate no such record or EOF.

getRecordData

java.lang.String getRecordData()

Return the actual string data of the input record. A null value indicates no such record or EOF.

isValid

boolean isValid()

Returns TRUE if the values for recordnum and recorddata are valid.