hep.wired.corbaheprep

Class CORBARecordSource

java.lang.Object

org.freehep.record.source.AbstractRecordSource

hep.wired.corbaheprep.CORBARecordSource

All Implemented Interfaces:

org.freehep.record.source.RecordSource

Direct Known Subclasses:

GleamRecordSource

public class CORBARecordSource
extends org.freehep.record.source.AbstractRecordSource

Basic implementation of RecordSource wrapped around CORBA HepRep server. Supports sequential access only, assumes the next event can be loaded by HepEventServer.setEvent("next"). Designed to be used as a base class for implementing wrappers for specific CORBA servers.

Version:

$Id: $

Author:

Dmitry Onoprienko

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CORBARecordSource.Move

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	_hasNext
protected boolean	_hasPrevious
protected hep.graphics.heprep.HepRep	_heprep
protected long	_index
protected boolean	_isHepRep2
protected HepEventServer	_server
protected long	_size
protected EnumSet<CORBARecordSource.Move>	_supports
protected org.freehep.record.source.RecordTag	_tag
protected static long	UNKNOWN

Fields inherited from class org.freehep.record.source.AbstractRecordSource

_name

Constructor Summary

Constructors

Constructor and Description
CORBARecordSource(String name, HepEventServer server, Properties serverInfo)

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.
protected void	determineSize()
long	getCurrentIndex() Returns the index of the current record, or -1 if this source is positioned before the first record.
hep.graphics.heprep.HepRep	getCurrentRecord() Returns the current record.
org.freehep.record.source.RecordTag	getCurrentTag() Returns the tag of the current record.
long	getEstimatedSize() Returns the estimated number of records in this source.
protected hep.graphics.heprep.HepRep	getHepRep()
Class<?>	getRecordClass() Returns the Class object that is guaranteed to be a superclass of all records in this source.
protected String	getServerCommand(CORBARecordSource.Move move, long par, org.freehep.record.source.RecordTag tag) Returns the command that needs to be send to the CORBA server to position it for reading the specified record.
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 by numberOfRecords records.
void	jump(long index) Loads the record specified by the index.
void	jump(org.freehep.record.source.RecordTag tag) Loads the record specified by the tag.
void	next() Loads the next record.
protected void	positionServer(CORBARecordSource.Move move, long par, org.freehep.record.source.RecordTag tag)
void	previous() Loads the previous record.
void	releaseRecord() Releases any resources associated with the current record.
protected void	restorePosition()
void	rewind() Positions the cursor of this source before the first record.
protected void	sendCommand(String command)
protected void	setCurrentIndex() Sets _index to the index of the record for which the CORBA server is currently positioned.
protected void	setCurrentTag() Sets _tag to the tag of the record for which the CORBA server is currently positioned.
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, after updating it from the CORBA server.
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.

Methods inherited from class org.freehep.record.source.AbstractRecordSource

getName, getTags, hasTag, jump, parseTag, setName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

UNKNOWN

protected static final long UNKNOWN

See Also:

Constant Field Values

_server

protected HepEventServer _server

_size

protected long _size

_supports

protected EnumSet<CORBARecordSource.Move> _supports

_isHepRep2

protected boolean _isHepRep2

_index

protected long _index

_tag

protected org.freehep.record.source.RecordTag _tag

_heprep

protected hep.graphics.heprep.HepRep _heprep

_hasNext

protected boolean _hasNext

_hasPrevious

protected boolean _hasPrevious

Constructor Detail

CORBARecordSource

public CORBARecordSource(String name,
                 HepEventServer server,
                 Properties serverInfo)

Method Detail

determineSize

protected final void determineSize()

getRecordClass

public Class<?> getRecordClass()

Returns the Class object that is guaranteed to be a superclass of all records in this source.

Specified by:

getRecordClass in interface org.freehep.record.source.RecordSource

Overrides:

getRecordClass in class org.freehep.record.source.AbstractRecordSource

size

public long size()

Returns the number of records in this source, after updating it from the CORBA server.

Specified by:

size in interface org.freehep.record.source.RecordSource

Overrides:

size in class org.freehep.record.source.AbstractRecordSource

