org.sandev.TaskHeap.sandmessages
Class HeapAccessSummary

java.lang.Object
  org.sandev.TaskHeap.structs.HeapAccessSummaryStruct
      org.sandev.TaskHeap.sandmessages.HeapAccessSummary

All Implemented Interfaces:

org.sandev.basics.structs.SandInstanceMessage, org.sandev.basics.structs.SandMessage, org.sandev.basics.structs.SandStructMessage, org.sandev.basics.util.Resolvable

public class HeapAccessSummary
extends HeapAccessSummaryStruct
implements org.sandev.basics.structs.SandStructMessage, org.sandev.basics.util.Resolvable

AUTOGENERATED FILE, DO NOT EDIT DIRECTLY.
source: org.sandev.TaskHeap.structs.HeapAccessSummaryStruct
generator: org.sandev.generator.MessageClassGenerator
time: Jul 31, 2008 4:34:16 PM

Field Summary

static int	STATUS_AVAILABLE Possible value for status
static int	STATUS_SELECTED Possible value for status
static int	TYPE_ASSOC Possible value for type
static int	TYPE_HEAP Possible value for type
static int	TYPE_TREEROOT Possible value for type

Fields inherited from class org.sandev.TaskHeap.structs.HeapAccessSummaryStruct

association, children, heap, heapName, indent, lineNumber, parent, status, type

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

HeapAccessSummary()
Default constructor calls init.

Method Summary

