Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.sandev.basics.sandmessages
Class CacheStats

java.lang.Object
  extended by org.sandev.basics.structs.CacheStatsStruct
      extended by org.sandev.basics.sandmessages.CacheStats
All Implemented Interfaces:
SandInstanceMessage, SandMessage, SandStructMessage, Resolvable
public class CacheStats
extends CacheStatsStruct
implements SandStructMessage, Resolvable

AUTOGENERATED FILE, DO NOT EDIT DIRECTLY.
source: org.sandev.basics.structs.CacheStatsStruct
generator: org.sandev.generator.MessageClassGenerator
time: Jul 31, 2008 4:34:15 PM

Field Summary
 
Fields inherited from class org.sandev.basics.structs.CacheStatsStruct
items, oldest, oldestAccess, totalMemory, totalObjects
 
Fields inherited from interface org.sandev.basics.structs.SandInstanceMessage
FIELDCHECK_EMPTYSTRINGPRINTVAL, FIELDCHECK_INVALIDVAL, FIELDCHECK_NOTAREF, FIELDCHECK_NOTINRANGE, FIELDCHECK_NULLARRAY, FIELDCHECK_STRINGOVER, FIELDCHECK_UNKNOWNVAL, FIELDFLAG_BINARY, FIELDFLAG_ENCRYPT, FIELDFLAG_INTERNAL, FIELDFLAG_NOECHO, FIELDFLAG_OBFUSCATE, FIELDFLAG_STRINGPERSIST, FIELDFLAG_SUMMARYEDIT, FIELDFLAG_UNIQUE, GENMOD_ACTION_APPEND, GENMOD_ACTION_INSERT, GENMOD_ACTION_REMOVE, GENMOD_ACTION_SET
 
Constructor Summary
CacheStats()
          Default constructor calls init.
 
Method Summary
 void addItems(CacheMemSummary element)
          Appends a value to items
 void addItems(CacheMemSummary[] elements)
          Appends an array of values to items
 void addOldest(CacheItemSummary element)
          Appends a value to oldest
 void addOldest(CacheItemSummary[] elements)
          Appends an array of values to oldest
 void clearItems()
          Clears all values from items
 void clearOldest()
          Clears all values from oldest
 CacheStats cloneCacheStats()
          Make a deep copy of this CacheStats.
 SandInstanceMessage cloneMessage()
          Calls cloneCacheStats
 SandInstanceMessage convertToSuperstructClass()
          Return a new instance of the message associated with the superstruct of this instance.
 void copyDataFrom(CacheStats other, boolean deepcopy)
          Copy all the data from the specified instance.
 void copyFieldValue(java.lang.String fieldName, SandInstanceMessage other)
          Copy the specified field from the given instance.
 java.lang.String debugDump(java.lang.String prefix)
          Dump this instance into a debug printable string.
 void defaultField(java.lang.String fieldname)
          Set the specified field to its default value.
 boolean fieldHasFlag(java.lang.String fieldname, int fieldflag)
          Return true if the named field declares the indicated flag, false otherwise.
 boolean fieldsValid()
          Validate the fields as specified in the SandInstanceMessage interface
 SandAttrVal[] fieldValidate(SandAttrVal[] checkFields)
          Validate the fields as specified in the SandInstanceMessage interface
 SandCollectionMessage find(SandQueryMessage sqm)
          Return a matching collection of all directly contained instances matching the given query.
 java.lang.Object generalAccessor(java.lang.String fieldspec)
          General field accessor method.
 SandAttrVal generalDereference(java.lang.String fieldspec)
          General reference field accessor method.
 void generalModifier(int action, java.lang.String field, int index, java.lang.Object val)
          General mutator method.
 java.lang.String[] getAllFields()
          Return an array of all fields for this class.
 int getBaseMemoryUse()
          Return the base memory use for this object.
 SandCollectionMessage getCollectionMessage()
          Returns a new CacheStatsCollection instance
 java.lang.String[] getContainedMessageFields()
          Return an array of all contained message fields.
 java.lang.String[] getDisplayFields()
          Return an array of the summary field names for this class.
 java.lang.String[] getDisplayFieldsPrint()
          Return an array of the summary field print names for this class.
 java.lang.String getDisplayID()
          Return the displayID for this message instance
 java.lang.String[] getDisplayValues()
          Return the values for the summary fields.
 java.lang.String[] getDisplayValues(IDLookup lookup, AuthUser user, java.lang.String defaultVal)
          Return the values for the summary fields, including dereference expressions.
 SandPersistMessage getInstance(java.lang.String classname, long id)
          If this instance directly contains the specified instance, then find it and return it.
 SandInstanceMessage getInstance(java.lang.String classname, java.lang.String fieldname, java.lang.String value)
          If this instance directly contains the specified instance, then find it and return it.
 CacheMemSummary[] getItems()
          Accessor for items.
 CacheMemSummary getItems(int index)
          Returns the element at the specified index.
