HeapCalculatorNodeBase

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.TaskHeap.HeapCalculator
Class HeapCalculatorNodeBase

java.lang.Object
  org.sandev.TaskHeap.HeapCalculator.HeapCalculatorNodeDecl
      org.sandev.TaskHeap.HeapCalculator.HeapCalculatorNodeBase

All Implemented Interfaces:: org.sandev.basics.nodecommon.Controllable, org.sandev.basics.nodecommon.Loggable, org.sandev.basics.nodecommon.Messageable, org.sandev.basics.util.AuthUserLookup, org.sandev.basics.util.IDLookup

Direct Known Subclasses:: HeapCalculatorNode

public class HeapCalculatorNodeBase
extends HeapCalculatorNodeDecl
implements org.sandev.basics.nodecommon.Controllable, org.sandev.basics.nodecommon.Messageable, org.sandev.basics.nodecommon.Loggable, org.sandev.basics.util.IDLookup, org.sandev.basics.util.AuthUserLookup
extends HeapCalculatorNodeDecl
implements org.sandev.basics.nodecommon.Controllable, org.sandev.basics.nodecommon.Messageable, org.sandev.basics.nodecommon.Loggable, org.sandev.basics.util.IDLookup, org.sandev.basics.util.AuthUserLookup

AUTOGENERATED FILE, DO NOT EDIT DIRECTLY.
source: org.sandev.TaskHeap.HeapCalculator.HeapCalculatorNodeDecl
generator: org.sandev.generator.NodeClassGenerator
time: Jul 31, 2008 4:34:15 PM

This file contains:

messaging methods corresponding to the synchronous and asynchronous input and output declarations
accessor methods, initialization and maintenance code for declared configuration parameters
optionally overridable control hook methods called in response to node control state changes
utility methods

Field Summary
`protected org.sandev.basics.nodecommon.ControlWrapper[]`	`ctrlwrappers` The control wrappers we need to notify of state or parameter changes.
`protected org.sandev.basics.nodecommon.Controllable[]`	`helperNodes` Our helper nodes
`protected org.sandev.basics.util.IDLookup`	`idLookup` The instance we use for looking up data references.
`protected org.sandev.basics.sandmessages.IODeclSubscribe`	`incomingAsyncExternalPlanSource` Inbound org.sandev.TaskHeap.sandmessages.ExternalPlanUpdate asynchronous messaging configuration
`protected org.sandev.basics.sandmessages.IODeclSubscribe`	`incomingAsyncPlanSource` Inbound org.sandev.TaskHeap.sandmessages.PlanUpdate asynchronous messaging configuration
`protected org.sandev.basics.sandmessages.IODeclSubscribe`	`incomingAsyncTaskSource` Inbound org.sandev.TaskHeap.sandmessages.TaskUpdate asynchronous messaging configuration
`protected org.sandev.basics.sandmessages.IODeclReceive`	`incomingSyncAggregateUpdate` Inbound org.sandev.basics.sandmessages.AggregateUpdate synchronous messaging configuration
`protected org.sandev.basics.sandmessages.IODeclReceive`	`incomingSyncHeapDisplay` Inbound org.sandev.TaskHeap.sandmessages.HeapDisplay synchronous messaging configuration
`protected static int`	`LOGDEBUG` Convenience redeclaration of corresponding Logger.LOGLEVEL constant
`protected static int`	`LOGERROR` Convenience redeclaration of corresponding Logger.LOGLEVEL constant
`protected static int`	`LOGFATAL` Convenience redeclaration of corresponding Logger.LOGLEVEL constant
`protected org.sandev.basics.nodecommon.Logger`	`logger` Logfile output at specified severity levels.
`protected static int`	`LOGINFO` Convenience redeclaration of corresponding Logger.LOGLEVEL constant
`protected int`	`logLevel` Calls to log with severity levels less than this value will be ignored.
`static int`	`LOGLEVEL_DEBUG` Possible value for logLevel
`static int`	`LOGLEVEL_ERROR` Possible value for logLevel
`static int`	`LOGLEVEL_FATAL` Possible value for logLevel
`static int`	`LOGLEVEL_INFO` Possible value for logLevel
`static int`	`LOGLEVEL_WARN` Possible value for logLevel
`protected static int`	`LOGWARN` Convenience redeclaration of corresponding Logger.LOGLEVEL constant
`protected org.sandev.basics.nodecommon.Messager`	`messager` Communications to and from this node.
`protected org.sandev.basics.structs.NodeInstance`	`nodeInstance` The declaration used to initialize this node instance when it was first created.
`protected org.sandev.basics.sandmessages.IODeclCall`	`outgoingSyncAggregateUpdate` Outbound org.sandev.basics.sandmessages.AggregateUpdate synchronous messaging configuration
`protected org.sandev.basics.sandmessages.IODeclCall`	`outgoingSyncPlanQuery` Outbound org.sandev.TaskHeap.sandmessages.PlanQuery synchronous messaging configuration
`protected org.sandev.basics.nodecommon.Controllable`	`parent` Our parent node
`protected java.lang.String`	`sandNodeErrorMessage` Text details of the node execution error.
`protected int`	`sandNodeState` Runtime state of the node.
`static int`	`SANDNODESTATE_FAILED` Possible value for sandNodeState
`static int`	`SANDNODESTATE_FAILING` Possible value for sandNodeState
`static int`	`SANDNODESTATE_RESUMING` Possible value for sandNodeState
`static int`	`SANDNODESTATE_RUNNING` Possible value for sandNodeState
`static int`	`SANDNODESTATE_STARTING` Possible value for sandNodeState
`static int`	`SANDNODESTATE_STOPPED` Possible value for sandNodeState
`static int`	`SANDNODESTATE_STOPPING` Possible value for sandNodeState
`static int`	`SANDNODESTATE_SUSPENDED` Possible value for sandNodeState
`static int`	`SANDNODESTATE_SUSPENDING` Possible value for sandNodeState
`static int`	`SANDNODESTATE_UNDEFINED` Possible value for sandNodeState
`protected org.sandev.basics.nodecommon.SandRoot`	`sandRoot` Back reference to the SandRoot that launched us.
`protected org.sandev.basics.util.AuthUserLookup`	`userLookup` The instance we use for looking up users.

Fields inherited from class org.sandev.TaskHeap.HeapCalculator.HeapCalculatorNodeDecl
`peerAuthUserLookupNode, peerIDLookupNode`

Fields inherited from interface org.sandev.basics.nodecommon.Controllable
OPERATION_FAIL, OPERATION_RESUME, OPERATION_SHUTDOWN, OPERATION_STARTUP, OPERATION_STR_FAIL, OPERATION_STR_RESUME, OPERATION_STR_SHUTDOWN, OPERATION_STR_STARTUP, OPERATION_STR_SUSPEND, OPERATION_STR_UNDEFINED, OPERATION_STRINGS, OPERATION_SUSPEND, OPERATION_UNDEFINED, SHUTDOWN_ERROR_RESTART_GLOBAL, SHUTDOWN_ERROR_RESTART_LOCAL, SHUTDOWN_ERROR_TERMINATE, SHUTDOWN_NORMAL, STATE_FAILED, STATE_FAILING, STATE_RESUMING, STATE_RUNNING, STATE_STARTING, STATE_STOPPED, STATE_STOPPING, STATE_STR_FAILED, STATE_STR_FAILING, STATE_STR_RESUMING, STATE_STR_RUNNING, STATE_STR_STARTING, STATE_STR_STOPPED, STATE_STR_STOPPING, STATE_STR_SUSPENDED, STATE_STR_SUSPENDING, STATE_STR_UNDEFINED, STATE_STRINGS, STATE_SUSPENDED, STATE_SUSPENDING, STATE_UNDEFINED

Fields inherited from interface org.sandev.basics.nodecommon.Controllable

OPERATION_FAIL, OPERATION_RESUME, OPERATION_SHUTDOWN, OPERATION_STARTUP, OPERATION_STR_FAIL, OPERATION_STR_RESUME, OPERATION_STR_SHUTDOWN, OPERATION_STR_STARTUP, OPERATION_STR_SUSPEND, OPERATION_STR_UNDEFINED, OPERATION_STRINGS, OPERATION_SUSPEND, OPERATION_UNDEFINED, SHUTDOWN_ERROR_RESTART_GLOBAL, SHUTDOWN_ERROR_RESTART_LOCAL, SHUTDOWN_ERROR_TERMINATE, SHUTDOWN_NORMAL, STATE_FAILED, STATE_FAILING, STATE_RESUMING, STATE_RUNNING, STATE_STARTING, STATE_STOPPED, STATE_STOPPING, STATE_STR_FAILED, STATE_STR_FAILING, STATE_STR_RESUMING, STATE_STR_RUNNING, STATE_STR_STARTING, STATE_STR_STOPPED, STATE_STR_STOPPING, STATE_STR_SUSPENDED, STATE_STR_SUSPENDING, STATE_STR_UNDEFINED, STATE_STRINGS, STATE_SUSPENDED, STATE_SUSPENDING, STATE_UNDEFINED

Constructor Summary
`HeapCalculatorNodeBase()` Default constructor calls init.

