org.starhope.catullus
Class Via<T extends DataRecord>

java.lang.Object
  org.starhope.catullus.Via<T>

Type Parameters:

T - the remote data record type to be loaded

All Implemented Interfaces:

RecordLoader<T>, HasSubversionRevision

public class Via<T extends DataRecord>
extends Object
implements RecordLoader<T>

This is an interface class for the bridge to a remote object of a given type. The data record on the remote server must implement the matching Porta interface. (that's not true, WRITEME, this works through some new AppiusConfig hacking on the DataRecord/RecordLoader model)

Author:

brpocock@star-hope.org

Field Summary

private Class<T>	klass the class for which this is acting as a RecordLoader
private Vehicle	vehicle the vehicle for communications

Constructor Summary

Via(Class<T> myClass)
WRITEME: Document this constructor brpocock@star-hope.org

Method Summary

void	changed(T changedRecord) accept a notification from a record that it has been changed.
String	getSubversionRevision() Return the Subversion revision level of this class's source code file, as supplied via the special "$Rev: " sequence.
Vehicle	getVehicle() WRITEME: Document this method brpocock@star-hope.org
void	initializeStorage(String storageURL) Prepare the RecordLoader for accessing a given storage medium.
boolean	isRealtime()
T	loadRecord(int id) Load the record with the given ID number from the storage system
T	loadRecord(String identifier) Load the data record identified from the storage system.
void	refresh(T record) Refreshes the record: Re-read the contents of the database into the given record.
void	removeRecord(T record)
void	saveRecord(T record) Save a record back to the storage system
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

klass

private final Class<T extends DataRecord> klass

the class for which this is acting as a RecordLoader

vehicle

private Vehicle vehicle

the vehicle for communications

Constructor Detail

Via

public Via(Class<T> myClass)

WRITEME: Document this constructor brpocock@star-hope.org

Parameters:

myClass - WRITEME

Method Detail

changed

public void changed(T changedRecord)

Description copied from interface: RecordLoader

accept a notification from a record that it has been changed.

Specified by:

changed in interface RecordLoader<T extends DataRecord>

Parameters:

changedRecord - the record that has been changed

See Also:

RecordLoader.changed(org.starhope.appius.util.DataRecord)

getSubversionRevision

public String getSubversionRevision()

Description copied from interface: HasSubversionRevision

Return the Subversion revision level of this class's source code file, as supplied via the special "$Rev: " sequence.

As an example,the Subversion revision string for this file is "$Rev: 1968 $"

 
 @Override
 public String getSubversionRevision () {
        return "$Rev: ";
 }
 

Specified by:

getSubversionRevision in interface HasSubversionRevision

Returns:

The Subversion revision level for this class's source code file.

See Also:

HasSubversionRevision.getSubversionRevision()

getVehicle

public Vehicle getVehicle()

WRITEME: Document this method brpocock@star-hope.org

Returns:

WRITEME

initializeStorage

public void initializeStorage(String storageURL)
                       throws NotReadyException

Description copied from interface: RecordLoader

Prepare the RecordLoader for accessing a given storage medium. Usually identifies a URL for the storage mechanism, but can also pull information from AppiusConfig.

Specified by:

initializeStorage in interface RecordLoader<T extends DataRecord>

Parameters:

storageURL - A URL or identifier of the storage engine. The syntax is specific to the RecordLoader implementation.

Throws:

NotReadyException - if the storage engine can't be initialised

See Also:

RecordLoader.initializeStorage(java.lang.String)

isRealtime

public boolean isRealtime()

Specified by:

isRealtime in interface RecordLoader<T extends DataRecord>

Returns:

true, if this is a type that requires realtime performance on changes. Note that I/O bound storage such as SQL database saves and file writes will generally return false, whereas RPC mirroring will probably want to return true, unless latency is not an issue.

See Also:

RecordLoader.isRealtime()

loadRecord

public T loadRecord(int id)
                                throws NotFoundException

Description copied from interface: RecordLoader

Load the record with the given ID number from the storage system

Specified by:

loadRecord in interface RecordLoader<T extends DataRecord>

Parameters:

id - the ID number for the record

Returns:

the data record in question

Throws:

NotFoundException - if the record can't be loaded

See Also:

RecordLoader.loadRecord(int)

loadRecord

public T loadRecord(String identifier)
                                throws NotFoundException

Description copied from interface: RecordLoader

Load the data record identified from the storage system. The format and interpretation of the identifier is specific to the data record type, but must be a guaranteed-unique

Specified by:

loadRecord in interface RecordLoader<T extends DataRecord>

Parameters:

identifier - the identifier for the record

Returns:

the data record in question

Throws:

NotFoundException - if the record can't be loaded

See Also:

RecordLoader.loadRecord(java.lang.String)

refresh

public void refresh(T record)

Description copied from interface: RecordLoader

Refreshes the record: Re-read the contents of the database into the given record. This is a rather cruel hack to work around some of the legacy tools in Tootsville™ that aren't hooked into the game server properly, and might be fiddling around with the SQL backing-store directly. This works together with e.g. SimpleDataRecord.checkStale() to try to reload data when it might have been changed: it's trading elegance and efficiency for expediency, but eventually, it should be removed.

Specified by:

refresh in interface RecordLoader<T extends DataRecord>

Parameters:

record - the record to be reloaded.

See Also:

RecordLoader.refresh(org.starhope.appius.util.DataRecord)

removeRecord

public void removeRecord(T record)

Specified by:

removeRecord in interface RecordLoader<T extends DataRecord>

Parameters:

record - Record to be deleted/removed

See Also:

RecordLoader.removeRecord(org.starhope.appius.util.DataRecord)

saveRecord

public void saveRecord(T record)

Description copied from interface: RecordLoader

Save a record back to the storage system

Specified by:

saveRecord in interface RecordLoader<T extends DataRecord>

Parameters:

record - the record to be saved

See Also:

RecordLoader.saveRecord(org.starhope.appius.util.DataRecord)

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()