static CacheMemSummary[] getItemsDefaultValue()
          Default value for items.
static CacheMemSummary getItemsElementInvalidValue()
          Invalid value for itemselement.
 java.lang.String getItemsFieldPrintValue()
          Return the print name of the items field.
static boolean getItemsFlag(int fieldflag)
          Field flag accessor.
static CacheMemSummary[] getItemsInvalidValue()
          Invalid value for items.
 java.lang.String getItemsMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getItemsPrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getItemsRange()
          Return the range specification for this field
 java.lang.String getItemsValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 java.lang.String getLayoutXML()
          Return the fieldlayout XML or null if not defined.
 CacheItemSummary[] getOldest()
          Accessor for oldest.
 CacheItemSummary getOldest(int index)
          Returns the element at the specified index.
 java.util.Date getOldestAccess()
          Accessor for oldestAccess
static java.util.Date getOldestAccessDefaultValue()
          Default value for oldestAccess.
 java.lang.String getOldestAccessFieldPrintValue()
          Return the print name of the oldestAccess field.
static boolean getOldestAccessFlag(int fieldflag)
          Field flag accessor.
static java.util.Date getOldestAccessInvalidValue()
          Invalid value for oldestAccess.
 java.lang.String getOldestAccessMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getOldestAccessPrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getOldestAccessRange()
          Return the range specification for this field
 java.lang.String getOldestAccessValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 java.util.Date getOldestAccessWithOffset()
          Return the date value incorporating the timezone offset specified for the field, if any.
static CacheItemSummary[] getOldestDefaultValue()
          Default value for oldest.
static CacheItemSummary getOldestElementInvalidValue()
          Invalid value for oldestelement.
 java.lang.String getOldestFieldPrintValue()
          Return the print name of the oldest field.
static boolean getOldestFlag(int fieldflag)
          Field flag accessor.
static CacheItemSummary[] getOldestInvalidValue()
          Invalid value for oldest.
 java.lang.String getOldestMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getOldestPrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getOldestRange()
          Return the range specification for this field
 java.lang.String getOldestValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 java.lang.String getPrintname()
          Return the printname of the class
 java.lang.String getPrintnameForField(java.lang.String fieldname)
          Given a fieldname, return its declared printname if declared.
 SandQueryMessage getQueryMessage()
          Returns a new CacheStatsQuery instance
 java.lang.String getShortName()
          Returns the unqualified name of this message.
 SandStructMessage getStructMessage()
          Returns a new CacheStats instance
 double getTotalMemory()
          Accessor for totalMemory
 double getTotalMemoryAsDecimal()
          decimal value accessor for totalMemory
 int getTotalMemoryDecimals()
          Return the decimals specification for this field
static double getTotalMemoryDefaultValue()
          Default value for totalMemory.
 java.lang.String getTotalMemoryFieldPrintValue()
          Return the print name of the totalMemory field.
static boolean getTotalMemoryFlag(int fieldflag)
          Field flag accessor.
static double getTotalMemoryInvalidValue()
          Invalid value for totalMemory.
 java.lang.String getTotalMemoryMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getTotalMemoryPrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getTotalMemoryRange()
          Return the range specification for this field
 java.lang.String getTotalMemoryValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 int getTotalObjects()
          Accessor for totalObjects