Method Summary
`void`	`addWrapper(org.sandev.basics.nodecommon.ControlWrapper wrapper)` Add the specified wrapper to our notification collection
`org.sandev.basics.sandmessages.AggregateUpdate`	`callAggregateUpdate(org.sandev.basics.sandmessages.AggregateUpdate msg)` Synchronous outbound AggregateUpdate
`PlanCollection`	`callPlanQuery(PlanQuery msg)` Synchronous outbound PlanQuery
`org.sandev.basics.structs.SandCollectionMessage`	`callQuery(org.sandev.basics.structs.SandQueryMessage sqm)` Generalized query method to handle all queries understood by this node
`void`	`deliver(org.sandev.basics.structs.SandMessage msg)` Only those deliver methods explicitely declared by the node should actually be called.
`void`	`deliverExternalPlanSource(ExternalPlanUpdate msg)` Asynchronous inbound ExternalPlanUpdate
`void`	`deliverPlanSource(PlanUpdate msg)` Asynchronous inbound PlanUpdate
`void`	`deliverTaskSource(TaskUpdate msg)` Asynchronous inbound TaskUpdate
`boolean`	`fieldHasFlag(java.lang.String fieldname, int fieldflag)` Return true if the named field declares the indicated flag, false otherwise.
`java.lang.String`	`getDeploymentPrefix()` Return the prefix for this deployment.
`org.sandev.basics.nodecommon.Controllable[]`	`getHelperNodes()` accessor for helperNodes
`org.sandev.basics.util.IDCache`	`getIDCache()` Retrieve an IDCache for use by this node.
`org.sandev.basics.util.IDLookup`	`getIDLookup()` initializing accessor for idLookup.
`org.sandev.basics.sandmessages.IODeclSubscribe`	`getIncomingAsyncExternalPlanSource()` Accessor for incomingAsyncExternalPlanSource
`static org.sandev.basics.sandmessages.IODeclSubscribe`	`getIncomingAsyncExternalPlanSourceDefaultValue()` Default value for incomingAsyncExternalPlanSource.
`java.lang.String`	`getIncomingAsyncExternalPlanSourceFieldPrintValue()` Return the print name of the incomingAsyncExternalPlanSource field.
`static boolean`	`getIncomingAsyncExternalPlanSourceFlag(int fieldflag)` Field flag accessor.
`static org.sandev.basics.sandmessages.IODeclSubscribe`	`getIncomingAsyncExternalPlanSourceInvalidValue()` Invalid value for incomingAsyncExternalPlanSource.
`java.lang.String`	`getIncomingAsyncExternalPlanSourceMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getIncomingAsyncExternalPlanSourcePrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getIncomingAsyncExternalPlanSourceRange()` Return the range specification for this field
`java.lang.String`	`getIncomingAsyncExternalPlanSourceValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`org.sandev.basics.sandmessages.IODeclSubscribe`	`getIncomingAsyncPlanSource()` Accessor for incomingAsyncPlanSource
`static org.sandev.basics.sandmessages.IODeclSubscribe`	`getIncomingAsyncPlanSourceDefaultValue()` Default value for incomingAsyncPlanSource.
`java.lang.String`	`getIncomingAsyncPlanSourceFieldPrintValue()` Return the print name of the incomingAsyncPlanSource field.
`static boolean`	`getIncomingAsyncPlanSourceFlag(int fieldflag)` Field flag accessor.
`static org.sandev.basics.sandmessages.IODeclSubscribe`	`getIncomingAsyncPlanSourceInvalidValue()` Invalid value for incomingAsyncPlanSource.
`java.lang.String`	`getIncomingAsyncPlanSourceMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getIncomingAsyncPlanSourcePrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getIncomingAsyncPlanSourceRange()` Return the range specification for this field
`java.lang.String`	`getIncomingAsyncPlanSourceValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`org.sandev.basics.sandmessages.IODeclSubscribe`	`getIncomingAsyncTaskSource()` Accessor for incomingAsyncTaskSource
`static org.sandev.basics.sandmessages.IODeclSubscribe`	`getIncomingAsyncTaskSourceDefaultValue()` Default value for incomingAsyncTaskSource.
`java.lang.String`	`getIncomingAsyncTaskSourceFieldPrintValue()` Return the print name of the incomingAsyncTaskSource field.
`static boolean`	`getIncomingAsyncTaskSourceFlag(int fieldflag)` Field flag accessor.
`static org.sandev.basics.sandmessages.IODeclSubscribe`	`getIncomingAsyncTaskSourceInvalidValue()` Invalid value for incomingAsyncTaskSource.
`java.lang.String`	`getIncomingAsyncTaskSourceMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getIncomingAsyncTaskSourcePrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getIncomingAsyncTaskSourceRange()` Return the range specification for this field
`java.lang.String`	`getIncomingAsyncTaskSourceValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`org.sandev.basics.sandmessages.IODeclReceive`	`getIncomingSyncAggregateUpdate()` Accessor for incomingSyncAggregateUpdate
`static org.sandev.basics.sandmessages.IODeclReceive`	`getIncomingSyncAggregateUpdateDefaultValue()` Default value for incomingSyncAggregateUpdate.
`java.lang.String`	`getIncomingSyncAggregateUpdateFieldPrintValue()` Return the print name of the incomingSyncAggregateUpdate field.
`static boolean`	`getIncomingSyncAggregateUpdateFlag(int fieldflag)` Field flag accessor.
`static org.sandev.basics.sandmessages.IODeclReceive`	`getIncomingSyncAggregateUpdateInvalidValue()` Invalid value for incomingSyncAggregateUpdate.
`java.lang.String`	`getIncomingSyncAggregateUpdateMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getIncomingSyncAggregateUpdatePrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getIncomingSyncAggregateUpdateRange()` Return the range specification for this field
`java.lang.String`	`getIncomingSyncAggregateUpdateValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`org.sandev.basics.sandmessages.IODeclReceive`	`getIncomingSyncHeapDisplay()` Accessor for incomingSyncHeapDisplay
`static org.sandev.basics.sandmessages.IODeclReceive`	`getIncomingSyncHeapDisplayDefaultValue()` Default value for incomingSyncHeapDisplay.
`java.lang.String`	`getIncomingSyncHeapDisplayFieldPrintValue()` Return the print name of the incomingSyncHeapDisplay field.
`static boolean`	`getIncomingSyncHeapDisplayFlag(int fieldflag)` Field flag accessor.
`static org.sandev.basics.sandmessages.IODeclReceive`	`getIncomingSyncHeapDisplayInvalidValue()` Invalid value for incomingSyncHeapDisplay.
`java.lang.String`	`getIncomingSyncHeapDisplayMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getIncomingSyncHeapDisplayPrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getIncomingSyncHeapDisplayRange()` Return the range specification for this field
`java.lang.String`	`getIncomingSyncHeapDisplayValidityCheck()` 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, org.sandev.basics.util.AuthUser user)` Convenience passthrough call to our configured IDLookup.
`org.sandev.basics.nodecommon.Logger`	`getLogger()` Accessor for logger
`static org.sandev.basics.nodecommon.Logger`	`getLoggerDefaultValue()` Default value for logger.
`java.lang.String`	`getLoggerFieldPrintValue()` Return the print name of the logger field.
`static boolean`	`getLoggerFlag(int fieldflag)` Field flag accessor.
`static org.sandev.basics.nodecommon.Logger`	`getLoggerInvalidValue()` Invalid value for logger.
`java.lang.String`	`getLoggerMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getLoggerPrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getLoggerRange()` Return the range specification for this field
`java.lang.String`	`getLoggerValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`int`	`getLogLevel()` Accessor for logLevel
`static java.lang.String[]`	`getLogLevelActualVals()` Return an array of the possible values for this field as Strings.
`static int`	`getLogLevelDefaultValue()` Default value for logLevel.
`static java.lang.String`	`getLogLevelEnumSummary()` Return a single String summary of the possible enum values for debug and similar purposes.
`java.lang.String`	`getLogLevelFieldPrintValue()` Return the print name of the logLevel field.
`static boolean`	`getLogLevelFlag(int fieldflag)` Field flag accessor.
`static int`	`getLogLevelInvalidValue()` Invalid value for logLevel.
`static java.lang.String[]`	`getLogLevelKeyVals()` Return an array of unique keys for the values of this field.
`java.lang.String`	`getLogLevelMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`static java.lang.String[]`	`getLogLevelPrintVals()` Return an array of the possible values for this field in display format.
`java.lang.String`	`getLogLevelPrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getLogLevelRange()` Return the range specification for this field
`java.lang.String`	`getLogLevelValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`org.sandev.basics.nodecommon.Messager`	`getMessager()` Accessor for messager
`static org.sandev.basics.nodecommon.Messager`	`getMessagerDefaultValue()` Default value for messager.
`java.lang.String`	`getMessagerFieldPrintValue()` Return the print name of the messager field.
`static boolean`	`getMessagerFlag(int fieldflag)` Field flag accessor.
`static org.sandev.basics.nodecommon.Messager`	`getMessagerInvalidValue()` Invalid value for messager.
`java.lang.String`	`getMessagerMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getMessagerPrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getMessagerRange()` Return the range specification for this field
`java.lang.String`	`getMessagerValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`org.sandev.basics.structs.NodeInstance`	`getNodeInstance()` Accessor for nodeInstance
`static org.sandev.basics.structs.NodeInstance`	`getNodeInstanceDefaultValue()` Default value for nodeInstance.
`java.lang.String`	`getNodeInstanceFieldPrintValue()` Return the print name of the nodeInstance field.
`static boolean`	`getNodeInstanceFlag(int fieldflag)` Field flag accessor.
`static org.sandev.basics.structs.NodeInstance`	`getNodeInstanceInvalidValue()` Invalid value for nodeInstance.
`java.lang.String`	`getNodeInstanceMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getNodeInstanceName()` convenience wrapper method to retrieve our instance name
`java.lang.String`	`getNodeInstancePrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getNodeInstanceRange()` Return the range specification for this field
`java.lang.String`	`getNodeInstanceValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`org.sandev.basics.sandmessages.IODeclCall`	`getOutgoingSyncAggregateUpdate()` Accessor for outgoingSyncAggregateUpdate
`static org.sandev.basics.sandmessages.IODeclCall`	`getOutgoingSyncAggregateUpdateDefaultValue()` Default value for outgoingSyncAggregateUpdate.
`java.lang.String`	`getOutgoingSyncAggregateUpdateFieldPrintValue()` Return the print name of the outgoingSyncAggregateUpdate field.
`static boolean`	`getOutgoingSyncAggregateUpdateFlag(int fieldflag)` Field flag accessor.
`static org.sandev.basics.sandmessages.IODeclCall`	`getOutgoingSyncAggregateUpdateInvalidValue()` Invalid value for outgoingSyncAggregateUpdate.
`java.lang.String`	`getOutgoingSyncAggregateUpdateMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getOutgoingSyncAggregateUpdatePrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getOutgoingSyncAggregateUpdateRange()` Return the range specification for this field
`java.lang.String`	`getOutgoingSyncAggregateUpdateValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`org.sandev.basics.sandmessages.IODeclCall`	`getOutgoingSyncPlanQuery()` Accessor for outgoingSyncPlanQuery
`static org.sandev.basics.sandmessages.IODeclCall`	`getOutgoingSyncPlanQueryDefaultValue()` Default value for outgoingSyncPlanQuery.
`java.lang.String`	`getOutgoingSyncPlanQueryFieldPrintValue()` Return the print name of the outgoingSyncPlanQuery field.
`static boolean`	`getOutgoingSyncPlanQueryFlag(int fieldflag)` Field flag accessor.
`static org.sandev.basics.sandmessages.IODeclCall`	`getOutgoingSyncPlanQueryInvalidValue()` Invalid value for outgoingSyncPlanQuery.
`java.lang.String`	`getOutgoingSyncPlanQueryMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getOutgoingSyncPlanQueryPrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getOutgoingSyncPlanQueryRange()` Return the range specification for this field
`java.lang.String`	`getOutgoingSyncPlanQueryValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`org.sandev.basics.nodecommon.Controllable`	`getParent()` accessor for parent
`java.lang.String`	`getPeerAuthUserLookupNode()` Accessor for peerAuthUserLookupNode
`static java.lang.String`	`getPeerAuthUserLookupNodeDefaultValue()` Default value for peerAuthUserLookupNode.
`java.lang.String`	`getPeerAuthUserLookupNodeFieldPrintValue()` Return the print name of the peerAuthUserLookupNode field.
`static boolean`	`getPeerAuthUserLookupNodeFlag(int fieldflag)` Field flag accessor.
`static java.lang.String`	`getPeerAuthUserLookupNodeInvalidValue()` Invalid value for peerAuthUserLookupNode.
`static int`	`getPeerAuthUserLookupNodeLengthMax()` Maximum peerAuthUserLookupNode length is 60 characters
`static int`	`getPeerAuthUserLookupNodeLengthNorm()` Normal peerAuthUserLookupNode length is 30 characters
`java.lang.String`	`getPeerAuthUserLookupNodeMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getPeerAuthUserLookupNodePrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getPeerAuthUserLookupNodeRange()` Return the range specification for this field
`java.lang.String`	`getPeerAuthUserLookupNodeValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`java.lang.String`	`getPeerIDLookupNode()` Accessor for peerIDLookupNode
`static java.lang.String`	`getPeerIDLookupNodeDefaultValue()` Default value for peerIDLookupNode.
`java.lang.String`	`getPeerIDLookupNodeFieldPrintValue()` Return the print name of the peerIDLookupNode field.
`static boolean`	`getPeerIDLookupNodeFlag(int fieldflag)` Field flag accessor.
`static java.lang.String`	`getPeerIDLookupNodeInvalidValue()` Invalid value for peerIDLookupNode.
`static int`	`getPeerIDLookupNodeLengthMax()` Maximum peerIDLookupNode length is 70 characters
`static int`	`getPeerIDLookupNodeLengthNorm()` Normal peerIDLookupNode length is 30 characters
`java.lang.String`	`getPeerIDLookupNodeMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getPeerIDLookupNodePrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getPeerIDLookupNodeRange()` Return the range specification for this field
`java.lang.String`	`getPeerIDLookupNodeValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`java.lang.String`	`getSandNodeErrorMessage()` Accessor for sandNodeErrorMessage
`static java.lang.String`	`getSandNodeErrorMessageDefaultValue()` Default value for sandNodeErrorMessage.
`java.lang.String`	`getSandNodeErrorMessageFieldPrintValue()` Return the print name of the sandNodeErrorMessage field.
`static boolean`	`getSandNodeErrorMessageFlag(int fieldflag)` Field flag accessor.
`static java.lang.String`	`getSandNodeErrorMessageInvalidValue()` Invalid value for sandNodeErrorMessage.
`static int`	`getSandNodeErrorMessageLengthMax()` Maximum sandNodeErrorMessage length is 70 characters
`static int`	`getSandNodeErrorMessageLengthNorm()` Normal sandNodeErrorMessage length is 30 characters
`java.lang.String`	`getSandNodeErrorMessageMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`java.lang.String`	`getSandNodeErrorMessagePrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getSandNodeErrorMessageRange()` Return the range specification for this field
`java.lang.String`	`getSandNodeErrorMessageValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`int`	`getSandNodeState()` Accessor for sandNodeState
`static java.lang.String[]`	`getSandNodeStateActualVals()` Return an array of the possible values for this field as Strings.
`static int`	`getSandNodeStateDefaultValue()` Default value for sandNodeState.
`static java.lang.String`	`getSandNodeStateEnumSummary()` Return a single String summary of the possible enum values for debug and similar purposes.
`java.lang.String`	`getSandNodeStateFieldPrintValue()` Return the print name of the sandNodeState field.
`static boolean`	`getSandNodeStateFlag(int fieldflag)` Field flag accessor.
`static int`	`getSandNodeStateInvalidValue()` Invalid value for sandNodeState.
`static java.lang.String[]`	`getSandNodeStateKeyVals()` Return an array of unique keys for the values of this field.
`java.lang.String`	`getSandNodeStateMetatype()` Return the metatype text for this field, or "" if no metatype was declared.
`static java.lang.String[]`	`getSandNodeStatePrintVals()` Return an array of the possible values for this field in display format.
`java.lang.String`	`getSandNodeStatePrintValue()` Retrieve the current value of this field as a print String.
`java.lang.String`	`getSandNodeStateRange()` Return the range specification for this field
`java.lang.String`	`getSandNodeStateValidityCheck()` Return the empty string if the value of this field is valid according to the base SAND declarations.
`org.sandev.basics.nodecommon.SandRoot`	`getSandRoot()` accessor for sandRoot
`java.lang.String`	`getServername()` convenience wrapper method to retrieve our home server name
`org.sandev.basics.util.AuthUser`	`getUserForID(long authID)` Calls through to our AuthUserLookup
`org.sandev.basics.util.AuthUser`	`getUserFromLogin(java.lang.String username, java.lang.String password)` Calls through to our AuthUserLookup
`org.sandev.basics.util.AuthUserLookup`	`getUserLookup()` initializing accessor for userLookup.
`void`	`init()` Initialize all fields to their default values
`void`	`log(int severity, java.lang.String msg)` Log the message with the specified severity.
`void`	`log(java.lang.String msg)` Shorthand for log(Logger.LOGLEVEL_INFO,msg)
`static java.lang.String`	`logLevelActual2Print(java.lang.String actualVal)` Utility method to transform an actual value for this field into a print value.
`int`	`logLevelLabelToValue(java.lang.String label)` Given a label, return the value for it.
`static int`	`logLevelLabelToValueStatic(java.lang.String label)`
`static java.lang.String`	`logLevelPrint2Actual(java.lang.String printVal)` Utility method to transform a print value for this field into an actual value.
`static java.lang.String`	`logLevelPrint2Key(java.lang.String printVal)` Utility method to transform a print value for this field into a key value.
`java.lang.String`	`logLevelValueToLabel(int val)` Given a value, return the declared label for it.
`static java.lang.String`	`logLevelValueToLabelStatic(int val)`
`protected void`	`notifyStateChange(int prevState, int currState)` Notify our registered control wrappers of our state change
`protected void`	`onDelivery(ExternalPlanUpdate msg)` Override this method in your node implementation
`protected void`	`onDelivery(PlanUpdate msg)` Override this method in your node implementation
`protected void`	`onDelivery(TaskUpdate msg)` Override this method in your node implementation
`protected void`	`onFailure()` Override this method to do work when the node enters the failed state.
`protected org.sandev.basics.sandmessages.AggregateUpdate`	`onReceive(org.sandev.basics.sandmessages.AggregateUpdate msg)` Override this method in your node implementation
`protected HeapDisplay`	`onReceive(HeapDisplay msg)` Override this method in your node implementation
`protected void`	`onRestart()` Override this method to do work during `startup()`.
`protected void`	`onResume()` Override this method to do work during `resume()`.
`protected void`	`onShutdown()` Override this method to do work during `shutdown()`.
`protected void`	`onStartup()` Override this method to do work during `startup()`.
`protected void`	`onSuspend()` Override this method to do work during `suspend()`.
`protected org.sandev.basics.structs.SandMessage`	`processMessage(org.sandev.basics.structs.SandMessage sm)` Process the given message and return the result.
`void`	`readConfigParamsFromNodeInstance(org.sandev.basics.structs.NodeInstance ni)` Read our configuration parameter values from the our node instance.
`org.sandev.basics.sandmessages.AggregateUpdate`	`receive(org.sandev.basics.sandmessages.AggregateUpdate msg)` Synchronous inbound AggregateUpdate
`HeapDisplay`	`receive(HeapDisplay msg)` Synchronous inbound HeapDisplay
`org.sandev.basics.structs.SandMessage`	`receive(org.sandev.basics.structs.SandMessage msg)` Only those receive methods explicitely declared by the node should actually be called.
`void`	`restart()` Restarts a running node by calling shutdown and then startup
`void`	`resume()` Resumes a suspended node.
`static java.lang.String`	`sandNodeStateActual2Print(java.lang.String actualVal)` Utility method to transform an actual value for this field into a print value.
`int`	`sandNodeStateLabelToValue(java.lang.String label)` Given a label, return the value for it.
`static int`	`sandNodeStateLabelToValueStatic(java.lang.String label)`
`static java.lang.String`	`sandNodeStatePrint2Actual(java.lang.String printVal)` Utility method to transform a print value for this field into an actual value.
`static java.lang.String`	`sandNodeStatePrint2Key(java.lang.String printVal)` Utility method to transform a print value for this field into a key value.
`java.lang.String`	`sandNodeStateValueToLabel(int val)` Given a value, return the declared label for it.
`static java.lang.String`	`sandNodeStateValueToLabelStatic(int val)`
`void`	`setHelperNodes(org.sandev.basics.nodecommon.Controllable[] nodes)` mutator for helperNodes
`void`	`setIDLookup(org.sandev.basics.util.IDLookup val)` mutator for idLookup
`void`	`setIncomingAsyncExternalPlanSource(org.sandev.basics.sandmessages.IODeclSubscribe incomingAsyncExternalPlanSource)` Mutator for incomingAsyncExternalPlanSource
`void`	`setIncomingAsyncExternalPlanSource(java.lang.Object incomingAsyncExternalPlanSource)` Generic mutator for incomingAsyncExternalPlanSource
`void`	`setIncomingAsyncPlanSource(org.sandev.basics.sandmessages.IODeclSubscribe incomingAsyncPlanSource)` Mutator for incomingAsyncPlanSource
`void`	`setIncomingAsyncPlanSource(java.lang.Object incomingAsyncPlanSource)` Generic mutator for incomingAsyncPlanSource
`void`	`setIncomingAsyncTaskSource(org.sandev.basics.sandmessages.IODeclSubscribe incomingAsyncTaskSource)` Mutator for incomingAsyncTaskSource
`void`	`setIncomingAsyncTaskSource(java.lang.Object incomingAsyncTaskSource)` Generic mutator for incomingAsyncTaskSource
`void`	`setIncomingSyncAggregateUpdate(org.sandev.basics.sandmessages.IODeclReceive incomingSyncAggregateUpdate)` Mutator for incomingSyncAggregateUpdate
`void`	`setIncomingSyncAggregateUpdate(java.lang.Object incomingSyncAggregateUpdate)` Generic mutator for incomingSyncAggregateUpdate
`void`	`setIncomingSyncHeapDisplay(org.sandev.basics.sandmessages.IODeclReceive incomingSyncHeapDisplay)` Mutator for incomingSyncHeapDisplay
`void`	`setIncomingSyncHeapDisplay(java.lang.Object incomingSyncHeapDisplay)` Generic mutator for incomingSyncHeapDisplay
`void`	`setLogger(org.sandev.basics.nodecommon.Logger logger)` Mutator for logger
`void`	`setLogger(java.lang.Object logger)` Generic mutator for logger
`void`	`setLogLevel(int logLevel)` Mutator for logLevel
`void`	`setMessager(org.sandev.basics.nodecommon.Messager messager)` Mutator for messager
`void`	`setMessager(java.lang.Object messager)` Generic mutator for messager
`void`	`setNodeInstance(org.sandev.basics.structs.NodeInstance nodeInstance)` Mutator for nodeInstance
`void`	`setNodeInstance(java.lang.Object nodeInstance)` Generic mutator for nodeInstance
`void`	`setOutgoingSyncAggregateUpdate(org.sandev.basics.sandmessages.IODeclCall outgoingSyncAggregateUpdate)` Mutator for outgoingSyncAggregateUpdate
`void`	`setOutgoingSyncAggregateUpdate(java.lang.Object outgoingSyncAggregateUpdate)` Generic mutator for outgoingSyncAggregateUpdate
`void`	`setOutgoingSyncPlanQuery(org.sandev.basics.sandmessages.IODeclCall outgoingSyncPlanQuery)` Mutator for outgoingSyncPlanQuery
`void`	`setOutgoingSyncPlanQuery(java.lang.Object outgoingSyncPlanQuery)` Generic mutator for outgoingSyncPlanQuery
`void`	`setParent(org.sandev.basics.nodecommon.Controllable node)` mutator for parent
`void`	`setPeerAuthUserLookupNode(java.lang.Object peerAuthUserLookupNode)` Generic mutator for peerAuthUserLookupNode
`void`	`setPeerAuthUserLookupNode(java.lang.String peerAuthUserLookupNode)` Mutator for peerAuthUserLookupNode
`void`	`setPeerIDLookupNode(java.lang.Object peerIDLookupNode)` Generic mutator for peerIDLookupNode
`void`	`setPeerIDLookupNode(java.lang.String peerIDLookupNode)` Mutator for peerIDLookupNode
`void`	`setSandNodeErrorMessage(java.lang.Object sandNodeErrorMessage)` Generic mutator for sandNodeErrorMessage
`void`	`setSandNodeErrorMessage(java.lang.String sandNodeErrorMessage)` Mutator for sandNodeErrorMessage
`void`	`setSandNodeState(int sandNodeState)` Mutator for sandNodeState
`void`	`setSandRoot(org.sandev.basics.nodecommon.SandRoot val)` mutator for sandRoot
`protected void`	`setupSecureReceive()` Register us for receive with our local Authorizer
`protected void`	`setupSubscriptions()` Subscribe us to the nodes we need to listen to
`void`	`setUserLookup(org.sandev.basics.util.AuthUserLookup val)` mutator for userLookup
`void`	`shutdown()` Stops a running node.
`void`	`startup()` Starts a stopped node.
`void`	`suspend()` Suspends a running node.
`void`	`systemwideShutdown(int code)` Call our shutdown, which shuts down our local nodes, then cascade this call upward to our parent so it spreads throughout the system as needed.
`boolean`	`validTransition(int transition)` Validates a state transition by comparing the desired transition with the current state.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

