org.freehep.record.source
Interface TaggedRecordSource

All Superinterfaces:

RandomAccessRecordSource, SequentialRecordSource

public interface TaggedRecordSource

extends RandomAccessRecordSource

A record source which allows access to records by record tags.

Version:

$Id: TaggedRecordSource.java,v 1.1 2003/03/10 21:56:06 tonyj Exp $

Source Code:

TaggedRecordSource.java

Field Summary

Fields inherited from interface org.freehep.record.source.SequentialRecordSource

UNKNOWN

Method Summary

RecordTag	currentTag() Get the RecordTag for the current record.
void	goToRecord(RecordTag tag) Access a record identified by a RecordTag
List	tags() Access a list of all the tags in this record source.

Methods inherited from interface org.freehep.record.source.RandomAccessRecordSource

currentIndex, goToRecord

Methods inherited from interface org.freehep.record.source.SequentialRecordSource

close, getCurrentRecord, getEstimatedSize, getRecordClass, getSourceName, next, releaseRecord, rewind

Method Detail

goToRecord

public void goToRecord(RecordTag tag)
                throws NoSuchRecordException

Access a record identified by a RecordTag

Parameters:

tag - The tag to access

Throws:

NoSuchRecordException - If the specified record does not exist

currentTag

public RecordTag currentTag()

Get the RecordTag for the current record.

Returns:

The current records tag, or null if there is no current record.

tags

public List tags()

Access a list of all the tags in this record source. Not all TaggedRecordSource's will support this method, so it may return null.

Returns:

A list of RecordTags, or null.