RecordSource (FreeHEP Record 3.0.5 API)

All Known Subinterfaces:

AsynchronousRecordSource

All Known Implementing Classes:

AbstractRecordSource, TagListRecordSource
```
public interface RecordSource
```
Interface to be implemented by classes that supply records to clients for processing.

Version:

$Id$

Author:

Dmitry Onoprienko

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`close()` Close the record source and release any associated resources.
`void`	`current()` Reloads the current record.
`long`	`getCurrentIndex()` Returns the index of the current record.
`Object`	`getCurrentRecord()` Returns the current record.
`RecordTag`	`getCurrentTag()` Returns the tag of the current record.
`long`	`getEstimatedSize()` Returns the estimated number of records in this source.
`String`	`getName()` Returns the name of this source.
`Class<?>`	`getRecordClass()` Returns the `Class` object that is guaranteed to be a superclass of all records in this source.
`List<RecordTag>`	`getTags()` Returns a list of tags for events in this source.
`boolean`	`hasCurrent()` Returns `true` if this source can reload the current record.
`boolean`	`hasIndex(long index)` Returns `true` if this source has a record with the specified index.
`boolean`	`hasNext()` Returns `true` if this source can load the next record.
`boolean`	`hasPrevious()` Returns `true` if this source can load the previous record.
`boolean`	`hasRewind()` Returns `true` if this source in its current state can be rewound.
`boolean`	`hasShift(long numberOfRecords)` Returns `true` if this source can shift `numberOfRecords` records.
`boolean`	`hasTag(RecordTag tag)` Returns `true` if this source has a record with the specified tag.
`void`	`jump(long index)` Loads the record specified by the index.
`void`	`jump(RecordTag tag)` Loads the record specified by the tag.
`void`	`next()` Loads the next record.
`RecordTag`	`parseTag(String s)` Returns a tag corresponding to the specified string.
`void`	`previous()` Loads the previous record.
`void`	`releaseRecord()` Releases any resources associated with the current record.
`void`	`rewind()` Positions the cursor of this source before the first record.
`void`	`shift(long numberOfRecords)` Loads the record specified by the offset with respect to the current cursor position.
`long`	`size()` Returns the number of records in this source.
`boolean`	`supportsCurrent()` Returns `true` if this source supports reloading current record.
`boolean`	`supportsIndex()` Returns `true` if this source supports selecting records by index.
`boolean`	`supportsNext()` Returns `true` if this source supports loading next record.
`boolean`	`supportsPrevious()` Returns `true` if this source supports loading previous record.
`boolean`	`supportsRewind()` Returns `true` if this source supports rewind operation.
`boolean`	`supportsShift()` Returns `true` if this source supports selecting records by offset with respect to the current record.
`boolean`	`supportsTag()` Returns `true` if this source supports selecting records by tag.

- Method Detail
  - getName
```
String getName()
```
    Returns the name of this source.
  - getRecordClass
```
Class<?> getRecordClass()
```
    Returns the Class object that is guaranteed to be a superclass of all records in this source.
  - size
```
long size()
```
    Returns the number of records in this source.
    The number of records returned by this method is guaranteed to be correct when the method is called; however, the size of some RecordSource implementations might change in time.
    
    Throws:
    
    UnsupportedOperationException - if the number of records is unknown.
  - getEstimatedSize
```
long getEstimatedSize()
```
    Returns the estimated number of records in this source.
    Clients may use the estimate provided by this method to give the user feedback on what portion of the record source has been read, for example. However, the estimate is not guaranteed to be correct.
    
    Throws:
    
    UnsupportedOperationException - if the number of records is unknown.
  - getTags
```
List<RecordTag> getTags()
```
    Returns a list of tags for events in this source.
    The list of tags returned by this method is guaranteed to be complete when the method is called; however, the content of some RecordSource implementations might change in time.
    
    Throws:
    
    UnsupportedOperationException - if this source does not support access by tag, or if the list of tags cannot be retrieved.
  - getCurrentIndex
```
long getCurrentIndex()
```
    Returns the index of the current record. Returns -1 if this source is positioned before the first record.
    
    Throws:
    
    IllegalStateException - if the current index is not known.
    
    UnsupportedOperationException - if this source does not support access by index,
  - getCurrentTag
```
RecordTag getCurrentTag()
```
    Returns the tag of the current record.
    
    Throws:
    
    IllegalStateException - if there is no current record, or the current tag is not known.
    
    UnsupportedOperationException - if this source does not support access by tag,
  - getCurrentRecord
```
Object getCurrentRecord()
                        throws IOException
```
    Returns the current record.
    
    Throws:
    
    IllegalStateException - if there is no current record.
    
    IOException - if retrieving the current record fails for any reason.
  - releaseRecord
```
void releaseRecord()
```
    Releases any resources associated with the current record.
  - supportsCurrent
```
boolean supportsCurrent()
```
    Returns true if this source supports reloading current record.
  - supportsNext
```
boolean supportsNext()
```
    Returns true if this source supports loading next record.
  - supportsPrevious
```
boolean supportsPrevious()
```
    Returns true if this source supports loading previous record.
  - supportsIndex
```
boolean supportsIndex()
```
    Returns true if this source supports selecting records by index.
  - supportsTag
```
boolean supportsTag()
```
    Returns true if this source supports selecting records by tag.
  - supportsShift
```
boolean supportsShift()
```
    Returns true if this source supports selecting records by offset with respect to the current record.
  - hasCurrent
