org.sandev.basics.sandmessages
Class CacheItemSummary

java.lang.Object
  org.sandev.basics.structs.CacheItemSummaryStruct
      org.sandev.basics.sandmessages.CacheItemSummary

All Implemented Interfaces:

SandInstanceMessage, SandMessage, SandStructMessage, Resolvable

public class CacheItemSummary
extends CacheItemSummaryStruct
implements SandStructMessage, Resolvable

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

Field Summary

Fields inherited from class org.sandev.basics.structs.CacheItemSummaryStruct

classname, lastAccessedTime, size, uniqueID

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

CacheItemSummary()
Default constructor calls init.

Method Summary

CacheItemSummary	cloneCacheItemSummary() Make a deep copy of this CacheItemSummary.
SandInstanceMessage	cloneMessage() Calls cloneCacheItemSummary
SandInstanceMessage	convertToSuperstructClass() Return a new instance of the message associated with the superstruct of this instance.
void	copyDataFrom(CacheItemSummary 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.
java.lang.String	getClassname() Accessor for classname
static java.lang.String	getClassnameDefaultValue() Default value for classname.
java.lang.String	getClassnameFieldPrintValue() Return the print name of the classname field.
static boolean	getClassnameFlag(int fieldflag) Field flag accessor.
static java.lang.String	getClassnameInvalidValue() Invalid value for classname.
static int	getClassnameLengthMax() Maximum classname length is 80 characters
static int	getClassnameLengthNorm() Normal classname length is 40 characters
java.lang.String	getClassnameMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getClassnamePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getClassnameRange() Return the range specification for this field
java.lang.String	getClassnameValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
SandCollectionMessage	getCollectionMessage() Returns a new CacheItemSummaryCollection 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.
java.util.Date	getLastAccessedTime() Accessor for lastAccessedTime
static java.util.Date	getLastAccessedTimeDefaultValue() Default value for lastAccessedTime.
java.lang.String	getLastAccessedTimeFieldPrintValue() Return the print name of the lastAccessedTime field.
static boolean	getLastAccessedTimeFlag(int fieldflag) Field flag accessor.
static java.util.Date	getLastAccessedTimeInvalidValue() Invalid value for lastAccessedTime.
java.lang.String	getLastAccessedTimeMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getLastAccessedTimePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getLastAccessedTimeRange() Return the range specification for this field
java.lang.String	getLastAccessedTimeValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
java.util.Date	getLastAccessedTimeWithOffset() Return the date value incorporating the timezone offset specified for the field, if any.
java.lang.String	getLayoutXML() Return the fieldlayout XML or null if not defined.
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 CacheItemSummaryQuery instance
java.lang.String	getShortName() Returns the unqualified name of this message.
int	getSize() Accessor for size
static int	getSizeDefaultValue() Default value for size.
java.lang.String	getSizeFieldPrintValue() Return the print name of the size field.
static boolean	getSizeFlag(int fieldflag) Field flag accessor.
static int	getSizeInvalidValue() Invalid value for size.
java.lang.String	getSizeMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getSizePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getSizeRange() Return the range specification for this field
java.lang.String	getSizeValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
SandStructMessage	getStructMessage() Returns a new CacheItemSummary instance
long	getUniqueID() Accessor for uniqueID
static long	getUniqueIDDefaultValue() Default value for uniqueID.
java.lang.String	getUniqueIDFieldPrintValue() Return the print name of the uniqueID field.
static boolean	getUniqueIDFlag(int fieldflag) Field flag accessor.
static long	getUniqueIDInvalidValue() Invalid value for uniqueID.
java.lang.String	getUniqueIDMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getUniqueIDPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getUniqueIDRange() Return the range specification for this field
java.lang.String	getUniqueIDValidityCheck() 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
boolean	isEquivalent(SandMessage sm) Declared field equivalence check as specified by the SandMessage interface.
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.
void	setClassname(java.lang.Object classname) Generic mutator for classname
void	setClassname(java.lang.String classname) Mutator for classname
void	setLastAccessedTime(java.util.Date lastAccessedTime) Mutator for lastAccessedTime
void	setLastAccessedTime(java.lang.Object lastAccessedTime) Generic mutator for lastAccessedTime
void	setLastAccessedTimeWithOffset(java.util.Date val) Set the date value incorporating the timezone offset specified for the field, if any.
void	setSize(int size) Mutator for size
void	setUniqueID(long uniqueID) Mutator for uniqueID
CacheItemSummary	shallowCopy() Make a shallow copy of this CacheItemSummary.
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

CacheItemSummary

public CacheItemSummary()

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

getClassname

public java.lang.String getClassname()

Accessor for classname

setClassname

public void setClassname(java.lang.String classname)

Mutator for classname

setClassname

public void setClassname(java.lang.Object classname)

Generic mutator for classname

getClassnameFlag

public static boolean getClassnameFlag(int fieldflag)

Field flag accessor. Returns whether the given FIELDFLAG_* (defined in SandInstanceMessage) is true or false.

getClassnameLengthNorm

public static int getClassnameLengthNorm()

Normal classname length is 40 characters

getClassnameLengthMax

public static int getClassnameLengthMax()

Maximum classname length is 80 characters

getClassnameDefaultValue

public static java.lang.String getClassnameDefaultValue()

Default value for classname. Returns ""

getClassnameInvalidValue

public static java.lang.String getClassnameInvalidValue()

Invalid value for classname. Returns "SANDEV_INVALID_CLASSNAME"

getClassnamePrintValue

public java.lang.String getClassnamePrintValue()

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.

getClassnameFieldPrintValue

public java.lang.String getClassnameFieldPrintValue()

Return the print name of the classname field. If no printname is declared then this returns the field name.

getClassnameRange

public java.lang.String getClassnameRange()

Return the range specification for this field

getClassnameValidityCheck

public java.lang.String getClassnameValidityCheck()

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.

getClassnameMetatype

public java.lang.String getClassnameMetatype()

Return the metatype text for this field, or "" if no metatype was declared.

getUniqueID

public long getUniqueID()

Accessor for uniqueID

setUniqueID

public void setUniqueID(long uniqueID)

Mutator for uniqueID

getUniqueIDFlag

public static boolean getUniqueIDFlag(int fieldflag)

Field flag accessor. Returns whether the given FIELDFLAG_* (defined in SandInstanceMessage) is true or false.

getUniqueIDDefaultValue

public static long getUniqueIDDefaultValue()

Default value for uniqueID. Returns 0

getUniqueIDInvalidValue

public static long getUniqueIDInvalidValue()

Invalid value for uniqueID. Returns Long.MIN_VALUE

getUniqueIDPrintValue

public java.lang.String getUniqueIDPrintValue()

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.

getUniqueIDFieldPrintValue

public java.lang.String getUniqueIDFieldPrintValue()

Return the print name of the uniqueID field. If no printname is declared then this returns the field name.

getUniqueIDRange

public java.lang.String getUniqueIDRange()

Return the range specification for this field

getUniqueIDValidityCheck

public java.lang.String getUniqueIDValidityCheck()

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.

getUniqueIDMetatype

public java.lang.String getUniqueIDMetatype()

Return the metatype text for this field, or "" if no metatype was declared.

getSize

public int getSize()

Accessor for size

setSize

public void setSize(int size)

Mutator for size

getSizeFlag

public static boolean getSizeFlag(int fieldflag)

Field flag accessor. Returns whether the given FIELDFLAG_* (defined in SandInstanceMessage) is true or false.

getSizeDefaultValue

public static int getSizeDefaultValue()

Default value for size. Returns 0

getSizeInvalidValue

public static int getSizeInvalidValue()

Invalid value for size. Returns Integer.MIN_VALUE

getSizePrintValue

public java.lang.String getSizePrintValue()

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.

getSizeFieldPrintValue

public java.lang.String getSizeFieldPrintValue()

Return the print name of the size field. If no printname is declared then this returns the field name.

getSizeRange

public java.lang.String getSizeRange()

Return the range specification for this field

getSizeValidityCheck

public java.lang.String getSizeValidityCheck()

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.

getSizeMetatype

public java.lang.String getSizeMetatype()

Return the metatype text for this field, or "" if no metatype was declared.

getLastAccessedTime

public java.util.Date getLastAccessedTime()

Accessor for lastAccessedTime

setLastAccessedTime

public void setLastAccessedTime(java.util.Date lastAccessedTime)

Mutator for lastAccessedTime

setLastAccessedTime

public void setLastAccessedTime(java.lang.Object lastAccessedTime)

Generic mutator for lastAccessedTime

getLastAccessedTimeFlag

public static boolean getLastAccessedTimeFlag(int fieldflag)

Field flag accessor. Returns whether the given FIELDFLAG_* (defined in SandInstanceMessage) is true or false.

getLastAccessedTimeDefaultValue

public static java.util.Date getLastAccessedTimeDefaultValue()

Default value for lastAccessedTime. Returns System.currentTimeMillis()

getLastAccessedTimeInvalidValue

public static java.util.Date getLastAccessedTimeInvalidValue()

Invalid value for lastAccessedTime. Returns null

getLastAccessedTimePrintValue

public java.lang.String getLastAccessedTimePrintValue()

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.

getLastAccessedTimeFieldPrintValue

public java.lang.String getLastAccessedTimeFieldPrintValue()

Return the print name of the lastAccessedTime field. If no printname is declared then this returns the field name.

getLastAccessedTimeRange

public java.lang.String getLastAccessedTimeRange()

Return the range specification for this field

getLastAccessedTimeWithOffset

public java.util.Date getLastAccessedTimeWithOffset()

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.

setLastAccessedTimeWithOffset

public void setLastAccessedTimeWithOffset(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.

getLastAccessedTimeValidityCheck

public java.lang.String getLastAccessedTimeValidityCheck()

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.

getLastAccessedTimeMetatype

public java.lang.String getLastAccessedTimeMetatype()

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 CacheItemSummaryQuery instance

Specified by:

getQueryMessage in interface SandMessage

getCollectionMessage

public SandCollectionMessage getCollectionMessage()

Returns a new CacheItemSummaryCollection 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 CacheItemSummary 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 cloneCacheItemSummary

Specified by:

cloneMessage in interface SandInstanceMessage

cloneCacheItemSummary

public CacheItemSummary cloneCacheItemSummary()

Make a deep copy of this CacheItemSummary. Creates a new instance and then calls copyDataFrom.

shallowCopy

public CacheItemSummary shallowCopy()

Make a shallow copy of this CacheItemSummary. Creates a new instance and then calls copyDataFrom.

copyDataFrom

public void copyDataFrom(CacheItemSummary 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