static int getTotalObjectsDefaultValue()
          Default value for totalObjects.
 java.lang.String getTotalObjectsFieldPrintValue()
          Return the print name of the totalObjects field.
static boolean getTotalObjectsFlag(int fieldflag)
          Field flag accessor.
static int getTotalObjectsInvalidValue()
          Invalid value for totalObjects.
 java.lang.String getTotalObjectsMetatype()
          Return the metatype text for this field, or "" if no metatype was declared.
 java.lang.String getTotalObjectsPrintValue()
          Retrieve the current value of this field as a print String.
 java.lang.String getTotalObjectsRange()
          Return the range specification for this field
 java.lang.String getTotalObjectsValidityCheck()
          Return the empty string if the value of this field is valid according to the base SAND declarations.
 SandUpdateMessage getUpdateMessage()
          Returns null
 java.lang.String getValueForFieldName(java.lang.String fieldname, IDLookup lookup, AuthUser user, java.lang.String defaultVal)
          Returns the print representation of the value of the specified field, or the given default value if innaccessible.
 void init()
          Initialize all fields to their default values
 void insertItems(int index, CacheMemSummary value)
          Insert the specified element at the specified index.
 void insertOldest(int index, CacheItemSummary value)
          Insert the specified element at the specified index.
 boolean isEquivalent(SandMessage sm)
          Declared field equivalence check as specified by the SandMessage interface.
 boolean itemsContains(CacheMemSummary val)
          Returns true if items contains the specified value.
 int itemsIndexOf(CacheMemSummary val)
          Return the index of the specified value in items, or -1 if not found.
 boolean oldestContains(CacheItemSummary val)
          Returns true if oldest contains the specified value.
 int oldestIndexOf(CacheItemSummary val)
          Return the index of the specified value in oldest, or -1 if not found.
 java.lang.String[] referenceValidate(java.lang.String[] locations, java.lang.String prefix, IDLookup idlookup, NameLookup namelookup, AuthUser au)
          Validate the references as specified in the Resolvable interface.
 CacheMemSummary removeItems(int index)
          Remove the element at the specified index and return it.
 boolean removeItemsValue(CacheMemSummary value)
          Removes the given element from items.
 CacheItemSummary removeOldest(int index)
          Remove the element at the specified index and return it.
 boolean removeOldestValue(CacheItemSummary value)
          Removes the given element from oldest.
 void setItems(CacheMemSummary[] items)
          Mutator for items
 void setItems(int index, CacheMemSummary value)
          Set the value at the index specified.
 void setItems(java.lang.Object[] items)
          Generic mutator for items
 void setOldest(CacheItemSummary[] oldest)
          Mutator for oldest
 void setOldest(int index, CacheItemSummary value)
          Set the value at the index specified.
 void setOldest(java.lang.Object[] oldest)
          Generic mutator for oldest
 void setOldestAccess(java.util.Date oldestAccess)
          Mutator for oldestAccess
 void setOldestAccess(java.lang.Object oldestAccess)
          Generic mutator for oldestAccess
 void setOldestAccessWithOffset(java.util.Date val)
          Set the date value incorporating the timezone offset specified for the field, if any.
 void setTotalMemory(double totalMemory)
          Mutator for totalMemory
 void setTotalMemoryFromDecimal(double val)
          decimal value mutator for totalMemory
 void setTotalObjects(int totalObjects)
          Mutator for totalObjects
 CacheStats shallowCopy()
          Make a shallow copy of this CacheStats.
 int sizeofItems()
          Returns the size of items.
 int sizeofOldest()
          Returns the size of oldest.
 java.lang.String toString()
          Return a string representation of this object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CacheStats

public CacheStats()
Default constructor calls init.

Method Detail

getPrintname

public java.lang.String getPrintname()
Return the printname of the class

Specified by:
getPrintname in interface SandStructMessage

fieldHasFlag

public boolean fieldHasFlag(java.lang.String fieldname,
                            int fieldflag)
Return true if the named field declares the indicated flag, false otherwise. See the FIELDFLAG* constants in SandInstanceMessage for supported fieldflag values.