outgoingSyncAggregateUpdate

protected org.sandev.basics.sandmessages.IODeclCall outgoingSyncAggregateUpdate

Outbound org.sandev.basics.sandmessages.AggregateUpdate synchronous messaging configuration

outgoingSyncPlanQuery

protected org.sandev.basics.sandmessages.IODeclCall outgoingSyncPlanQuery

Outbound org.sandev.TaskHeap.sandmessages.PlanQuery synchronous messaging configuration

incomingSyncHeapDisplay

protected org.sandev.basics.sandmessages.IODeclReceive incomingSyncHeapDisplay

Inbound org.sandev.TaskHeap.sandmessages.HeapDisplay synchronous messaging configuration

incomingSyncAggregateUpdate

protected org.sandev.basics.sandmessages.IODeclReceive incomingSyncAggregateUpdate

Inbound org.sandev.basics.sandmessages.AggregateUpdate synchronous messaging configuration

incomingAsyncTaskSource

protected org.sandev.basics.sandmessages.IODeclSubscribe incomingAsyncTaskSource

Inbound org.sandev.TaskHeap.sandmessages.TaskUpdate asynchronous messaging configuration

incomingAsyncPlanSource

protected org.sandev.basics.sandmessages.IODeclSubscribe incomingAsyncPlanSource

