org.starhope.appius.user
Class StringSet

java.lang.Object
  org.starhope.appius.util.SimpleDataRecord<SimpleDataRecordSet<DataRecordClass,DataRecordSetClass>>
      org.starhope.appius.util.SimpleDataRecordSet<StringRecord,StringSet>
          org.starhope.appius.user.StringSet

All Implemented Interfaces:

com.whirlycott.cache.Cacheable, Serializable, Comparable<SimpleDataRecordSet<StringRecord,StringSet>>, Iterable<StringRecord>, Collection<StringRecord>, CTime, DataRecord, DataRecordSet<StringRecord>, HasSubversionRevision

public class StringSet
extends SimpleDataRecordSet<StringRecord,StringSet>

A collection of strings obtained from an arbitrary source, with minimal translation support; a set of StringRecords

Author:

brpocock@star-hope.org

See Also:

Serialized Form

Field Summary

private int	myID unique ID for this set of strings
private String	myName unique name for this set of strings
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

StringSet(RecordLoader<SimpleDataRecordSet<StringRecord,StringSet>> loader)
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.
int	getID()
String	getName()
String	getSubversionRevision() Return the Subversion revision level of this class's source code file, as supplied via the special "$Rev: " sequence.
void	setID(int id)
void	setName(String name)

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

add, addAll, clear, contains, containsAll, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray

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

Methods inherited from interface java.util.Collection

equals, hashCode

Methods inherited from interface org.starhope.appius.util.DataRecord

checkStale, getRecordLoader, isBeingLoaded, markAsLoaded, markAsSaved, setRecordLoader

Methods inherited from interface org.starhope.appius.util.CTime

getTimeLastChanged, getTimeLastSaved

Methods inherited from interface com.whirlycott.cache.Cacheable

onRemove, onRetrieve, onStore

Field Detail

serialVersionUID

private static final long serialVersionUID

WRITEME: Document this brpocock@star-hope.org

See Also:

Constant Field Values

myID

private int myID

unique ID for this set of strings

myName

private String myName

unique name for this set of strings

Constructor Detail

StringSet

public StringSet(RecordLoader<SimpleDataRecordSet<StringRecord,StringSet>> loader)

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

Parameters:

loader - the record loader

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

getID

public int getID()

Returns:

an unique ID for this set of strings

getName

public String getName()

Returns:

an unique name for this set of strings

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: 1983 $"

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

Returns:

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

See Also:

HasSubversionRevision.getSubversionRevision()

setID

public void setID(int id)

Parameters:

id - the unique ID for this set of strings

setName

public void setName(String name)

Parameters:

name - the unique name for this set of strings