Specified by:
fieldHasFlag in interface SandInstanceMessage

getTotalMemory

public double getTotalMemory()
Accessor for totalMemory

setTotalMemory

public void setTotalMemory(double totalMemory)
Mutator for totalMemory

getTotalMemoryFlag

public static boolean getTotalMemoryFlag(int fieldflag)
Field flag accessor. Returns whether the given FIELDFLAG_* (defined in SandInstanceMessage) is true or false.

getTotalMemoryDefaultValue

public static double getTotalMemoryDefaultValue()
Default value for totalMemory. Returns 0.0

getTotalMemoryInvalidValue

public static double getTotalMemoryInvalidValue()
Invalid value for totalMemory. Returns Double.NaN

getTotalMemoryPrintValue

public java.lang.String getTotalMemoryPrintValue()
Retrieve the current value of this field as a print String. For a String field, this returns the current value. For int, long, double this returns the standard string conversion. For a Date, this returns the default DateFormat format. For an enum, this returns the Actual2Print translation of the current value. For a struct this returns a summary description.

Used for debug output, and as an initial value for transformation and formatting.

getTotalMemoryFieldPrintValue

public java.lang.String getTotalMemoryFieldPrintValue()
Return the print name of the totalMemory field. If no printname is declared then this returns the field name.

getTotalMemoryDecimals

public int getTotalMemoryDecimals()
Return the decimals specification for this field

getTotalMemoryAsDecimal

public double getTotalMemoryAsDecimal()
decimal value accessor for totalMemory

setTotalMemoryFromDecimal

public void setTotalMemoryFromDecimal(double val)
decimal value mutator for totalMemory

getTotalMemoryRange

public java.lang.String getTotalMemoryRange()
Return the range specification for this field

getTotalMemoryValidityCheck

public java.lang.String getTotalMemoryValidityCheck()
Return the empty string if the value of this field is valid according to the base SAND declarations. This method supports the fieldValidate method, which is in turn specified by the org.sandev.basics.structs.SandInstanceMessage interface. See the comments there for more information, including a list of error Strings returned from here when a field is not valid.

getTotalMemoryMetatype

public java.lang.String getTotalMemoryMetatype()
Return the metatype text for this field, or "" if no metatype was declared.

getTotalObjects

public int getTotalObjects()
Accessor for totalObjects

setTotalObjects

public void setTotalObjects(int totalObjects)
Mutator for totalObjects

getTotalObjectsFlag

public static boolean getTotalObjectsFlag(int fieldflag)
Field flag accessor. Returns whether the given FIELDFLAG_* (defined in SandInstanceMessage) is true or false.

getTotalObjectsDefaultValue

public static int getTotalObjectsDefaultValue()
Default value for totalObjects. Returns 0

getTotalObjectsInvalidValue

public static int getTotalObjectsInvalidValue()
Invalid value for totalObjects. Returns Integer.MIN_VALUE

getTotalObjectsPrintValue

public java.lang.String getTotalObjectsPrintValue()
Retrieve the current value of this field as a print String. For a String field, this returns the current value. For int, long, double this returns the standard string conversion. For a Date, this returns the default DateFormat format. For an enum, this returns the Actual2Print translation of the current value. For a struct this returns a summary description.

Used for debug output, and as an initial value for transformation and formatting.

getTotalObjectsFieldPrintValue

public java.lang.String getTotalObjectsFieldPrintValue()
Return the print name of the totalObjects field. If no printname is declared then this returns the field name.

getTotalObjectsRange

public java.lang.String getTotalObjectsRange()
Return the range specification for this field

getTotalObjectsValidityCheck

public java.lang.String getTotalObjectsValidityCheck()
Return the empty string if the value of this field is valid according to the base SAND declarations. This method supports the fieldValidate method, which is in turn specified by the org.sandev.basics.structs.SandInstanceMessage interface. See the comments there for more information, including a list of error Strings returned from here when a field is not valid.

getTotalObjectsMetatype

public java.lang.String getTotalObjectsMetatype()
Return the metatype text for this field, or "" if no metatype was declared.