void	addChildren(HeapAccessSummary element) Appends a value to children
void	addChildren(HeapAccessSummary[] elements) Appends an array of values to children
boolean	childrenContains(HeapAccessSummary val) Returns true if children contains the specified value.
int	childrenIndexOf(HeapAccessSummary val) Return the index of the specified value in children, or -1 if not found.
void	clearChildren() Clears all values from children
HeapAccessSummary	cloneHeapAccessSummary() Make a deep copy of this HeapAccessSummary.
org.sandev.basics.structs.SandInstanceMessage	cloneMessage() Calls cloneHeapAccessSummary
org.sandev.basics.structs.SandInstanceMessage	convertToSuperstructClass() Return a new instance of the message associated with the superstruct of this instance.
void	copyDataFrom(HeapAccessSummary other, boolean deepcopy) Copy all the data from the specified instance.
void	copyFieldValue(java.lang.String fieldName, org.sandev.basics.structs.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
org.sandev.basics.structs.SandAttrVal[]	fieldValidate(org.sandev.basics.structs.SandAttrVal[] checkFields) Validate the fields as specified in the SandInstanceMessage interface
org.sandev.basics.structs.SandCollectionMessage	find(org.sandev.basics.structs.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.
org.sandev.basics.structs.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.
long	getAssociation() Accessor for association
static long	getAssociationDefaultValue() Default value for association.
java.lang.String	getAssociationFieldPrintValue() Return the print name of the association field.
static boolean	getAssociationFlag(int fieldflag) Field flag accessor.
static long	getAssociationInvalidValue() Invalid value for association.
java.lang.String	getAssociationMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getAssociationPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getAssociationRange() Return the range specification for this field
java.lang.String	getAssociationValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
int	getBaseMemoryUse() Return the base memory use for this object.
HeapAccessSummary[]	getChildren() Accessor for children.
HeapAccessSummary	getChildren(int index) Returns the element at the specified index.
static HeapAccessSummary[]	getChildrenDefaultValue() Default value for children.
static HeapAccessSummary	getChildrenElementInvalidValue() Invalid value for childrenelement.
java.lang.String	getChildrenFieldPrintValue() Return the print name of the children field.
static boolean	getChildrenFlag(int fieldflag) Field flag accessor.
static HeapAccessSummary[]	getChildrenInvalidValue() Invalid value for children.
java.lang.String	getChildrenMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getChildrenPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getChildrenRange() Return the range specification for this field
java.lang.String	getChildrenValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
org.sandev.basics.structs.SandCollectionMessage	getCollectionMessage() Returns a new HeapAccessSummaryCollection 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(org.sandev.basics.util.IDLookup lookup, org.sandev.basics.util.AuthUser user, java.lang.String defaultVal) Return the values for the summary fields, including dereference expressions.
long	getHeap() Accessor for heap
static long	getHeapDefaultValue() Default value for heap.
java.lang.String	getHeapFieldPrintValue() Return the print name of the heap field.
static boolean	getHeapFlag(int fieldflag) Field flag accessor.
static long	getHeapInvalidValue() Invalid value for heap.
java.lang.String	getHeapMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getHeapName() Accessor for heapName
static java.lang.String	getHeapNameDefaultValue() Default value for heapName.
java.lang.String	getHeapNameFieldPrintValue() Return the print name of the heapName field.
static boolean	getHeapNameFlag(int fieldflag) Field flag accessor.
static java.lang.String	getHeapNameInvalidValue() Invalid value for heapName.
static int	getHeapNameLengthMax() Maximum heapName length is 80 characters
static int	getHeapNameLengthNorm() Normal heapName length is 30 characters
java.lang.String	getHeapNameMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getHeapNamePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getHeapNameRange() Return the range specification for this field
java.lang.String	getHeapNameValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
java.lang.String	getHeapPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getHeapRange() Return the range specification for this field
java.lang.String	getHeapValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
java.lang.String	getIndent() Accessor for indent
static java.lang.String	getIndentDefaultValue() Default value for indent.
java.lang.String	getIndentFieldPrintValue() Return the print name of the indent field.
static boolean	getIndentFlag(int fieldflag) Field flag accessor.
static java.lang.String	getIndentInvalidValue() Invalid value for indent.
static int	getIndentLengthMax() Maximum indent length is 70 characters
static int	getIndentLengthNorm() Normal indent length is 30 characters
java.lang.String	getIndentMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getIndentPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getIndentRange() Return the range specification for this field
java.lang.String	getIndentValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
org.sandev.basics.structs.SandPersistMessage	getInstance(java.lang.String classname, long id) If this instance directly contains the specified instance, then find it and return it.
org.sandev.basics.structs.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.lang.String	getLayoutXML() Return the fieldlayout XML or null if not defined.
int	getLineNumber() Accessor for lineNumber
static int	getLineNumberDefaultValue() Default value for lineNumber.
java.lang.String	getLineNumberFieldPrintValue() Return the print name of the lineNumber field.
static boolean	getLineNumberFlag(int fieldflag) Field flag accessor.
static int	getLineNumberInvalidValue() Invalid value for lineNumber.
java.lang.String	getLineNumberMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getLineNumberPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getLineNumberRange() Return the range specification for this field
java.lang.String	getLineNumberValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
HeapAccessSummary	getParent() Accessor for parent
static HeapAccessSummary	getParentDefaultValue() Default value for parent.
java.lang.String	getParentFieldPrintValue() Return the print name of the parent field.
static boolean	getParentFlag(int fieldflag) Field flag accessor.
static HeapAccessSummary	getParentInvalidValue() Invalid value for parent.
java.lang.String	getParentMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getParentPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getParentRange() Return the range specification for this field
java.lang.String	getParentValidityCheck() 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.
org.sandev.basics.structs.SandQueryMessage	getQueryMessage() Returns null
java.lang.String	getShortName() Returns the unqualified name of this message.
int	getStatus() Accessor for status
static java.lang.String[]	getStatusActualVals() Return an array of the possible values for this field as Strings.
static int	getStatusDefaultValue() Default value for status.
static java.lang.String	getStatusEnumSummary() Return a single String summary of the possible enum values for debug and similar purposes.
java.lang.String	getStatusFieldPrintValue() Return the print name of the status field.
static boolean	getStatusFlag(int fieldflag) Field flag accessor.
static int	getStatusInvalidValue() Invalid value for status.
static java.lang.String[]	getStatusKeyVals() Return an array of unique keys for the values of this field.
java.lang.String	getStatusMetatype() Return the metatype text for this field, or "" if no metatype was declared.
static java.lang.String[]	getStatusPrintVals() Return an array of the possible values for this field in display format.
java.lang.String	getStatusPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getStatusRange() Return the range specification for this field
java.lang.String	getStatusValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
org.sandev.basics.structs.SandStructMessage	getStructMessage() Returns a new HeapAccessSummary instance
HeapAccessSummary[]	getTreeChildren() Tree accessor for child references
HeapAccessSummary	getTreeParent() Tree accessor for parent reference
int	getType() Accessor for type
static java.lang.String[]	getTypeActualVals() Return an array of the possible values for this field as Strings.
static int	getTypeDefaultValue() Default value for type.
static java.lang.String	getTypeEnumSummary() Return a single String summary of the possible enum values for debug and similar purposes.
java.lang.String	getTypeFieldPrintValue() Return the print name of the type field.
static boolean	getTypeFlag(int fieldflag) Field flag accessor.
static int	getTypeInvalidValue() Invalid value for type.
static java.lang.String[]	getTypeKeyVals() Return an array of unique keys for the values of this field.
java.lang.String	getTypeMetatype() Return the metatype text for this field, or "" if no metatype was declared.
static java.lang.String[]	getTypePrintVals() Return an array of the possible values for this field in display format.
java.lang.String	getTypePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getTypeRange() Return the range specification for this field
java.lang.String	getTypeValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
org.sandev.basics.structs.SandUpdateMessage	getUpdateMessage() Returns null
java.lang.String	getValueForFieldName(java.lang.String fieldname, org.sandev.basics.util.IDLookup lookup, org.sandev.basics.util.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	insertChildren(int index, HeapAccessSummary value) Insert the specified element at the specified index.
boolean	isEquivalent(org.sandev.basics.structs.SandMessage sm) Declared field equivalence check as specified by the SandMessage interface.
boolean	isStatusAvailable() boolean accessor for status value
boolean	isStatusSelected() boolean accessor for status value
java.lang.String[]	referenceValidate(java.lang.String[] locations, java.lang.String prefix, org.sandev.basics.util.IDLookup idlookup, org.sandev.basics.util.NameLookup namelookup, org.sandev.basics.util.AuthUser au) Validate the references as specified in the Resolvable interface.
HeapAccessSummary	removeChildren(int index) Remove the element at the specified index and return it.
boolean	removeChildrenValue(HeapAccessSummary value) Removes the given element from children.
HeapAssociation	resolveAssociationReference(org.sandev.basics.util.IDLookup lookup, org.sandev.basics.util.AuthUser au) Converts a reference to an instance by looking it up.
HeapAssociation	resolveAssociationReferenceNonCrit(org.sandev.basics.util.IDLookup lookup, org.sandev.basics.util.AuthUser au) Calls standard method, eating any SandException and returning a new instance uniqueID -1.
HeapAttributes	resolveHeapReference(org.sandev.basics.util.IDLookup lookup, org.sandev.basics.util.AuthUser au) Converts a reference to an instance by looking it up.
HeapAttributes	resolveHeapReferenceNonCrit(org.sandev.basics.util.IDLookup lookup, org.sandev.basics.util.AuthUser au) Calls standard method, eating any SandException and returning a new instance uniqueID -1.
void	setAssociation(long association) Mutator for association
void	setChildren(HeapAccessSummary[] children) Mutator for children
void	setChildren(int index, HeapAccessSummary value) Set the value at the index specified.
void	setChildren(java.lang.Object[] children) Generic mutator for children
void	setHeap(long heap) Mutator for heap
void	setHeapName(java.lang.Object heapName) Generic mutator for heapName
void	setHeapName(java.lang.String heapName) Mutator for heapName
void	setIndent(java.lang.Object indent) Generic mutator for indent
void	setIndent(java.lang.String indent) Mutator for indent
void	setLineNumber(int lineNumber) Mutator for lineNumber
void	setParent(HeapAccessSummary parent) Mutator for parent
void	setParent(java.lang.Object parent) Generic mutator for parent
void	setStatus(int status) Mutator for status
void	setType(int type) Mutator for type
HeapAccessSummary	shallowCopy() Make a shallow copy of this HeapAccessSummary.
int	sizeofChildren() Returns the size of children.
static java.lang.String	statusActual2Print(java.lang.String actualVal) Utility method to transform an actual value for this field into a print value.
int	statusLabelToValue(java.lang.String label) Given a label, return the value for it.
static int	statusLabelToValueStatic(java.lang.String label)
static java.lang.String	statusPrint2Actual(java.lang.String printVal) Utility method to transform a print value for this field into an actual value.
static java.lang.String	statusPrint2Key(java.lang.String printVal) Utility method to transform a print value for this field into a key value.
java.lang.String	statusValueToLabel(int val) Given a value, return the declared label for it.
static java.lang.String	statusValueToLabelStatic(int val)
java.lang.String	toString() Return a string representation of this object.
static java.lang.String	typeActual2Print(java.lang.String actualVal) Utility method to transform an actual value for this field into a print value.
int	typeLabelToValue(java.lang.String label) Given a label, return the value for it.
static int	typeLabelToValueStatic(java.lang.String label)
static java.lang.String	typePrint2Actual(java.lang.String printVal) Utility method to transform a print value for this field into an actual value.
static java.lang.String	typePrint2Key(java.lang.String printVal) Utility method to transform a print value for this field into a key value.
java.lang.String	typeValueToLabel(int val) Given a value, return the declared label for it.
static java.lang.String	typeValueToLabelStatic(int val)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TYPE_TREEROOT

public static final int TYPE_TREEROOT

Possible value for type

See Also:

Constant Field Values

TYPE_HEAP

public static final int TYPE_HEAP

Possible value for type

See Also:

Constant Field Values

TYPE_ASSOC

public static final int TYPE_ASSOC

Possible value for type

See Also:

Constant Field Values

STATUS_AVAILABLE

public static final int STATUS_AVAILABLE

Possible value for status

See Also:

Constant Field Values

STATUS_SELECTED

public static final int STATUS_SELECTED

Possible value for status

See Also:

Constant Field Values

Constructor Detail

HeapAccessSummary

public HeapAccessSummary()

Default constructor calls init.

Method Detail

getPrintname

public java.lang.String getPrintname()

Return the printname of the class

Specified by:

getPrintname in interface org.sandev.basics.structs.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 org.sandev.basics.structs.SandInstanceMessage

getType

public int getType()

Accessor for type

setType

public void setType(int type)

Mutator for type

typeValueToLabel

public java.lang.String typeValueToLabel(int val)

Given a value, return the declared label for it. This is a conversion method suitable for things like XML serialization where the value must be unique, descriptive, and readable, but is not subject to the same degree of transformation as a UI.

typeValueToLabelStatic

public static java.lang.String typeValueToLabelStatic(int val)

typeLabelToValue

public int typeLabelToValue(java.lang.String label)

Given a label, return the value for it. This is a conversion method performing the inverse of ValueToLabel. See the comments there for more details.

typeLabelToValueStatic

public static int typeLabelToValueStatic(java.lang.String label)

getTypePrintVals

public static java.lang.String[] getTypePrintVals()

Return an array of the possible values for this field in display format. These values can be used by a UI directly, or as keys for looking up localized text. These values are not guaranteed to be globally unique, another field with the same possible value may share the same string instance.

getTypeKeyVals

public static java.lang.String[] getTypeKeyVals()

Return an array of unique keys for the values of this field. These keys are globally unique and can be used for looking up localized text without any chance of the same key being used by any other field value in the application.

getTypeActualVals

public static java.lang.String[] getTypeActualVals()

Return an array of the possible values for this field as Strings. These values can be directly converted to their integer equivalents.

typePrint2Key

public static java.lang.String typePrint2Key(java.lang.String printVal)

Utility method to transform a print value for this field into a key value. See the getTypePrintVals and getTypeKeyVals methods for details.

typePrint2Actual

public static java.lang.String typePrint2Actual(java.lang.String printVal)

Utility method to transform a print value for this field into an actual value. See the getTypePrintVals and getTypeActualVals methods for details.

typeActual2Print

public static java.lang.String typeActual2Print(java.lang.String actualVal)

Utility method to transform an actual value for this field into a print value. See the getTypeActualVals and getTypePrintVals methods for details.

getTypeEnumSummary

public static java.lang.String getTypeEnumSummary()

Return a single String summary of the possible enum values for debug and similar purposes.

getTypeFlag

public static boolean getTypeFlag(int fieldflag)

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

getTypeDefaultValue

public static int getTypeDefaultValue()

Default value for type. Returns TYPE_TREEROOT

getTypeInvalidValue

public static int getTypeInvalidValue()

Invalid value for type. Returns -1

getTypePrintValue

public java.lang.String getTypePrintValue()

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.

getTypeFieldPrintValue

public java.lang.String getTypeFieldPrintValue()

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

getTypeRange

public java.lang.String getTypeRange()

Return the range specification for this field

getTypeValidityCheck

public java.lang.String getTypeValidityCheck()

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.

getTypeMetatype

public java.lang.String getTypeMetatype()

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

getHeap

public long getHeap()

Accessor for heap

setHeap

public void setHeap(long heap)

Mutator for heap

getHeapFlag

public static boolean getHeapFlag(int fieldflag)

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

getHeapDefaultValue

public static long getHeapDefaultValue()

Default value for heap. Returns 0

getHeapInvalidValue

public static long getHeapInvalidValue()

Invalid value for heap. Returns Long.MIN_VALUE

getHeapPrintValue

public java.lang.String getHeapPrintValue()

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.

getHeapFieldPrintValue

public java.lang.String getHeapFieldPrintValue()

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

getHeapRange

public java.lang.String getHeapRange()

Return the range specification for this field

resolveHeapReferenceNonCrit

public HeapAttributes resolveHeapReferenceNonCrit(org.sandev.basics.util.IDLookup lookup,
                                                  org.sandev.basics.util.AuthUser au)

Calls standard method, eating any SandException and returning a new instance uniqueID -1. This is to support the UI, which is basically calling to get detail for a richer display. If the detail is not available, it's not critical (hence the name).

resolveHeapReference

public HeapAttributes resolveHeapReference(org.sandev.basics.util.IDLookup lookup,
                                           org.sandev.basics.util.AuthUser au)
                                    throws org.sandev.basics.structs.SandException

Converts a reference to an instance by looking it up.

Throws:

org.sandev.basics.structs.SandException

getHeapValidityCheck

public java.lang.String getHeapValidityCheck()

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.

getHeapMetatype

public java.lang.String getHeapMetatype()

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

getHeapName

public java.lang.String getHeapName()

Accessor for heapName

setHeapName

public void setHeapName(java.lang.String heapName)

Mutator for heapName

setHeapName

public void setHeapName(java.lang.Object heapName)

Generic mutator for heapName

getHeapNameFlag

public static boolean getHeapNameFlag(int fieldflag)

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

getHeapNameLengthNorm

public static int getHeapNameLengthNorm()

Normal heapName length is 30 characters

getHeapNameLengthMax

public static int getHeapNameLengthMax()

Maximum heapName length is 80 characters

getHeapNameDefaultValue

public static java.lang.String getHeapNameDefaultValue()

Default value for heapName. Returns ""

getHeapNameInvalidValue

public static java.lang.String getHeapNameInvalidValue()

Invalid value for heapName. Returns null

getHeapNamePrintValue

public java.lang.String getHeapNamePrintValue()

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.

getHeapNameFieldPrintValue

public java.lang.String getHeapNameFieldPrintValue()

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

getHeapNameRange

public java.lang.String getHeapNameRange()

Return the range specification for this field

getHeapNameValidityCheck

public java.lang.String getHeapNameValidityCheck()

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.

getHeapNameMetatype

public java.lang.String getHeapNameMetatype()

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

getAssociation

public long getAssociation()

Accessor for association

setAssociation

public void setAssociation(long association)

Mutator for association

getAssociationFlag

public static boolean getAssociationFlag(int fieldflag)

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

getAssociationDefaultValue

public static long getAssociationDefaultValue()

Default value for association. Returns 0

getAssociationInvalidValue

public static long getAssociationInvalidValue()

Invalid value for association. Returns Long.MIN_VALUE

getAssociationPrintValue

public java.lang.String getAssociationPrintValue()

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.

getAssociationFieldPrintValue

public java.lang.String getAssociationFieldPrintValue()

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

getAssociationRange

public java.lang.String getAssociationRange()

Return the range specification for this field

resolveAssociationReferenceNonCrit

public HeapAssociation resolveAssociationReferenceNonCrit(org.sandev.basics.util.IDLookup lookup,
                                                          org.sandev.basics.util.AuthUser au)

Calls standard method, eating any SandException and returning a new instance uniqueID -1. This is to support the UI, which is basically calling to get detail for a richer display. If the detail is not available, it's not critical (hence the name).

resolveAssociationReference

public HeapAssociation resolveAssociationReference(org.sandev.basics.util.IDLookup lookup,
                                                   org.sandev.basics.util.AuthUser au)
                                            throws org.sandev.basics.structs.SandException

Converts a reference to an instance by looking it up.

Throws:

org.sandev.basics.structs.SandException

getAssociationValidityCheck

public java.lang.String getAssociationValidityCheck()

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.

getAssociationMetatype

public java.lang.String getAssociationMetatype()

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

getParent

public HeapAccessSummary getParent()

Accessor for parent

setParent

public void setParent(HeapAccessSummary parent)

Mutator for parent

setParent

public void setParent(java.lang.Object parent)

Generic mutator for parent

getParentFlag

public static boolean getParentFlag(int fieldflag)

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

getTreeParent

public HeapAccessSummary getTreeParent()

Tree accessor for parent reference

getParentDefaultValue

public static HeapAccessSummary getParentDefaultValue()

Default value for parent. Returns null

getParentInvalidValue

public static HeapAccessSummary getParentInvalidValue()

Invalid value for parent. Returns null

getParentPrintValue

public java.lang.String getParentPrintValue()

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.

getParentFieldPrintValue

public java.lang.String getParentFieldPrintValue()

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

getParentRange

public java.lang.String getParentRange()

Return the range specification for this field

getParentValidityCheck

public java.lang.String getParentValidityCheck()

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.

getParentMetatype

public java.lang.String getParentMetatype()

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

getChildren

public HeapAccessSummary[] getChildren()

Accessor for children. The returned value may or may not be the actual data member. Always write back a changed array using setChildren.

setChildren

public void setChildren(HeapAccessSummary[] children)

Mutator for children

setChildren

public void setChildren(java.lang.Object[] children)

Generic mutator for children

addChildren

public void addChildren(HeapAccessSummary element)

Appends a value to children

addChildren

public void addChildren(HeapAccessSummary[] elements)

Appends an array of values to children

getChildren

public HeapAccessSummary getChildren(int index)

Returns the element at the specified index. Returns null if children is null or smaller than index.

setChildren

public void setChildren(int index,
                        HeapAccessSummary value)

Set the value at the index specified.

insertChildren

public void insertChildren(int index,
                           HeapAccessSummary 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.

removeChildren

public HeapAccessSummary removeChildren(int index)

Remove the element at the specified index and return it.

removeChildrenValue

public boolean removeChildrenValue(HeapAccessSummary value)

Removes the given element from children. Returns true if the element was found.

clearChildren

public void clearChildren()

Clears all values from children

childrenContains

public boolean childrenContains(HeapAccessSummary val)

Returns true if children contains the specified value.

childrenIndexOf

public int childrenIndexOf(HeapAccessSummary val)

Return the index of the specified value in children, or -1 if not found.

sizeofChildren

public int sizeofChildren()

Returns the size of children. Returns -1 if children is null.

getChildrenFlag

public static boolean getChildrenFlag(int fieldflag)

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

getTreeChildren

public HeapAccessSummary[] getTreeChildren()

Tree accessor for child references

getChildrenDefaultValue

public static HeapAccessSummary[] getChildrenDefaultValue()

Default value for children. Returns new HeapAccessSummary[0]

getChildrenElementInvalidValue

public static