Inbound org.sandev.TaskHeap.sandmessages.PlanUpdate asynchronous messaging configuration

incomingAsyncExternalPlanSource

protected org.sandev.basics.sandmessages.IODeclSubscribe incomingAsyncExternalPlanSource

Inbound org.sandev.TaskHeap.sandmessages.ExternalPlanUpdate asynchronous messaging configuration

sandNodeState

protected int sandNodeState

Runtime state of the node. Must be one of the STATE constants defined in Controllable

SANDNODESTATE_UNDEFINED

public static final int SANDNODESTATE_UNDEFINED

Possible value for sandNodeState

See Also:: Constant Field Values

SANDNODESTATE_RUNNING

public static final int SANDNODESTATE_RUNNING

Possible value for sandNodeState

See Also:: Constant Field Values

SANDNODESTATE_SUSPENDED

public static final int SANDNODESTATE_SUSPENDED

Possible value for sandNodeState

See Also:: Constant Field Values

SANDNODESTATE_STOPPED

public static final int SANDNODESTATE_STOPPED

Possible value for sandNodeState

See Also:: Constant Field Values

SANDNODESTATE_FAILED

public static final int SANDNODESTATE_FAILED

Possible value for sandNodeState

See Also:: Constant Field Values

SANDNODESTATE_STARTING

public static final int SANDNODESTATE_STARTING

Possible value for sandNodeState

See Also:: Constant Field Values

SANDNODESTATE_STOPPING

public static final int SANDNODESTATE_STOPPING

Possible value for sandNodeState

See Also:: Constant Field Values

SANDNODESTATE_SUSPENDING

public static final int SANDNODESTATE_SUSPENDING

Possible value for sandNodeState

See Also:: Constant Field Values

SANDNODESTATE_RESUMING

public static final int SANDNODESTATE_RESUMING

Possible value for sandNodeState

See Also:: Constant Field Values

SANDNODESTATE_FAILING

public static final int SANDNODESTATE_FAILING

Possible value for sandNodeState

See Also:: Constant Field Values

sandNodeErrorMessage

protected java.lang.String sandNodeErrorMessage

Text details of the node execution error.

messager

protected org.sandev.basics.nodecommon.Messager messager

Communications to and from this node.

logger

protected org.sandev.basics.nodecommon.Logger logger

Logfile output at specified severity levels.

logLevel

protected int logLevel

Calls to log with severity levels less than this value will be ignored. For example, if you set this field to LOGLEVEL_WARN, then a call to log with LOGLEVEL_INFO will be ignored, while any call with LOGLEVEL_WARN/ERROR/FATAL will be processed. The log levels are defined in org.sandev.basics.nodecommon.Logger

LOGLEVEL_DEBUG

public static final int LOGLEVEL_DEBUG

Possible value for logLevel

See Also:: Constant Field Values

LOGLEVEL_INFO

public static final int LOGLEVEL_INFO

Possible value for logLevel

See Also:: Constant Field Values

LOGLEVEL_WARN

public static final int LOGLEVEL_WARN

Possible value for logLevel

See Also:: Constant Field Values

LOGLEVEL_ERROR

public static final int LOGLEVEL_ERROR

Possible value for logLevel

See Also:: Constant Field Values

LOGLEVEL_FATAL

public static final int LOGLEVEL_FATAL

Possible value for logLevel

See Also:: Constant Field Values

nodeInstance

protected org.sandev.basics.structs.NodeInstance nodeInstance

The declaration used to initialize this node instance when it was first created. This information is for reference only, it can only be modified within the configuration.

sandRoot

protected org.sandev.basics.nodecommon.SandRoot sandRoot

Back reference to the SandRoot that launched us.

LOGDEBUG

protected static final int LOGDEBUG

Convenience redeclaration of corresponding Logger.LOGLEVEL constant

See Also:: Constant Field Values

LOGINFO

protected static final int LOGINFO

Convenience redeclaration of corresponding Logger.LOGLEVEL constant

See Also:: Constant Field Values

LOGWARN

protected static final int LOGWARN

Convenience redeclaration of corresponding Logger.LOGLEVEL constant

See Also:: Constant Field Values

LOGERROR

protected static final int LOGERROR

Convenience redeclaration of corresponding Logger.LOGLEVEL constant

See Also:: Constant Field Values

LOGFATAL

protected static final int LOGFATAL

Convenience redeclaration of corresponding Logger.LOGLEVEL constant

See Also:: Constant Field Values

parent

protected org.sandev.basics.nodecommon.Controllable parent

Our parent node

helperNodes

protected org.sandev.basics.nodecommon.Controllable[] helperNodes

Our helper nodes

ctrlwrappers

protected org.sandev.basics.nodecommon.ControlWrapper[] ctrlwrappers

The control wrappers we need to notify of state or parameter changes.

userLookup

protected org.sandev.basics.util.AuthUserLookup userLookup

The instance we use for looking up users.

idLookup

protected org.sandev.basics.util.IDLookup idLookup

The instance we use for looking up data references.

Constructor Detail

HeapCalculatorNodeBase

public HeapCalculatorNodeBase()

Default constructor calls init.

Method Detail

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.

getPeerAuthUserLookupNode

public java.lang.String getPeerAuthUserLookupNode()