Throws:

UnsupportedOperationException - if the number of records is unknown.

getEstimatedSize

public long getEstimatedSize()

Returns the estimated number of records in this source. Uses previously determined number of records, does not communicate with CORBA server.

Specified by:

getEstimatedSize in interface org.freehep.record.source.RecordSource

Overrides:

getEstimatedSize in class org.freehep.record.source.AbstractRecordSource

Throws:

UnsupportedOperationException - if the number of records is unknown.

getCurrentIndex

public long getCurrentIndex()

Returns the index of the current record, or -1 if this source is positioned before the first record.

Specified by:

getCurrentIndex in interface org.freehep.record.source.RecordSource

Overrides:

getCurrentIndex in class org.freehep.record.source.AbstractRecordSource

getCurrentTag

public org.freehep.record.source.RecordTag getCurrentTag()

Returns the tag of the current record.

Specified by:

getCurrentTag in interface org.freehep.record.source.RecordSource

Overrides:

getCurrentTag in class org.freehep.record.source.AbstractRecordSource

Throws:

IllegalStateException - if there is no current record.

getCurrentRecord

public hep.graphics.heprep.HepRep 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

public void releaseRecord()

Releases any resources associated with the current record.

Specified by:

releaseRecord in interface org.freehep.record.source.RecordSource

Overrides:

releaseRecord in class org.freehep.record.source.AbstractRecordSource

supportsCurrent

public boolean supportsCurrent()

Returns true if this source supports reloading current record.

Specified by:

supportsCurrent in interface org.freehep.record.source.RecordSource

Overrides:

supportsCurrent in class org.freehep.record.source.AbstractRecordSource

supportsNext

public boolean supportsNext()

Returns true if this source supports loading next record.

Specified by:

supportsNext in interface org.freehep.record.source.RecordSource

Overrides:

supportsNext in class org.freehep.record.source.AbstractRecordSource

supportsPrevious

public boolean supportsPrevious()

Returns true if this source supports loading previous record.

Specified by:

supportsPrevious in interface org.freehep.record.source.RecordSource

Overrides:

supportsPrevious in class org.freehep.record.source.AbstractRecordSource

supportsIndex

public boolean supportsIndex()

Returns true if this source supports selecting records by index.

Specified by:

supportsIndex in interface org.freehep.record.source.RecordSource

Overrides:

supportsIndex in class org.freehep.record.source.AbstractRecordSource

supportsTag

public boolean supportsTag()

Returns true if this source supports selecting records by tag.

Specified by:

supportsTag in interface org.freehep.record.source.RecordSource

Overrides:

supportsTag in class org.freehep.record.source.AbstractRecordSource

supportsShift

public boolean supportsShift()

Returns true if this source supports selecting records by offset with respect to the current record.

Specified by:

supportsShift in interface org.freehep.record.source.RecordSource

Overrides:

supportsShift in class org.freehep.record.source.AbstractRecordSource

hasCurrent

public boolean hasCurrent()

Returns true if this source can reload the current record.

Specified by:

hasCurrent in interface org.freehep.record.source.RecordSource

Overrides:

hasCurrent in class org.freehep.record.source.AbstractRecordSource

hasNext

public boolean hasNext()

Returns true if this source can load the next record.

Specified by:

hasNext in interface org.freehep.record.source.RecordSource

Overrides:

hasNext in class org.freehep.record.source.AbstractRecordSource

hasPrevious

public boolean hasPrevious()

Returns true if this source can load the previous record.

Specified by:

hasPrevious in interface org.freehep.record.source.RecordSource

Overrides:

hasPrevious in class org.freehep.record.source.AbstractRecordSource

hasIndex

public boolean hasIndex(long index)

Returns true if this source has a record with the specified index.

Specified by:

hasIndex in interface org.freehep.record.source.RecordSource

Overrides:

hasIndex in class org.freehep.record.source.AbstractRecordSource

hasShift

public boolean hasShift(long numberOfRecords)

Returns true if this source can shift by numberOfRecords records.

Specified by:

hasShift in interface org.freehep.record.source.RecordSource

Overrides:

hasShift in class org.freehep.record.source.AbstractRecordSource

current

public void current()
             throws IOException,
                    org.freehep.record.source.NoSuchRecordException

Reloads the current record.

Specified by:

current in interface org.freehep.record.source.RecordSource

Overrides:

current in class org.freehep.record.source.AbstractRecordSource

Throws:

org.freehep.record.source.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

public void next()
          throws IOException,
                 org.freehep.record.source.NoSuchRecordException

Loads the next record.

Specified by:

next in interface org.freehep.record.source.RecordSource

Overrides:

next in class org.freehep.record.source.AbstractRecordSource

Throws:

org.freehep.record.source.NoSuchRecordException - if there is no current record.

IOException - if loading of the next record fails.

UnsupportedOperationException - if this source does not support loading the next record.

previous

public void previous()
              throws IOException,
                     org.freehep.record.source.NoSuchRecordException

Loads the previous record.

Specified by:

previous in interface org.freehep.record.source.RecordSource

Overrides:

previous in class org.freehep.record.source.AbstractRecordSource

Throws:

org.freehep.record.source.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

public void jump(long index)
          throws IOException,
                 org.freehep.record.source.NoSuchRecordException

Loads the record specified by the index.

Specified by:

jump in interface org.freehep.record.source.RecordSource

Overrides:

jump in class org.freehep.record.source.AbstractRecordSource

Throws:

org.freehep.record.source.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

public void jump(org.freehep.record.source.RecordTag tag)
          throws IOException,
                 org.freehep.record.source.NoSuchRecordException

Loads the record specified by the tag.

Specified by:

jump in interface org.freehep.record.source.RecordSource

Overrides:

jump in class org.freehep.record.source.AbstractRecordSource

Throws:

org.freehep.record.source.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

public void shift(long numberOfRecords)
           throws IOException,
                  org.freehep.record.source.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.

Specified by:

shift in interface org.freehep.record.source.RecordSource

Overrides:

shift in class org.freehep.record.source.AbstractRecordSource

Throws:

org.freehep.record.source.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

public boolean supportsRewind()

Returns true if this source supports rewind operation.

Specified by:

supportsRewind in interface org.freehep.record.source.RecordSource

Overrides:

supportsRewind in class org.freehep.record.source.AbstractRecordSource

hasRewind

public boolean hasRewind()

Returns true if this source in its current state can be rewound.

Specified by:

hasRewind in interface org.freehep.record.source.RecordSource

Overrides:

hasRewind in class org.freehep.record.source.AbstractRecordSource

rewind

public void rewind()
            throws IOException

Positions the cursor of this source before the first record.

Specified by:

rewind in interface org.freehep.record.source.RecordSource

Overrides:

rewind in class org.freehep.record.source.AbstractRecordSource

Throws:

IOException

close

public void close()
           throws IOException

Close the record source and release any associated resources.

Specified by:

close in interface org.freehep.record.source.RecordSource

Overrides:

close in class org.freehep.record.source.AbstractRecordSource

Throws:

IOException - if closing fails.

getServerCommand

protected String getServerCommand(CORBARecordSource.Move move,
                      long par,
                      org.freehep.record.source.RecordTag tag)

Returns the command that needs to be send to the CORBA server to position it for reading the specified record.

setCurrentTag

protected void setCurrentTag()

Sets _tag to the tag of the record for which the CORBA server is currently positioned.

setCurrentIndex

protected void setCurrentIndex()

Sets _index to the index of the record for which the CORBA server is currently positioned.

positionServer

protected void positionServer(CORBARecordSource.Move move,
                  long par,
                  org.freehep.record.source.RecordTag tag)
                       throws IOException,
                              org.freehep.record.source.NoSuchRecordException

Throws:

IOException

org.freehep.record.source.NoSuchRecordException

restorePosition

protected void restorePosition()

sendCommand

protected void sendCommand(String command)
                    throws org.freehep.record.source.NoSuchRecordException,
                           IOException

Throws:

org.freehep.record.source.NoSuchRecordException

IOException

getHepRep

protected hep.graphics.heprep.HepRep getHepRep()
                                        throws IOException

Throws:

IOException