getItems

public CacheMemSummary[] getItems()
Accessor for items. The returned value may or may not be the actual data member. Always write back a changed array using setItems.

setItems

public void setItems(CacheMemSummary[] items)
Mutator for items

setItems

public void setItems(java.lang.Object[] items)
Generic mutator for items

addItems

public void addItems(CacheMemSummary element)
Appends a value to items

addItems

public void addItems(CacheMemSummary[] elements)
Appends an array of values to items

getItems

public CacheMemSummary getItems(int index)
Returns the element at the specified index. Returns null if items is null or smaller than index.

setItems

public void setItems(int index,
                     CacheMemSummary value)
Set the value at the index specified.

insertItems

public void insertItems(int index,
                        CacheMemSummary value)
Insert the specified element at the specified index. If the index specified is greater than the index of the last element, then the value is appended to the existing array.

removeItems

public CacheMemSummary removeItems(int index)
Remove the element at the specified index and return it.

removeItemsValue

public boolean removeItemsValue(CacheMemSummary value)
Removes the given element from items. Returns true if the element was found.

clearItems

public void clearItems()
Clears all values from items

itemsContains

public boolean itemsContains(CacheMemSummary val)
Returns true if items contains the specified value.

itemsIndexOf

public int itemsIndexOf(CacheMemSummary val)
Return the index of the specified value in items, or -1 if not found.

sizeofItems

public int sizeofItems()
Returns the size of items. Returns -1 if items is null.

getItemsFlag

public static boolean getItemsFlag(int fieldflag)
Field flag accessor. Returns whether the given FIELDFLAG_* (defined in SandInstanceMessage) is true or false.

getItemsDefaultValue

public static CacheMemSummary[] getItemsDefaultValue()
Default value for items. Returns new CacheMemSummary[0]

getItemsElementInvalidValue

public static CacheMemSummary getItemsElementInvalidValue()
Invalid value for itemselement. Returns null

getItemsInvalidValue

public static CacheMemSummary[] getItemsInvalidValue()
Invalid value for items. Returns null

getItemsPrintValue

public java.lang.String getItemsPrintValue()
Retrieve the current value of this field as a print String. For a String field, this returns the current value. For int, long, double this returns the standard string conversion. For a Date, this returns the default DateFormat format. For an enum, this returns the Actual2Print translation of the current value. For a struct this returns a summary description.

Used for debug output, and as an initial value for transformation and formatting.

getItemsFieldPrintValue

public java.lang.String getItemsFieldPrintValue()
Return the print name of the items field. If no printname is declared then this returns the field name.

getItemsRange

public java.lang.String getItemsRange()
Return the range specification for this field

getItemsValidityCheck

public java.lang.String getItemsValidityCheck()
Return the empty string if the value of this field is valid according to the base SAND declarations. This method supports the fieldValidate method, which is in turn specified by the org.sandev.basics.structs.SandInstanceMessage interface. See the comments there for more information, including a list of error Strings returned from here when a field is not valid.

getItemsMetatype

public java.lang.String getItemsMetatype()
Return the metatype text for this field, or "" if no metatype was declared.

getOldestAccess

public java.util.Date getOldestAccess()
Accessor for oldestAccess

setOldestAccess

public void setOldestAccess(java.util.Date oldestAccess)
Mutator for oldestAccess

setOldestAccess

public void setOldestAccess(java.lang.Object oldestAccess)
Generic mutator for oldestAccess

getOldestAccessFlag

public static boolean getOldestAccessFlag(int fieldflag)
Field flag accessor. Returns whether the given FIELDFLAG_* (defined in SandInstanceMessage) is true or false.

getOldestAccessDefaultValue

public static java.util.Date getOldestAccessDefaultValue()
Default value for oldestAccess. Returns System.currentTimeMillis()

getOldestAccessInvalidValue

public static java.util.Date getOldestAccessInvalidValue()
Invalid value for oldestAccess. Returns null

getOldestAccessPrintValue