Accessor for peerAuthUserLookupNode

setPeerAuthUserLookupNode

public void setPeerAuthUserLookupNode(java.lang.String peerAuthUserLookupNode)

Mutator for peerAuthUserLookupNode

setPeerAuthUserLookupNode

public void setPeerAuthUserLookupNode(java.lang.Object peerAuthUserLookupNode)

Generic mutator for peerAuthUserLookupNode

getPeerAuthUserLookupNodeFlag

public static boolean getPeerAuthUserLookupNodeFlag(int fieldflag)

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

getPeerAuthUserLookupNodeLengthNorm

public static int getPeerAuthUserLookupNodeLengthNorm()

Normal peerAuthUserLookupNode length is 30 characters

getPeerAuthUserLookupNodeLengthMax

public static int getPeerAuthUserLookupNodeLengthMax()

Maximum peerAuthUserLookupNode length is 60 characters

getPeerAuthUserLookupNodeDefaultValue

public static java.lang.String getPeerAuthUserLookupNodeDefaultValue()

Default value for peerAuthUserLookupNode. Returns ""

getPeerAuthUserLookupNodeInvalidValue

public static java.lang.String getPeerAuthUserLookupNodeInvalidValue()

Invalid value for peerAuthUserLookupNode. Returns null

getPeerAuthUserLookupNodePrintValue

public java.lang.String getPeerAuthUserLookupNodePrintValue()

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.

getPeerAuthUserLookupNodeFieldPrintValue

public java.lang.String getPeerAuthUserLookupNodeFieldPrintValue()

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

getPeerAuthUserLookupNodeRange

public java.lang.String getPeerAuthUserLookupNodeRange()

Return the range specification for this field

getPeerAuthUserLookupNodeValidityCheck

public java.lang.String getPeerAuthUserLookupNodeValidityCheck()

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.

getPeerAuthUserLookupNodeMetatype

public java.lang.String getPeerAuthUserLookupNodeMetatype()

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

getPeerIDLookupNode

public java.lang.String getPeerIDLookupNode()

Accessor for peerIDLookupNode

setPeerIDLookupNode

public void setPeerIDLookupNode(java.lang.String peerIDLookupNode)

Mutator for peerIDLookupNode

setPeerIDLookupNode

public void setPeerIDLookupNode(java.lang.Object peerIDLookupNode)

Generic mutator for peerIDLookupNode

getPeerIDLookupNodeFlag

public static boolean getPeerIDLookupNodeFlag(int fieldflag)

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

getPeerIDLookupNodeLengthNorm

public static int getPeerIDLookupNodeLengthNorm()

Normal peerIDLookupNode length is 30 characters

getPeerIDLookupNodeLengthMax

public static int getPeerIDLookupNodeLengthMax()

Maximum peerIDLookupNode length is 70 characters

getPeerIDLookupNodeDefaultValue

public static java.lang.String getPeerIDLookupNodeDefaultValue()

Default value for peerIDLookupNode. Returns ""

getPeerIDLookupNodeInvalidValue

public static java.lang.String getPeerIDLookupNodeInvalidValue()

Invalid value for peerIDLookupNode. Returns null

getPeerIDLookupNodePrintValue

public java.lang.String getPeerIDLookupNodePrintValue()

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

getPeerIDLookupNodeFieldPrintValue

public java.lang.String getPeerIDLookupNodeFieldPrintValue()

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

getPeerIDLookupNodeRange

public java.lang.String getPeerIDLookupNodeRange()

Return the range specification for this field

getPeerIDLookupNodeValidityCheck

public java.lang.String getPeerIDLookupNodeValidityCheck()

getPeerIDLookupNodeMetatype

public java.lang.String getPeerIDLookupNodeMetatype()

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

getOutgoingSyncAggregateUpdate

public org.sandev.basics.sandmessages.IODeclCall getOutgoingSyncAggregateUpdate()

Accessor for outgoingSyncAggregateUpdate

setOutgoingSyncAggregateUpdate

public void setOutgoingSyncAggregateUpdate(org.sandev.basics.sandmessages.IODeclCall outgoingSyncAggregateUpdate)

Mutator for outgoingSyncAggregateUpdate

setOutgoingSyncAggregateUpdate

public void setOutgoingSyncAggregateUpdate(java.lang.Object outgoingSyncAggregateUpdate)

Generic mutator for outgoingSyncAggregateUpdate

getOutgoingSyncAggregateUpdateFlag

public static boolean getOutgoingSyncAggregateUpdateFlag(int fieldflag)

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

getOutgoingSyncAggregateUpdateDefaultValue

public static org.sandev.basics.sandmessages.IODeclCall getOutgoingSyncAggregateUpdateDefaultValue()

Default value for outgoingSyncAggregateUpdate. Returns new IODeclCall()

getOutgoingSyncAggregateUpdateInvalidValue

public static org.sandev.basics.sandmessages.IODeclCall getOutgoingSyncAggregateUpdateInvalidValue()

Invalid value for outgoingSyncAggregateUpdate. Returns null

getOutgoingSyncAggregateUpdatePrintValue

public java.lang.String getOutgoingSyncAggregateUpdatePrintValue()

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

getOutgoingSyncAggregateUpdateFieldPrintValue

public java.lang.String getOutgoingSyncAggregateUpdateFieldPrintValue()

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

getOutgoingSyncAggregateUpdateRange

public java.lang.String getOutgoingSyncAggregateUpdateRange()

Return the range specification for this field

getOutgoingSyncAggregateUpdateValidityCheck

public java.lang.String getOutgoingSyncAggregateUpdateValidityCheck()

getOutgoingSyncAggregateUpdateMetatype

public java.lang.String getOutgoingSyncAggregateUpdateMetatype()

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

getOutgoingSyncPlanQuery

public org.sandev.basics.sandmessages.IODeclCall getOutgoingSyncPlanQuery()

Accessor for outgoingSyncPlanQuery

setOutgoingSyncPlanQuery

public void setOutgoingSyncPlanQuery(org.sandev.basics.sandmessages.IODeclCall outgoingSyncPlanQuery)

Mutator for outgoingSyncPlanQuery

setOutgoingSyncPlanQuery

public void setOutgoingSyncPlanQuery(java.lang.Object outgoingSyncPlanQuery)

Generic mutator for outgoingSyncPlanQuery

getOutgoingSyncPlanQueryFlag

public static boolean getOutgoingSyncPlanQueryFlag(int fieldflag)

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

getOutgoingSyncPlanQueryDefaultValue

public static org.sandev.basics.sandmessages.IODeclCall getOutgoingSyncPlanQueryDefaultValue()

Default value for outgoingSyncPlanQuery. Returns new IODeclCall()

getOutgoingSyncPlanQueryInvalidValue

public static org.sandev.basics.sandmessages.IODeclCall getOutgoingSyncPlanQueryInvalidValue()

Invalid value for outgoingSyncPlanQuery. Returns null

getOutgoingSyncPlanQueryPrintValue

public java.lang.String getOutgoingSyncPlanQueryPrintValue()

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

getOutgoingSyncPlanQueryFieldPrintValue

public java.lang.String getOutgoingSyncPlanQueryFieldPrintValue()

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

getOutgoingSyncPlanQueryRange

public java.lang.String getOutgoingSyncPlanQueryRange()

Return the range specification for this field

getOutgoingSyncPlanQueryValidityCheck

public java.lang.String getOutgoingSyncPlanQueryValidityCheck()

getOutgoingSyncPlanQueryMetatype

public java.lang.String getOutgoingSyncPlanQueryMetatype()

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

getIncomingSyncHeapDisplay

public org.sandev.basics.sandmessages.IODeclReceive getIncomingSyncHeapDisplay()

Accessor for incomingSyncHeapDisplay

setIncomingSyncHeapDisplay

public void setIncomingSyncHeapDisplay(org.sandev.basics.sandmessages.IODeclReceive incomingSyncHeapDisplay)

Mutator for incomingSyncHeapDisplay

setIncomingSyncHeapDisplay

public void setIncomingSyncHeapDisplay(java.lang.Object incomingSyncHeapDisplay)

Generic mutator for incomingSyncHeapDisplay

getIncomingSyncHeapDisplayFlag

public static boolean getIncomingSyncHeapDisplayFlag(int fieldflag)

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

getIncomingSyncHeapDisplayDefaultValue

public static org.sandev.basics.sandmessages.IODeclReceive getIncomingSyncHeapDisplayDefaultValue()

Default value for incomingSyncHeapDisplay. Returns new IODeclReceive()

getIncomingSyncHeapDisplayInvalidValue

public static org.sandev.basics.sandmessages.IODeclReceive getIncomingSyncHeapDisplayInvalidValue()

Invalid value for incomingSyncHeapDisplay. Returns null

getIncomingSyncHeapDisplayPrintValue

public java.lang.String getIncomingSyncHeapDisplayPrintValue()

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

getIncomingSyncHeapDisplayFieldPrintValue

public java.lang.String getIncomingSyncHeapDisplayFieldPrintValue()

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

getIncomingSyncHeapDisplayRange

public java.lang.String getIncomingSyncHeapDisplayRange()

Return the range specification for this field

getIncomingSyncHeapDisplayValidityCheck

public java.lang.String getIncomingSyncHeapDisplayValidityCheck()

getIncomingSyncHeapDisplayMetatype

public java.lang.String getIncomingSyncHeapDisplayMetatype()

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

getIncomingSyncAggregateUpdate

public org.sandev.basics.sandmessages.IODeclReceive getIncomingSyncAggregateUpdate()

Accessor for incomingSyncAggregateUpdate

setIncomingSyncAggregateUpdate

public void setIncomingSyncAggregateUpdate(org.sandev.basics.sandmessages.IODeclReceive incomingSyncAggregateUpdate)

Mutator for incomingSyncAggregateUpdate

setIncomingSyncAggregateUpdate

public void setIncomingSyncAggregateUpdate(java.lang.Object incomingSyncAggregateUpdate)

Generic mutator for incomingSyncAggregateUpdate

getIncomingSyncAggregateUpdateFlag

public static boolean getIncomingSyncAggregateUpdateFlag(int fieldflag)

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

getIncomingSyncAggregateUpdateDefaultValue

public static org.sandev.basics.sandmessages.IODeclReceive getIncomingSyncAggregateUpdateDefaultValue()

Default value for incomingSyncAggregateUpdate. Returns new IODeclReceive()

getIncomingSyncAggregateUpdateInvalidValue

