org.starhope.appius.user
Class UserPreferenceRecord

java.lang.Object
  org.starhope.appius.util.SimpleDataRecord<UserPreferenceRecord>
      org.starhope.appius.user.UserPreferenceRecord

All Implemented Interfaces:

com.whirlycott.cache.Cacheable, Serializable, Comparable<UserPreferenceRecord>, CTime, DataRecord, HasSubversionRevision

public class UserPreferenceRecord
extends SimpleDataRecord<UserPreferenceRecord>

Provide storage for user preferences

Author:

brpocock@star-hope.org

See Also:

Serialized Form

Field Summary

private int	myUserID WRITEME: Document this brpocock@star-hope.org
private Map<String,String>	prefs WRITEME: Document this brpocock@star-hope.org
private static long	serialVersionUID WRITEME: Document this brpocock@star-hope.org

Fields inherited from class org.starhope.appius.util.SimpleDataRecord

myLoader, timeLastChanged, timeLastSaved

Constructor Summary

UserPreferenceRecord(AbstractUser u)
WRITEME: Document this constructor brpocock@star-hope.org

Method Summary

int	getCacheableID() Note that all records must have either a numeric ID ( DataRecord.getCacheableID() or a string identifier ( DataRecord.getCacheableIdent() or both.
String	getCacheableIdent() Note that all records must have either a numeric ID ( DataRecord.getCacheableID() or a string identifier ( DataRecord.getCacheableIdent() or both.
String	getSubversionRevision() Return the Subversion revision level of this class's source code file, as supplied via the special "$Rev: " sequence.
private Map<String,String>	jsonToMap(org.json.JSONObject jso, String prefix) WRITEME: Document this method brpocock@star-hope.org
void	save(org.json.JSONObject jso) WRITEME: Document this method brpocock@star-hope.org
void	save(Map<String,String> keys) WRITEME: Document this method brpocock@star-hope.org
void	save(String key, String value) WRITEME: Document this method brpocock@star-hope.org

Methods inherited from class org.starhope.appius.util.SimpleDataRecord

changed, checkStale, compareTo, equals, finalize, getRecordLoader, getTimeLastChanged, getTimeLastSaved, hashCode, isBeingLoaded, markAsLoaded, markAsSaved, markForReload, onRemove, onRetrieve, onStore, save, setRecordLoader, toString

Methods inherited from class java.lang.Object

clone, getClass, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

WRITEME: Document this brpocock@star-hope.org

See Also:

Constant Field Values

myUserID

private int myUserID

WRITEME: Document this brpocock@star-hope.org

prefs

private final Map<String,String> prefs

WRITEME: Document this brpocock@star-hope.org

Constructor Detail

UserPreferenceRecord

public UserPreferenceRecord(AbstractUser u)
                     throws AlreadyExistsException

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

Parameters:

u - WRITEME

Throws:

AlreadyExistsException - if the user already has a preferences file

Method Detail

getCacheableID

public int getCacheableID()
                   throws NotFoundException

Description copied from interface: DataRecord

Note that all records must have either a numeric ID ( DataRecord.getCacheableID() or a string identifier ( DataRecord.getCacheableIdent() or both.

Returns:

an unique ID number

Throws:

NotFoundException - if the item doesn't have a distinct numeric ID

See Also:

DataRecord.getCacheableID()

getCacheableIdent

public String getCacheableIdent()
                         throws NotFoundException

Description copied from interface: DataRecord

Note that all records must have either a numeric ID ( DataRecord.getCacheableID() or a string identifier ( DataRecord.getCacheableIdent() or both.

Returns:

an unique identifier string

Throws:

NotFoundException - if the item doesn't have a distinct string identifier

See Also:

DataRecord.getCacheableIdent()

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: ";
 }
 

Returns:

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

See Also:

HasSubversionRevision.getSubversionRevision()

jsonToMap

private Map<String,String> jsonToMap(org.json.JSONObject jso,
                                     String prefix)

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

Parameters:

jso - WRITEME

prefix - WRITEME

Returns:

WRITEME

save

public void save(org.json.JSONObject jso)

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

Parameters:

jso - JSON values to be saved

save

public void save(Map<String,String> keys)

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

Parameters:

keys - WRITEME

save

public void save(String key,
                 String value)

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

Parameters:

key - WRITEME

value - WRITEME