org.starhope.appius.game.inventory
Class GenericItemReferenceSQLLoader

java.lang.Object
  org.starhope.appius.game.inventory.GenericItemReferenceSQLLoader

All Implemented Interfaces:

RecordLoader<GenericItemReference>, HasSubversionRevision

public class GenericItemReferenceSQLLoader
extends Object
implements RecordLoader<GenericItemReference>

WRITEME: Document this type.

Author:

brpocock@star-hope.org

Constructor Summary

GenericItemReferenceSQLLoader()

Method Summary

void	changed(GenericItemReference 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.
void	initializeStorage(String storageURL) Prepare the RecordLoader for accessing a given storage medium.
boolean	isRealtime()
GenericItemReference	loadRecord(int id) Load the record with the given ID number from the storage system
GenericItemReference	loadRecord(String identifier) Load the data record identified from the storage system.
void	refresh(GenericItemReference record) Refreshes the record: Re-read the contents of the database into the given record.
private GenericItemReference	reload(ResultSet rs, GenericItemReference rec) Loads the result set into the record
void	removeRecord(GenericItemReference record)
void	saveRecord(GenericItemReference record) Save a record back to the storage system
private GenericItemReference	set(ResultSet rs) WRITEME: Document this method brpocock@star-hope.org

Methods inherited from class java.lang.Object

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

Constructor Detail

GenericItemReferenceSQLLoader

public GenericItemReferenceSQLLoader()

Method Detail

changed

public void changed(GenericItemReference changedRecord)

Description copied from interface: RecordLoader

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

Specified by:

changed in interface RecordLoader<GenericItemReference>

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()

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<GenericItemReference>

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<GenericItemReference>

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 GenericItemReference 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<GenericItemReference>

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 GenericItemReference 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<GenericItemReference>

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(GenericItemReference 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<GenericItemReference>

Parameters:

record - the record to be reloaded.

reload

private GenericItemReference reload(ResultSet rs,
                                    GenericItemReference rec)
                             throws SQLException

Loads the result set into the record

Parameters:

rs - Result Set

rec - GenericItemReference record

Returns:

The GenericItemReference record

Throws:

SQLException - if the record can't be parsed

removeRecord

public void removeRecord(GenericItemReference record)

Specified by:

removeRecord in interface RecordLoader<GenericItemReference>

Parameters:

record - Record to be deleted/removed

See Also:

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

saveRecord

public void saveRecord(GenericItemReference record)

Description copied from interface: RecordLoader

Save a record back to the storage system

Specified by:

saveRecord in interface RecordLoader<GenericItemReference>

Parameters:

record - the record to be saved

See Also:

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

set

private GenericItemReference set(ResultSet rs)
                          throws SQLException

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

Parameters:

rs - result set

Returns:

WRITEME

Throws:

SQLException - WRITEME