public static org.sandev.basics.sandmessages.IODeclReceive getIncomingSyncAggregateUpdateInvalidValue()

Invalid value for incomingSyncAggregateUpdate. Returns null

getIncomingSyncAggregateUpdatePrintValue

public java.lang.String getIncomingSyncAggregateUpdatePrintValue()

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

getIncomingSyncAggregateUpdateFieldPrintValue

public java.lang.String getIncomingSyncAggregateUpdateFieldPrintValue()

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

getIncomingSyncAggregateUpdateRange

public java.lang.String getIncomingSyncAggregateUpdateRange()

Return the range specification for this field

getIncomingSyncAggregateUpdateValidityCheck

public java.lang.String getIncomingSyncAggregateUpdateValidityCheck()

getIncomingSyncAggregateUpdateMetatype

public java.lang.String getIncomingSyncAggregateUpdateMetatype()

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

getIncomingAsyncTaskSource

public org.sandev.basics.sandmessages.IODeclSubscribe getIncomingAsyncTaskSource()

Accessor for incomingAsyncTaskSource

setIncomingAsyncTaskSource

public void setIncomingAsyncTaskSource(org.sandev.basics.sandmessages.IODeclSubscribe incomingAsyncTaskSource)

Mutator for incomingAsyncTaskSource

setIncomingAsyncTaskSource

public void setIncomingAsyncTaskSource(java.lang.Object incomingAsyncTaskSource)

Generic mutator for incomingAsyncTaskSource

getIncomingAsyncTaskSourceFlag

public static boolean getIncomingAsyncTaskSourceFlag(int fieldflag)

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

getIncomingAsyncTaskSourceDefaultValue

public static org.sandev.basics.sandmessages.IODeclSubscribe getIncomingAsyncTaskSourceDefaultValue()

Default value for incomingAsyncTaskSource. Returns new IODeclSubscribe()

getIncomingAsyncTaskSourceInvalidValue

public static org.sandev.basics.sandmessages.IODeclSubscribe getIncomingAsyncTaskSourceInvalidValue()

Invalid value for incomingAsyncTaskSource. Returns null

getIncomingAsyncTaskSourcePrintValue

public java.lang.String getIncomingAsyncTaskSourcePrintValue()

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

getIncomingAsyncTaskSourceFieldPrintValue

public java.lang.String getIncomingAsyncTaskSourceFieldPrintValue()

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

getIncomingAsyncTaskSourceRange

public java.lang.String getIncomingAsyncTaskSourceRange()

Return the range specification for this field

getIncomingAsyncTaskSourceValidityCheck

public java.lang.String getIncomingAsyncTaskSourceValidityCheck()

getIncomingAsyncTaskSourceMetatype

public java.lang.String getIncomingAsyncTaskSourceMetatype()

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

getIncomingAsyncPlanSource

public org.sandev.basics.sandmessages.IODeclSubscribe getIncomingAsyncPlanSource()

Accessor for incomingAsyncPlanSource

setIncomingAsyncPlanSource

public void setIncomingAsyncPlanSource(org.sandev.basics.sandmessages.IODeclSubscribe incomingAsyncPlanSource)

Mutator for incomingAsyncPlanSource

setIncomingAsyncPlanSource

public void setIncomingAsyncPlanSource(java.lang.Object incomingAsyncPlanSource)

Generic mutator for incomingAsyncPlanSource

getIncomingAsyncPlanSourceFlag

public static boolean getIncomingAsyncPlanSourceFlag(int fieldflag)

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

getIncomingAsyncPlanSourceDefaultValue

public static org.sandev.basics.sandmessages.IODeclSubscribe getIncomingAsyncPlanSourceDefaultValue()

Default value for incomingAsyncPlanSource. Returns new IODeclSubscribe()

getIncomingAsyncPlanSourceInvalidValue

public static org.sandev.basics.sandmessages.IODeclSubscribe getIncomingAsyncPlanSourceInvalidValue()

Invalid value for incomingAsyncPlanSource. Returns null

getIncomingAsyncPlanSourcePrintValue

public java.lang.String getIncomingAsyncPlanSourcePrintValue()

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

getIncomingAsyncPlanSourceFieldPrintValue

public java.lang.String getIncomingAsyncPlanSourceFieldPrintValue()

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

getIncomingAsyncPlanSourceRange

public java.lang.String getIncomingAsyncPlanSourceRange()

Return the range specification for this field

getIncomingAsyncPlanSourceValidityCheck

public java.lang.String getIncomingAsyncPlanSourceValidityCheck()

getIncomingAsyncPlanSourceMetatype

public java.lang.String getIncomingAsyncPlanSourceMetatype()

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

getIncomingAsyncExternalPlanSource

public org.sandev.basics.sandmessages.IODeclSubscribe getIncomingAsyncExternalPlanSource()

Accessor for incomingAsyncExternalPlanSource

setIncomingAsyncExternalPlanSource

public void setIncomingAsyncExternalPlanSource(org.sandev.basics.sandmessages.IODeclSubscribe incomingAsyncExternalPlanSource)

Mutator for incomingAsyncExternalPlanSource

setIncomingAsyncExternalPlanSource

public void setIncomingAsyncExternalPlanSource(java.lang.Object incomingAsyncExternalPlanSource)

Generic mutator for incomingAsyncExternalPlanSource

getIncomingAsyncExternalPlanSourceFlag

public static boolean getIncomingAsyncExternalPlanSourceFlag(int fieldflag)

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

getIncomingAsyncExternalPlanSourceDefaultValue

public static org.sandev.basics.sandmessages.IODeclSubscribe getIncomingAsyncExternalPlanSourceDefaultValue()

Default value for incomingAsyncExternalPlanSource. Returns new IODeclSubscribe()

getIncomingAsyncExternalPlanSourceInvalidValue

public static org.sandev.basics.sandmessages.IODeclSubscribe getIncomingAsyncExternalPlanSourceInvalidValue()

Invalid value for incomingAsyncExternalPlanSource. Returns null

getIncomingAsyncExternalPlanSourcePrintValue

public java.lang.String getIncomingAsyncExternalPlanSourcePrintValue()

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

getIncomingAsyncExternalPlanSourceFieldPrintValue

public java.lang.String getIncomingAsyncExternalPlanSourceFieldPrintValue()

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

getIncomingAsyncExternalPlanSourceRange

public java.lang.String getIncomingAsyncExternalPlanSourceRange()

Return the range specification for this field

getIncomingAsyncExternalPlanSourceValidityCheck

public java.lang.String getIncomingAsyncExternalPlanSourceValidityCheck()

getIncomingAsyncExternalPlanSourceMetatype

public java.lang.String getIncomingAsyncExternalPlanSourceMetatype()

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

getSandNodeState

public int getSandNodeState()

Accessor for sandNodeState

Specified by:: getSandNodeState in interface org.sandev.basics.nodecommon.Controllable

setSandNodeState

public void setSandNodeState(int sandNodeState)

Mutator for sandNodeState

sandNodeStateValueToLabel

