org.safs.tools.input

Interface InputInterface

All Known Implementing Classes:

SAFSINPUT

public interface InputInterface

Method Summary

Modifier and Type	Method and Description
void	close(UniqueIDInterface source) Close the identified input source and release resources.
InputRecordInterface	gotoRecord(UniqueRecordInterface recordInfo) Locate and return the requested record in the input source.
boolean	gotoStart(UniqueIDInterface source) Rewind the identified input source to its first record.
InputRecordInterface	nextRecord(UniqueIDInterface source) Get the next record from the identified input source.
boolean	open(UniqueSourceInterface source) Open a unique instance of an input source.

Method Detail

open

boolean open(UniqueSourceInterface source)

Open a unique instance of an input source. The source "pointer" should be ready to read the first record if successful.

Returns:

TRUE if OPEN was successful.

nextRecord

InputRecordInterface nextRecord(UniqueIDInterface source)

Get the next record from the identified input source. Should return a valid InputRecordInterface, or an InputRecordInvalid object.

See Also:

InputRecordInterface, InputRecordInvalid

gotoStart

boolean gotoStart(UniqueIDInterface source)

Rewind the identified input source to its first record. The source "pointer" should be ready to read the first record on exit.

Returns:

TRUE if successful.

gotoRecord

InputRecordInterface gotoRecord(UniqueRecordInterface recordInfo)

Locate and return the requested record in the input source. The source "pointer" should be ready to read the record AFTER the identified record on exit. Should return a valid InputRecordInterface, or an InputRecordInvalid object.

See Also:

InputRecordInterface, InputRecordInvalid

close

void close(UniqueIDInterface source)

Close the identified input source and release resources.