public java.lang.String getOldestAccessPrintValue()
Retrieve the current value of this field as a print String. For a String field, this returns the current value. For int, long, double this returns the standard string conversion. For a Date, this returns the default DateFormat format. For an enum, this returns the Actual2Print translation of the current value. For a struct this returns a summary description.

Used for debug output, and as an initial value for transformation and formatting.

getOldestAccessFieldPrintValue

public java.lang.String getOldestAccessFieldPrintValue()
Return the print name of the oldestAccess field. If no printname is declared then this returns the field name.

getOldestAccessRange

public java.lang.String getOldestAccessRange()
Return the range specification for this field

getOldestAccessWithOffset

public java.util.Date getOldestAccessWithOffset()
Return the date value incorporating the timezone offset specified for the field, if any. This method returns the date value of the field from the perspective of the current runtime environment. In other words the local time at the time of the date value for specified time zone.

setOldestAccessWithOffset

public void setOldestAccessWithOffset(java.util.Date val)
Set the date value incorporating the timezone offset specified for the field, if any. See corresponding get method for more info.

getOldestAccessValidityCheck

public java.lang.String getOldestAccessValidityCheck()
Return the empty string if the value of this field is valid according to the base SAND declarations. This method supports the fieldValidate method, which is in turn specified by the org.sandev.basics.structs.SandInstanceMessage interface. See the comments there for more information, including a list of error Strings returned from here when a field is not valid.

getOldestAccessMetatype

public java.lang.String getOldestAccessMetatype()
Return the metatype text for this field, or "" if no metatype was declared.

getOldest

public CacheItemSummary[] getOldest()
Accessor for oldest. The returned value may or may not be the actual data member. Always write back a changed array using setOldest.

setOldest

public void setOldest(CacheItemSummary[] oldest)
Mutator for oldest

setOldest

public void setOldest(java.lang.Object[] oldest)
Generic mutator for oldest

addOldest

public void addOldest(CacheItemSummary element)
Appends a value to oldest

addOldest

public void addOldest(CacheItemSummary[] elements)
Appends an array of values to oldest

getOldest

public CacheItemSummary getOldest(int index)
Returns the element at the specified index. Returns null if oldest is null or smaller than index.

setOldest

public void setOldest(int index,
                      CacheItemSummary value)
Set the value at the index specified.

insertOldest

public void insertOldest(int index,
                         CacheItemSummary value)
Insert the specified element at the specified index. If the index specified is greater than the index of the last element, then the value is appended to the existing array.

removeOldest

public CacheItemSummary removeOldest(int index)
Remove the element at the specified index and return it.

removeOldestValue

public boolean removeOldestValue(CacheItemSummary value)
Removes the given element from oldest. Returns true if the element was found.

clearOldest

public void clearOldest()
Clears all values from oldest

oldestContains

public boolean oldestContains(CacheItemSummary val)
Returns true if oldest contains the specified value.

oldestIndexOf

public int oldestIndexOf(CacheItemSummary val)
Return the index of the specified value in oldest, or -1 if not found.

sizeofOldest

public int sizeofOldest()
Returns the size of oldest. Returns -1 if oldest is null.

getOldestFlag

public static boolean getOldestFlag(int fieldflag)
Field flag accessor. Returns whether the given FIELDFLAG_* (defined in SandInstanceMessage) is true or false.

getOldestDefaultValue

public static CacheItemSummary[] getOldestDefaultValue()
Default value for oldest. Returns new CacheItemSummary[0]

getOldestElementInvalidValue

public static CacheItemSummary getOldestElementInvalidValue()
Invalid value for oldestelement. Returns null

getOldestInvalidValue

public static CacheItemSummary[] getOldestInvalidValue()
Invalid value for oldest. Returns null

getOldestPrintValue

public java.lang.String getOldestPrintValue()
Retrieve the current value of this field as a print String. For a String field, this returns the current value. For int, long, double this returns the standard string conversion. For a Date, this returns the default DateFormat format. For an enum, this returns the Actual2Print translation of the current value. For a struct this returns a summary description.

Used for debug output, and as an initial value for transformation and formatting.

getOldestFieldPrintValue

public java.lang.String getOldestFieldPrintValue()
Return the print name of the oldest field. If no printname is declared then this returns the field name.