```
boolean hasCurrent()
```
    Returns true if this source can reload the current record. Also returns true if this source does not know whether reloading is possible.
    Some implementations might not be able to figure out whether reloading is possible before trying it, so the fact that this method returns true does not exclude the possibility of NoSuchRecordException being thrown by the next call to current().
  - hasNext
```
boolean hasNext()
```
    Returns true if this source can load the next record. Also returns true if this source does not know whether it has more records.
    Some implementations might not be able to figure out whether loading the next record is possible before trying it, so the fact that this method returns true does not exclude the possibility of NoSuchRecordException being thrown by the next call to next().
  - hasPrevious
```
boolean hasPrevious()
```
    Returns true if this source can load the previous record. Also returns true if this source does not know whether it has a previous record.
    Some implementations might not be able to figure out whether loading the previous record is possible before trying it, so the fact that this method returns true does not exclude the possibility of NoSuchRecordException being thrown by the next call to previous().
  - hasIndex
```
boolean hasIndex(long index)
```
    Returns true if this source has a record with the specified index. Also returns true if this source does not know whether it has a record with the specified index.
    Some implementations might not be able to figure out whether the requested record exists before trying to load it, so the fact that this method returns true does not exclude the possibility of NoSuchRecordException being thrown by the next call to jump(index).
  - hasTag
```
boolean hasTag(RecordTag tag)
```
    Returns true if this source has a record with the specified tag. Also returns true if this source does not know whether it has a record with the specified tag.
    Some implementations might not be able to figure out whether the requested record exists before trying to load it, so the fact that this method returns true does not exclude the possibility of NoSuchRecordException being thrown by the next call to jump(tag).
  - hasShift
```
boolean hasShift(long numberOfRecords)
```
    Returns true if this source can shift numberOfRecords records. Also returns true if this source does not know whether it has a record with the specified offset.
    Some implementations might not be able to figure out whether the requested record exists before trying to load it, so the fact that this method returns true does not exclude the possibility of NoSuchRecordException being thrown by the next call to shift(numberOfRecords).
  - current
```
void current()
             throws IOException,
                    NoSuchRecordException
```
    Reloads the current record.
    
    Throws:
    
    NoSuchRecordException - if there is no current record.
    
    IOException - if reloading of the current record fails.
    
    UnsupportedOperationException - if this source does not support reloading of the current record.
  - next
```
void next()
          throws IOException,
                 NoSuchRecordException
```
    Loads the next record.
    
    Throws:
    
    NoSuchRecordException - if there is no next record.
    
    IOException - if loading of the next record fails.
    
    UnsupportedOperationException - if this source does not support loading the next record.
  - previous
```
void previous()
              throws IOException,
                     NoSuchRecordException
```
    Loads the previous record.
    
    Throws:
    
    NoSuchRecordException - if there is no previous record.
    
    IOException - if loading of the previous record fails.
    
    UnsupportedOperationException - if this source does not support loading the previous record.
  - jump
```
void jump(long index)
          throws IOException,
                 NoSuchRecordException
```
    Loads the record specified by the index.
    
    Throws:
    
    NoSuchRecordException - if this source does not have a record with the specified index.
    
    IOException - if loading of the requested record fails.
    
    UnsupportedOperationException - if this source does not support access by index.
  - jump
```
void jump(RecordTag tag)
          throws IOException,
                 NoSuchRecordException
```
    Loads the record specified by the tag.
    
    Throws:
    
    NoSuchRecordException - if this source does not have a record with the specified tag.
    
    IOException - if loading of the requested record fails.
    
    UnsupportedOperationException - if this source does not support access by tag.
  - shift
```
void shift(long numberOfRecords)
           throws IOException,
                  NoSuchRecordException
```
    Loads the record specified by the offset with respect to the current cursor position. The offset can be negative or positive. Skipping is guaranteed to be at least as fast as numberOfRecords consecutive calls to next() or previous(), and will be faster if this source implementation permits it.
    
    Throws:
    
    NoSuchRecordException - if this source does not have a record with the specified offset.
    
    IOException - if loading of the requested record fails.
    
    UnsupportedOperationException - if this source does not support access by offset.
  - supportsRewind
```
boolean supportsRewind()
```
    Returns true if this source supports rewind operation.
  - hasRewind
```
boolean hasRewind()
```
    Returns true if this source in its current state can be rewound.
  - rewind
```
void rewind()
            throws IOException
```
    Positions the cursor of this source before the first record.
    
    Throws:
    
    UnsupportedOperationException - if this source does not support rewind.
    
    IOException - if rewinding fails for any reason.
  - close
```
void close()
           throws IOException
```
    Close the record source and release any associated resources.
    
    Throws:
    
    IOException - if closing fails.
  - parseTag
```
RecordTag parseTag(String s)
```
    Returns a tag corresponding to the specified string. The method should be implemented to convert record names supplied by clients into tags recognized by this source.
    
    Throws:
    
    IllegalArgumentException - if the specified string cannot be parsed.

Interface RecordSource

Method Summary

Method Detail

getName

getRecordClass

size

getEstimatedSize

getTags

getCurrentIndex

getCurrentTag

getCurrentRecord

releaseRecord

supportsCurrent

supportsNext

supportsPrevious

supportsIndex

supportsTag

supportsShift

hasCurrent

hasNext

hasPrevious

hasIndex

hasTag

hasShift

current

next

previous

jump

jump

shift

supportsRewind

hasRewind

rewind

close

parseTag