public java.lang.String sandNodeStateValueToLabel(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.

sandNodeStateValueToLabelStatic

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

sandNodeStateLabelToValue

public int sandNodeStateLabelToValue(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.

sandNodeStateLabelToValueStatic

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

getSandNodeStatePrintVals

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

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.

getSandNodeStateKeyVals

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

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.

getSandNodeStateActualVals

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

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

sandNodeStatePrint2Key

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

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

sandNodeStatePrint2Actual

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

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

sandNodeStateActual2Print

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

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

getSandNodeStateEnumSummary

public static java.lang.String getSandNodeStateEnumSummary()

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

getSandNodeStateFlag

public static boolean getSandNodeStateFlag(int fieldflag)

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

getSandNodeStateDefaultValue

public static int getSandNodeStateDefaultValue()

Default value for sandNodeState. Returns 0

getSandNodeStateInvalidValue

public static int getSandNodeStateInvalidValue()

Invalid value for sandNodeState. Returns Integer.MIN_VALUE

getSandNodeStatePrintValue

public java.lang.String getSandNodeStatePrintValue()

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

getSandNodeStateFieldPrintValue

public java.lang.String getSandNodeStateFieldPrintValue()

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

getSandNodeStateRange

public java.lang.String getSandNodeStateRange()

Return the range specification for this field

getSandNodeStateValidityCheck

public java.lang.String getSandNodeStateValidityCheck()

getSandNodeStateMetatype

public java.lang.String getSandNodeStateMetatype()

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

getSandNodeErrorMessage

public java.lang.String getSandNodeErrorMessage()

Accessor for sandNodeErrorMessage

setSandNodeErrorMessage

public void setSandNodeErrorMessage(java.lang.String sandNodeErrorMessage)

Mutator for sandNodeErrorMessage

setSandNodeErrorMessage

public void setSandNodeErrorMessage(java.lang.Object sandNodeErrorMessage)

Generic mutator for sandNodeErrorMessage

getSandNodeErrorMessageFlag

public static boolean getSandNodeErrorMessageFlag(int fieldflag)

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

getSandNodeErrorMessageLengthNorm

public static int getSandNodeErrorMessageLengthNorm()

Normal sandNodeErrorMessage length is 30 characters

getSandNodeErrorMessageLengthMax

public static int getSandNodeErrorMessageLengthMax()

Maximum sandNodeErrorMessage length is 70 characters

getSandNodeErrorMessageDefaultValue

public static java.lang.String getSandNodeErrorMessageDefaultValue()

Default value for sandNodeErrorMessage. Returns ""

getSandNodeErrorMessageInvalidValue

public static java.lang.String getSandNodeErrorMessageInvalidValue()

Invalid value for sandNodeErrorMessage. Returns null

getSandNodeErrorMessagePrintValue

public java.lang.String getSandNodeErrorMessagePrintValue()

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

getSandNodeErrorMessageFieldPrintValue

public java.lang.String getSandNodeErrorMessageFieldPrintValue()

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

getSandNodeErrorMessageRange

public java.lang.String getSandNodeErrorMessageRange()

Return the range specification for this field

getSandNodeErrorMessageValidityCheck

public java.lang.String getSandNodeErrorMessageValidityCheck()

getSandNodeErrorMessageMetatype

public java.lang.String getSandNodeErrorMessageMetatype()

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

getMessager

public org.sandev.basics.nodecommon.Messager getMessager()

Accessor for messager

Specified by:: getMessager in interface org.sandev.basics.nodecommon.Messageable

setMessager

public void setMessager(org.sandev.basics.nodecommon.Messager messager)

Mutator for messager

Specified by:: setMessager in interface org.sandev.basics.nodecommon.Messageable

setMessager

public void setMessager(java.lang.Object messager)

Generic mutator for messager

getMessagerFlag

public static boolean getMessagerFlag(int fieldflag)

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

getMessagerDefaultValue

public static org.sandev.basics.nodecommon.Messager getMessagerDefaultValue()

Default value for messager. Returns null

getMessagerInvalidValue

public static org.sandev.basics.nodecommon.Messager getMessagerInvalidValue()

Invalid value for messager. Returns null

getMessagerPrintValue

public java.lang.String getMessagerPrintValue()

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

getMessagerFieldPrintValue

public java.lang.String getMessagerFieldPrintValue()

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

getMessagerRange

public java.lang.String getMessagerRange()

Return the range specification for this field

getMessagerValidityCheck

public java.lang.String getMessagerValidityCheck()

getMessagerMetatype

public java.lang.String getMessagerMetatype()

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

getLogger

public org.sandev.basics.nodecommon.Logger getLogger()

Accessor for logger

Specified by:: getLogger in interface org.sandev.basics.nodecommon.Loggable

setLogger

public void setLogger(org.sandev.basics.nodecommon.Logger logger)

Mutator for logger

Specified by:: setLogger in interface org.sandev.basics.nodecommon.Loggable

setLogger

public void setLogger(java.lang.Object logger)

Generic mutator for logger

getLoggerFlag

public static boolean getLoggerFlag(int fieldflag)

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

getLoggerDefaultValue

public static org.sandev.basics.nodecommon.Logger getLoggerDefaultValue()

Default value for logger. Returns null

getLoggerInvalidValue

public static org.sandev.basics.nodecommon.Logger getLoggerInvalidValue()

Invalid value for logger. Returns null

getLoggerPrintValue

public java.lang.String getLoggerPrintValue()

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

getLoggerFieldPrintValue

public java.lang.String getLoggerFieldPrintValue()

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

getLoggerRange

public java.lang.String getLoggerRange()

Return the range specification for this field

getLoggerValidityCheck

public java.lang.String getLoggerValidityCheck()

getLoggerMetatype

public java.lang.String getLoggerMetatype()

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

getLogLevel

public int getLogLevel()

Accessor for logLevel

Specified by:: getLogLevel in interface org.sandev.basics.nodecommon.Loggable

setLogLevel

public void setLogLevel(int logLevel)

Mutator for logLevel

Specified by:: setLogLevel in interface org.sandev.basics.nodecommon.Loggable

logLevelValueToLabel

public java.lang.String logLevelValueToLabel(int val)

logLevelValueToLabelStatic

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

logLevelLabelToValue

public int logLevelLabelToValue(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.

logLevelLabelToValueStatic

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

getLogLevelPrintVals

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

getLogLevelKeyVals

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

getLogLevelActualVals

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

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

logLevelPrint2Key

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

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

logLevelPrint2Actual

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

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

logLevelActual2Print

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

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

getLogLevelEnumSummary

public static java.lang.String getLogLevelEnumSummary()

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

getLogLevelFlag

public static boolean getLogLevelFlag(int fieldflag)

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

getLogLevelDefaultValue

public static int getLogLevelDefaultValue()

Default value for logLevel. Returns 0

getLogLevelInvalidValue

public static int getLogLevelInvalidValue()

Invalid value for logLevel. Returns Integer.MIN_VALUE

getLogLevelPrintValue

public java.lang.String getLogLevelPrintValue()

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

getLogLevelFieldPrintValue

public java.lang.String getLogLevelFieldPrintValue()

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

getLogLevelRange

public java.lang.String getLogLevelRange()

Return the range specification for this field

getLogLevelValidityCheck

public java.lang.String getLogLevelValidityCheck()

getLogLevelMetatype

public java.lang.String getLogLevelMetatype()

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

getNodeInstance

public org.sandev.basics.structs.NodeInstance getNodeInstance()

Accessor for nodeInstance

Specified by:: getNodeInstance in interface org.sandev.basics.nodecommon.Controllable

setNodeInstance

public void setNodeInstance(org.sandev.basics.structs.NodeInstance nodeInstance)

Mutator for nodeInstance

Specified by:: setNodeInstance in interface org.sandev.basics.nodecommon.Controllable

setNodeInstance

public void setNodeInstance(java.lang.Object nodeInstance)

Generic mutator for nodeInstance

getNodeInstanceFlag

public static boolean getNodeInstanceFlag(int fieldflag)

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

getNodeInstanceDefaultValue

public static org.sandev.basics.structs.NodeInstance getNodeInstanceDefaultValue()

Default value for nodeInstance. Returns null

getNodeInstanceInvalidValue

public static org.sandev.basics.structs.NodeInstance getNodeInstanceInvalidValue()

Invalid value for nodeInstance. Returns null

getNodeInstancePrintValue

public java.lang.String getNodeInstancePrintValue()

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

getNodeInstanceFieldPrintValue

public java.lang.String getNodeInstanceFieldPrintValue()

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

getNodeInstanceRange

public java.lang.String getNodeInstanceRange()

Return the range specification for this field

getNodeInstanceValidityCheck

public java.lang.String getNodeInstanceValidityCheck()

getNodeInstanceMetatype

public java.lang.String getNodeInstanceMetatype()

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

getNodeInstanceName

public java.lang.String getNodeInstanceName()

convenience wrapper method to retrieve our instance name

getServername

public java.lang.String getServername()

convenience wrapper method to retrieve our home server name

getSandRoot

public org.sandev.basics.nodecommon.SandRoot getSandRoot()

accessor for sandRoot

Specified by:: getSandRoot in interface org.sandev.basics.nodecommon.Controllable

setSandRoot

public void setSandRoot(org.sandev.basics.nodecommon.SandRoot val)

mutator for sandRoot

Specified by:: setSandRoot in interface org.sandev.basics.nodecommon.Controllable

init

public void init()

Initialize all fields to their default values

log

public void log(int severity,
                java.lang.String msg)

Log the message with the specified severity. Valid severity codes are (in increasing severity order):

LOGDEBUG (debugging information)
LOGINFO (general information)
LOGWARN (runtime problem, but fully recoverable)
LOGERROR (runtime problem, partially recoverable)
LOGFATAL (runtime problem, not recoverable)

If the severity specified is less than the logLevel set for this node, then no message is generated. For example if the logLevel is set to INFO, no DEBUG messages are output. If the logLevel is set to WARN, then no INFO or DEBUG messages are output. It is not recommended to set the logLevel to anything higher than WARN.

log

public void log(java.lang.String msg)

Shorthand for log(Logger.LOGLEVEL_INFO,msg)

startup

public void startup()
             throws org.sandev.basics.nodecommon.ControlException

Starts a stopped node. The helper nodes are started first, then this node is started.

Specified by:: startup in interface org.sandev.basics.nodecommon.Controllable

Throws:: org.sandev.basics.nodecommon.ControlException

shutdown

public void shutdown()
              throws org.sandev.basics.nodecommon.ControlException

Stops a running node. This node is stopped first, and then our helper nodes are stopped.

Specified by:: shutdown in interface org.sandev.basics.nodecommon.Controllable

Throws:: org.sandev.basics.nodecommon.ControlException

suspend

public void suspend()
             throws org.sandev.basics.nodecommon.ControlException

Suspends a running node. This node is suspended first, and then our helper nodes are stopped.

Specified by:: suspend in interface org.sandev.basics.nodecommon.Controllable

Throws:: org.sandev.basics.nodecommon.ControlException

resume

public void resume()
            throws org.sandev.basics.nodecommon.ControlException

Resumes a suspended node. The helper nodes are resumed first, and then this node.

Specified by:: resume in interface org.sandev.basics.nodecommon.Controllable

Throws:: org.sandev.basics.nodecommon.ControlException

restart

public void restart()
             throws org.sandev.basics.nodecommon.ControlException

Restarts a running node by calling shutdown and then startup

Specified by:: restart in interface org.sandev.basics.nodecommon.Controllable

Throws:: org.sandev.basics.nodecommon.ControlException

validTransition

public boolean validTransition(int transition)

Validates a state transition by comparing the desired transition with the current state.

readConfigParamsFromNodeInstance

public void readConfigParamsFromNodeInstance(org.sandev.basics.structs.NodeInstance ni)

Read our configuration parameter values from the our node instance. This is done at startup, and is public to allow it to be called from a NodeInstanceFactory at node creation time. If NodeInstance is null, then this method does nothing and just returns. A null NodeInstance is normal in some startup situations and should not cause a startup error.

onStartup

protected void onStartup()
                  throws org.sandev.basics.structs.SandException

Override this method to do work during startup().

Throws:: org.sandev.basics.structs.SandException

onShutdown

protected void onShutdown()
                   throws org.sandev.basics.structs.SandException

Override this method to do work during shutdown().

Throws:: org.sandev.basics.structs.SandException

onSuspend

protected void onSuspend()
                  throws org.sandev.basics.structs.SandException

Override this method to do work during suspend().

Throws:: org.sandev.basics.structs.SandException

onResume

protected void onResume()
                 throws org.sandev.basics.structs.SandException

Override this method to do work during resume().

Throws:: org.sandev.basics.structs.SandException

onRestart

protected void onRestart()
                  throws org.sandev.basics.structs.SandException

Override this method to do work during startup().

Throws:: org.sandev.basics.structs.SandException

onFailure

protected void onFailure()
                  throws org.sandev.basics.nodecommon.ControlException

Override this method to do work when the node enters the failed state.

Throws:: org.sandev.basics.nodecommon.ControlException

getParent

public org.sandev.basics.nodecommon.Controllable getParent()

accessor for parent

Specified by:: getParent in interface org.sandev.basics.nodecommon.Controllable

setParent

public void setParent(org.sandev.basics.nodecommon.Controllable node)

mutator for parent

getHelperNodes

public org.sandev.basics.nodecommon.Controllable[] getHelperNodes()

accessor for helperNodes

Specified by:: getHelperNodes in interface org.sandev.basics.nodecommon.Controllable

setHelperNodes

public void setHelperNodes(org.sandev.basics.nodecommon.Controllable[] nodes)

mutator for helperNodes

Specified by:: setHelperNodes in interface org.sandev.basics.nodecommon.Controllable

systemwideShutdown

public void systemwideShutdown(int code)
                        throws org.sandev.basics.nodecommon.ControlException

Call our shutdown, which shuts down our local nodes, then cascade this call upward to our parent so it spreads throughout the system as needed. This method is overridden by the root node to handle signalling across multiple server nodes.

Specified by:: systemwideShutdown in interface org.sandev.basics.nodecommon.Controllable

Throws:: org.sandev.basics.nodecommon.ControlException

addWrapper

public void addWrapper(org.sandev.basics.nodecommon.ControlWrapper wrapper)

Add the specified wrapper to our notification collection

Specified by:: addWrapper in interface org.sandev.basics.nodecommon.Controllable

notifyStateChange

protected void notifyStateChange(int prevState,
                                 int currState)

Notify our registered control wrappers of our state change

setupSubscriptions

protected void setupSubscriptions()

Subscribe us to the nodes we need to listen to

setupSecureReceive

protected void setupSecureReceive()

receive

public HeapDisplay receive(HeapDisplay msg)
                    throws org.sandev.basics.structs.SandException

Synchronous inbound HeapDisplay

Throws:: org.sandev.basics.structs.SandException

onReceive

protected HeapDisplay onReceive(HeapDisplay msg)
                         throws org.sandev.basics.structs.SandException

Override this method in your node implementation

Throws:: org.sandev.basics.structs.SandException

receive

public org.sandev.basics.sandmessages.AggregateUpdate receive(org.sandev.basics.sandmessages.AggregateUpdate msg)
                                                       throws org.sandev.basics.structs.SandException

Synchronous inbound AggregateUpdate

Throws:: org.sandev.basics.structs.SandException

onReceive

protected org.sandev.basics.sandmessages.AggregateUpdate onReceive(org.sandev.basics.sandmessages.AggregateUpdate msg)
                                                            throws org.sandev.basics.structs.SandException

Override this method in your node implementation

Throws:: org.sandev.basics.structs.SandException

receive

public org.sandev.basics.structs.SandMessage receive(org.sandev.basics.structs.SandMessage msg)
                                              throws org.sandev.basics.structs.SandException

Only those receive methods explicitely declared by the node should actually be called. However the Messageable interface forces all calls to be channeled through this general method, which means we have to manually call the correct method from here.

In practice, this doesn't add much overhead if we enumerate the supported methods at code generation time, and then switch on the enumeration.

Specified by:: receive in interface org.sandev.basics.nodecommon.Messageable

Throws:: org.sandev.basics.structs.SandException

deliverTaskSource

public void deliverTaskSource(TaskUpdate msg)
                       throws org.sandev.basics.structs.SandException

Asynchronous inbound TaskUpdate

Throws:: org.sandev.basics.structs.SandException

onDelivery

protected void onDelivery(TaskUpdate msg)
                   throws org.sandev.basics.structs.SandException

Override this method in your node implementation

Throws:: org.sandev.basics.structs.SandException

deliverPlanSource

public void deliverPlanSource(PlanUpdate msg)
                       throws org.sandev.basics.structs.SandException

Asynchronous inbound PlanUpdate

Throws:: org.sandev.basics.structs.SandException

onDelivery

protected void onDelivery(PlanUpdate msg)
                   throws org.sandev.basics.structs.SandException

Override this method in your node implementation

Throws:: org.sandev.basics.structs.SandException

deliverExternalPlanSource

public void deliverExternalPlanSource(ExternalPlanUpdate msg)
                               throws org.sandev.basics.structs.SandException

Asynchronous inbound ExternalPlanUpdate

Throws:: org.sandev.basics.structs.SandException

onDelivery

protected void onDelivery(ExternalPlanUpdate msg)
                   throws org.sandev.basics.structs.SandException

Override this method in your node implementation

Throws:: org.sandev.basics.structs.SandException

deliver

public void deliver(org.sandev.basics.structs.SandMessage msg)
             throws org.sandev.basics.structs.SandException

Only those deliver methods explicitely declared by the node should actually be called. However the Messageable interface forces all calls to be channeled through this general method, which means we have to manually call the correct method from here.

In practice, this doesn't add much overhead if we enumerate the supported methods at code generation time, and then switch on the enumeration.

Specified by:: deliver in interface org.sandev.basics.nodecommon.Messageable

Throws:: org.sandev.basics.structs.SandException

callAggregateUpdate

public org.sandev.basics.sandmessages.AggregateUpdate callAggregateUpdate(org.sandev.basics.sandmessages.AggregateUpdate msg)
                                                                   throws org.sandev.basics.structs.SandException

Synchronous outbound AggregateUpdate

Throws:: org.sandev.basics.structs.SandException

callPlanQuery

public PlanCollection callPlanQuery(PlanQuery msg)
                             throws org.sandev.basics.structs.SandException

Synchronous outbound PlanQuery

Throws:: org.sandev.basics.structs.SandException

callQuery

public org.sandev.basics.structs.SandCollectionMessage callQuery(org.sandev.basics.structs.SandQueryMessage sqm)
                                                          throws org.sandev.basics.structs.SandException

Generalized query method to handle all queries understood by this node

Specified by:: callQuery in interface org.sandev.basics.nodecommon.Messageable

Throws:: org.sandev.basics.structs.SandException

getUserLookup

public org.sandev.basics.util.AuthUserLookup getUserLookup()

initializing accessor for userLookup. Not synchronized

setUserLookup

public void setUserLookup(org.sandev.basics.util.AuthUserLookup val)

mutator for userLookup

getUserForID

public org.sandev.basics.util.AuthUser getUserForID(long authID)
                                             throws org.sandev.basics.structs.SandException

Calls through to our AuthUserLookup

Specified by:: getUserForID in interface org.sandev.basics.util.AuthUserLookup

Throws:: org.sandev.basics.structs.SandException

getUserFromLogin

public org.sandev.basics.util.AuthUser getUserFromLogin(java.lang.String username,
                                                        java.lang.String password)
                                                 throws org.sandev.basics.structs.SandException

Calls through to our AuthUserLookup

Specified by:: getUserFromLogin in interface org.sandev.basics.util.AuthUserLookup

Throws:: org.sandev.basics.structs.SandException

getIDLookup

public org.sandev.basics.util.IDLookup getIDLookup()

initializing accessor for idLookup. Not synchronized

setIDLookup

public void setIDLookup(org.sandev.basics.util.IDLookup val)

mutator for idLookup

getInstance

public org.sandev.basics.structs.SandPersistMessage getInstance(java.lang.String classname,
                                                                long id,
                                                                org.sandev.basics.util.AuthUser user)
                                                         throws org.sandev.basics.structs.SandException

Convenience passthrough call to our configured IDLookup.

Specified by:: getInstance in interface org.sandev.basics.util.IDLookup

Throws:: org.sandev.basics.structs.SandException

processMessage

protected org.sandev.basics.structs.SandMessage processMessage(org.sandev.basics.structs.SandMessage sm)
                                                        throws org.sandev.basics.structs.SandException

Process the given message and return the result.

Throws:: org.sandev.basics.structs.SandException

getIDCache

public org.sandev.basics.util.IDCache getIDCache()

Retrieve an IDCache for use by this node. Override this method if you want a different cache implementation.

Specified by:: getIDCache in interface org.sandev.basics.nodecommon.Messageable

getDeploymentPrefix

public java.lang.String getDeploymentPrefix()

Return the prefix for this deployment.

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.TaskHeap.HeapCalculator Class HeapCalculatorNodeBase

outgoingSyncAggregateUpdate

outgoingSyncPlanQuery

incomingSyncHeapDisplay

incomingSyncAggregateUpdate

incomingAsyncTaskSource

incomingAsyncPlanSource

incomingAsyncExternalPlanSource

sandNodeState

SANDNODESTATE_UNDEFINED

SANDNODESTATE_RUNNING

SANDNODESTATE_SUSPENDED

SANDNODESTATE_STOPPED

SANDNODESTATE_FAILED

SANDNODESTATE_STARTING

SANDNODESTATE_STOPPING

SANDNODESTATE_SUSPENDING

SANDNODESTATE_RESUMING

SANDNODESTATE_FAILING

sandNodeErrorMessage

messager

logger

logLevel

LOGLEVEL_DEBUG

LOGLEVEL_INFO

LOGLEVEL_WARN

LOGLEVEL_ERROR

LOGLEVEL_FATAL

nodeInstance

sandRoot

LOGDEBUG

LOGINFO

LOGWARN

LOGERROR

LOGFATAL

parent

helperNodes

ctrlwrappers

userLookup

idLookup

HeapCalculatorNodeBase

fieldHasFlag

getPeerAuthUserLookupNode

setPeerAuthUserLookupNode

setPeerAuthUserLookupNode

getPeerAuthUserLookupNodeFlag

getPeerAuthUserLookupNodeLengthNorm

getPeerAuthUserLookupNodeLengthMax

getPeerAuthUserLookupNodeDefaultValue

getPeerAuthUserLookupNodeInvalidValue

getPeerAuthUserLookupNodePrintValue

getPeerAuthUserLookupNodeFieldPrintValue

getPeerAuthUserLookupNodeRange

getPeerAuthUserLookupNodeValidityCheck

getPeerAuthUserLookupNodeMetatype

getPeerIDLookupNode

setPeerIDLookupNode

setPeerIDLookupNode

getPeerIDLookupNodeFlag

getPeerIDLookupNodeLengthNorm

getPeerIDLookupNodeLengthMax

getPeerIDLookupNodeDefaultValue

getPeerIDLookupNodeInvalidValue

getPeerIDLookupNodePrintValue

getPeerIDLookupNodeFieldPrintValue

getPeerIDLookupNodeRange

getPeerIDLookupNodeValidityCheck

getPeerIDLookupNodeMetatype

getOutgoingSyncAggregateUpdate

setOutgoingSyncAggregateUpdate

setOutgoingSyncAggregateUpdate

getOutgoingSyncAggregateUpdateFlag

getOutgoingSyncAggregateUpdateDefaultValue

getOutgoingSyncAggregateUpdateInvalidValue

getOutgoingSyncAggregateUpdatePrintValue

getOutgoingSyncAggregateUpdateFieldPrintValue

getOutgoingSyncAggregateUpdateRange

getOutgoingSyncAggregateUpdateValidityCheck

getOutgoingSyncAggregateUpdateMetatype

getOutgoingSyncPlanQuery

org.sandev.TaskHeap.HeapCalculator
Class HeapCalculatorNodeBase