getOldestRange

public java.lang.String getOldestRange()
Return the range specification for this field

getOldestValidityCheck

public java.lang.String getOldestValidityCheck()
Return the empty string if the value of this field is valid according to the base SAND declarations. This method supports the fieldValidate method, which is in turn specified by the org.sandev.basics.structs.SandInstanceMessage interface. See the comments there for more information, including a list of error Strings returned from here when a field is not valid.

getOldestMetatype

public java.lang.String getOldestMetatype()
Return the metatype text for this field, or "" if no metatype was declared.

init

public void init()
Initialize all fields to their default values

getShortName

public java.lang.String getShortName()
Returns the unqualified name of this message.

Specified by:
getShortName in interface SandMessage

getQueryMessage

public SandQueryMessage getQueryMessage()
Returns a new CacheStatsQuery instance

Specified by:
getQueryMessage in interface SandMessage

getCollectionMessage

public SandCollectionMessage getCollectionMessage()
Returns a new CacheStatsCollection instance

Specified by:
getCollectionMessage in interface SandMessage

getUpdateMessage

public SandUpdateMessage getUpdateMessage()
Returns null

Specified by:
getUpdateMessage in interface SandMessage

getStructMessage

public SandStructMessage getStructMessage()
Returns a new CacheStats instance

Specified by:
getStructMessage in interface SandMessage

isEquivalent

public boolean isEquivalent(SandMessage sm)
Declared field equivalence check as specified by the SandMessage interface. String values are trimmed before comparison because conversions may occasionally result in trailing whitespace, which should not cause equivalence comparisons to fail. Comparisons are case insensitive since that corresponds to what most people expect, and how most databases work.

When comparing arrays, it is possible that the array elements may have been set to null as part of authorization filtering or similar unusual circumstances. A null array element is only equivalent to another null array element.

Specified by:
isEquivalent in interface SandMessage

getBaseMemoryUse

public int getBaseMemoryUse()
Return the base memory use for this object. This number is a minimum value for estimation purposes, see the comments in the SandStructMessage declaration for details.

Specified by:
getBaseMemoryUse in interface SandMessage

generalModifier

public void generalModifier(int action,
                            java.lang.String field,
                            int index,
                            java.lang.Object val)
                     throws SandException
General mutator method. Specified by SandInstanceMessage interface.

Specified by:
generalModifier in interface SandInstanceMessage
Throws:
SandException

generalDereference

public SandAttrVal generalDereference(java.lang.String fieldspec)
General reference field accessor method. Specified by SandInstanceMessage interface.

Specified by:
generalDereference in interface SandInstanceMessage

generalAccessor

public java.lang.Object generalAccessor(java.lang.String fieldspec)
General field accessor method. Specified by SandInstanceMessage interface.

Specified by:
generalAccessor in interface SandInstanceMessage

getDisplayFields

public java.lang.String[] getDisplayFields()
Return an array of the summary field names for this class.

Specified by:
getDisplayFields in interface SandInstanceMessage

getDisplayFieldsPrint

public java.lang.String[] getDisplayFieldsPrint()
Return an array of the summary field print names for this class.

Specified by:
getDisplayFieldsPrint in interface SandInstanceMessage

getLayoutXML

public java.lang.String getLayoutXML()
Return the fieldlayout XML or null if not defined.

Specified by:
getLayoutXML in interface SandInstanceMessage

getDisplayValues

public java.lang.String[] getDisplayValues()
Return the values for the summary fields. The standard String representation of each value is returned. For Dates, the default DateFormat output is used. For enums, the print value is used. These can be further transformed as needed.

Specified by:
getDisplayValues in interface SandInstanceMessage

getDisplayValues

public java.lang.String[] getDisplayValues(IDLookup lookup,
                                           AuthUser user,
                                           java.lang.String defaultVal)
Return the values for the summary fields, including dereference expressions.

Specified by:
getDisplayValues in interface Resolvable

getValueForFieldName

public java.lang.String getValueForFieldName(java.lang.String fieldname,
                                             IDLookup lookup,
                                             AuthUser user,
                                             java.lang.String defaultVal)
