com.isti.util
Class TagValueTrkTable

java.lang.Object
  extended by com.isti.util.TagValueTable
      extended by com.isti.util.TagValueTrkTable

public class TagValueTrkTable
extends TagValueTable

Class TagValueTrkTable defines a table where each entry contains a a tag string and a mutable integer value. Optional historical tracking of entered values is also available.


Nested Class Summary
 class TagValueTrkTable.TrackingMutableLong
          Class TrackingMutableLong extends MutableLong to add historical tracking of values.
 
Nested classes/interfaces inherited from class com.isti.util.TagValueTable
TagValueTable.MutableLong
 
Field Summary
static int DEF_TRKBUFF_SIZE
          Default number of values to track (100).
 
Fields inherited from class com.isti.util.TagValueTable
hashTableObj
 
Constructor Summary
TagValueTrkTable()
          Creates a tag-value table, with historical tracking of values.
TagValueTrkTable(boolean trackValsFlag)
          Creates a tag-value table, with optional historical tracking of values.
TagValueTrkTable(boolean trackValsFlag, int trkBuffSize)
          Creates a tag-value table, with optional historical tracking of values.
 
Method Summary
 TagValueTable.MutableLong createMutableLong(long value)
          Creates a new 'TrackingMutableLong' object.
 boolean isValueInTrkBuffer(java.lang.String tagStr, long value)
          Determines if the given value was entered for the given tag string via a previous call to the 'put()' method.
 boolean isValueInTrkBuffer(java.lang.String tagStr, java.lang.Long valueObj)
          Determines if the given value was entered for the given tag string via a previous call to the 'put()' method.
 
Methods inherited from class com.isti.util.TagValueTable
clone, entriesListStrToTable, get, getEntriesListStr, getEntriesListStr, getLong, getMutableLong, getNumEntries, put, remove
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DEF_TRKBUFF_SIZE

public static final int DEF_TRKBUFF_SIZE
Default number of values to track (100).

See Also:
Constant Field Values
Constructor Detail

TagValueTrkTable

public TagValueTrkTable(boolean trackValsFlag,
                        int trkBuffSize)
Creates a tag-value table, with optional historical tracking of values.

Parameters:
trackValsFlag - true to track values, false to not track values (operate like TagValueTable).
trkBuffSize - number of values to track.

TagValueTrkTable

public TagValueTrkTable(boolean trackValsFlag)
Creates a tag-value table, with optional historical tracking of values. The default number of values are tracked.

Parameters:
trackValsFlag - true to track values, false to not track values (operate like TagValueTable).

TagValueTrkTable

public TagValueTrkTable()
Creates a tag-value table, with historical tracking of values. The default number of values are tracked.

Method Detail

createMutableLong

public TagValueTable.MutableLong createMutableLong(long value)
Creates a new 'TrackingMutableLong' object.

Overrides:
createMutableLong in class TagValueTable
Parameters:
value - value for new 'TrackingMutableLong' object.
Returns:
A new 'TrackingMutableLong' object.

isValueInTrkBuffer

public boolean isValueInTrkBuffer(java.lang.String tagStr,
                                  long value)
Determines if the given value was entered for the given tag string via a previous call to the 'put()' method.

Parameters:
tagStr - tag string to use.
value - value to use.
Returns:
true if the value was found in the tracking buffer; false if the value was not found in the tracking buffer or the tracking buffer is not setup.

isValueInTrkBuffer

public boolean isValueInTrkBuffer(java.lang.String tagStr,
                                  java.lang.Long valueObj)
Determines if the given value was entered for the given tag string via a previous call to the 'put()' method.

Parameters:
tagStr - tag string to use.
valueObj - value object to use.
Returns:
true if the value was found in the tracking buffer; false if the value was not found in the tracking buffer or the tracking buffer is not setup.