org.starhope.appius.user
Class AvatarBodyFormatSQLLoader

java.lang.Object
  org.starhope.appius.user.AvatarBodyFormatSQLLoader

All Implemented Interfaces:

RecordLoader<AvatarBodyFormat>, HasSubversionRevision

public class AvatarBodyFormatSQLLoader
extends Object
implements RecordLoader<AvatarBodyFormat>

WRITEME: Document this type.

Author:

brpocock@star-hope.org

Constructor Summary

AvatarBodyFormatSQLLoader()

Method Summary

void	changed(AvatarBodyFormat 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()
private AvatarBodyFormat	load(AvatarBodyFormat body, ResultSet rs) Actually parse the SQL record into the DataRecord
AvatarBodyFormat	loadRecord(int id) Load the record with the given ID number from the storage system
AvatarBodyFormat	loadRecord(String identifier) Load the data record identified from the storage system.
void	refresh(AvatarBodyFormat record) Refreshes the record: Re-read the contents of the database into the given record.
void	removeRecord(AvatarBodyFormat record)
void	saveRecord(AvatarBodyFormat record) Save a record back to the storage system

Methods inherited from class java.lang.Object

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

Constructor Detail

AvatarBodyFormatSQLLoader

public AvatarBodyFormatSQLLoader()

Method Detail

changed

public void changed(AvatarBodyFormat changedRecord)

Description copied from interface: RecordLoader

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

Specified by:

changed in interface RecordLoader<AvatarBodyFormat>

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

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

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

load

private AvatarBodyFormat load(AvatarBodyFormat body,
                              ResultSet rs)
                       throws SQLException

Actually parse the SQL record into the DataRecord

Parameters:

body - record to be loaded

rs - result set from which to load

Returns:

the record, loaded with the values from the result set

Throws:

SQLException - if the record can't be parsed

loadRecord

public AvatarBodyFormat 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<AvatarBodyFormat>

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

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

Parameters:

record - the record to be reloaded.

See Also:

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

removeRecord

public void removeRecord(AvatarBodyFormat record)

Specified by:

removeRecord in interface RecordLoader<AvatarBodyFormat>

Parameters:

record - Record to be deleted/removed

See Also:

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

saveRecord

public void saveRecord(AvatarBodyFormat record)

Description copied from interface: RecordLoader

Save a record back to the storage system

Specified by:

saveRecord in interface RecordLoader<AvatarBodyFormat>

Parameters:

record - the record to be saved

See Also:

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