Returns the print representation of the value of the specified field, or the given default value if innaccessible. A field value may be innaccessible due to authorization, null reference, or other call failure.

getAllFields

public java.lang.String[] getAllFields()
Return an array of all fields for this class.

Specified by:
getAllFields in interface SandInstanceMessage

getContainedMessageFields

public java.lang.String[] getContainedMessageFields()
Return an array of all contained message fields.

Specified by:
getContainedMessageFields in interface SandInstanceMessage

defaultField

public void defaultField(java.lang.String fieldname)
Set the specified field to its default value.

Specified by:
defaultField in interface SandInstanceMessage

getPrintnameForField

public java.lang.String getPrintnameForField(java.lang.String fieldname)
Given a fieldname, return its declared printname if declared. If no printname was declared then this returns the field name.

Specified by:
getPrintnameForField in interface SandInstanceMessage

cloneMessage

public SandInstanceMessage cloneMessage()
Calls cloneCacheStats

Specified by:
cloneMessage in interface SandInstanceMessage

cloneCacheStats

public CacheStats cloneCacheStats()
Make a deep copy of this CacheStats. Creates a new instance and then calls copyDataFrom.

shallowCopy

public CacheStats shallowCopy()
Make a shallow copy of this CacheStats. Creates a new instance and then calls copyDataFrom.

copyDataFrom

public void copyDataFrom(CacheStats other,
                         boolean deepcopy)
Copy all the data from the specified instance. If the other instance is null then this method does nothing. If deepcopy is specified then contained structs are copied, otherwise not. The one field this does not copy is instanceWriteAccess, since you need the copied instance to be writeable.

copyFieldValue

public void copyFieldValue(java.lang.String fieldName,
                           SandInstanceMessage other)
Copy the specified field from the given instance.

Specified by:
copyFieldValue in interface SandInstanceMessage

fieldValidate

public SandAttrVal[] fieldValidate(SandAttrVal[] checkFields)
Validate the fields as specified in the SandInstanceMessage interface

Specified by:
fieldValidate in interface SandInstanceMessage

fieldsValid

public boolean fieldsValid()
Validate the fields as specified in the SandInstanceMessage interface

Specified by:
fieldsValid in interface SandInstanceMessage

referenceValidate

public java.lang.String[] referenceValidate(java.lang.String[] locations,
                                            java.lang.String prefix,
                                            IDLookup idlookup,
                                            NameLookup namelookup,
                                            AuthUser au)
                                     throws SandException
Validate the references as specified in the Resolvable interface.

Specified by:
referenceValidate in interface Resolvable
Throws:
SandException

convertToSuperstructClass

public SandInstanceMessage convertToSuperstructClass()
Return a new instance of the message associated with the superstruct of this instance. Return null if the source struct for this message does not extend another struct.

Specified by:
convertToSuperstructClass in interface SandInstanceMessage

debugDump

public java.lang.String debugDump(java.lang.String prefix)
Dump this instance into a debug printable string.

Specified by:
debugDump in interface SandInstanceMessage

getDisplayID

public java.lang.String getDisplayID()
Return the displayID for this message instance

Specified by:
getDisplayID in interface SandInstanceMessage

getInstance

public SandPersistMessage getInstance(java.lang.String classname,
                                      long id)
If this instance directly contains the specified instance, then find it and return it. Returns null if not found.

Specified by:
getInstance in interface SandStructMessage

getInstance

public SandInstanceMessage getInstance(java.lang.String classname,
                                       java.lang.String fieldname,
                                       java.lang.String value)
If this instance directly contains the specified instance, then find it and return it. Returns null if not found.

Specified by:
getInstance in interface SandStructMessage

find

public SandCollectionMessage find(SandQueryMessage sqm)
Return a matching collection of all directly contained instances matching the given query.

Specified by:
find in interface SandStructMessage

toString

public java.lang.String toString()
Return a string representation of this object. Uses the declared summary fields minus any dereference expressions.

Overrides:
toString in class java.lang.Object
Overview  Package   Class  Tree  Deprecated  Index  Help