|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.sandev.basics.DataManager.DataManagerNodeDecl
org.sandev.basics.DataManager.DataManagerNodeBase
AUTOGENERATED FILE, DO NOT EDIT DIRECTLY.
source: org.sandev.basics.DataManager.DataManagerNodeDecl
generator: org.sandev.generator.NodeClassGenerator
time: Dec 2, 2005 6:38:50 PM
This file contains:
| Field Summary | |
protected ControlWrapper[] |
ctrlwrappers
The control wrappers we need to notify of state or parameter changes. |
protected Controllable[] |
helperNodes
Our helper nodes |
protected IODeclReceive |
incomingSyncSandMessage
Inbound org.sandev.basics.structs.SandMessage 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 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 Messager |
messager
Communications to and from this node. |
protected NodeInstance |
nodeInstance
The declaration used to initialize this node instance when it was first created. |
protected IODeclSend |
outgoingAsyncSandUpdateMessage
Outbound org.sandev.basics.structs.SandUpdateMessage asynchronous messaging configuration |
protected 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 SandRoot |
sandRoot
Back reference to the SandRoot that launched us. |
static int |
UPDATETIMEBATCHOVERRIDE_OFF
Possible value for updateTimeBatchOverride |
static int |
UPDATETIMEBATCHOVERRIDE_ON
Possible value for updateTimeBatchOverride |
| Fields inherited from class org.sandev.basics.DataManager.DataManagerNodeDecl |
maxQueryReturn, maxQueryReturnSizeKb, persisterDataSource, updateTimeBatchOverride |
| Constructor Summary | |
DataManagerNodeBase()
Default constructor calls init. |
|
| Method Summary | |
void |
addWrapper(ControlWrapper wrapper)
Add the specified wrapper to our notification collection |
void |
deliver(SandMessage msg)
Only those deliver methods explicitely declared by the node should actually be called. |
boolean |
fieldHasFlag(java.lang.String fieldname,
int fieldflag)
Return true if the named field declares the indicated flag, false otherwise. |
Controllable[] |
getHelperNodes()
accessor for helperNodes |
IDCache |
getIDCache()
Stub for retrieving the IDCache used by this node. |
IODeclReceive |
getIncomingSyncSandMessage()
Accessor for incomingSyncSandMessage |
static IODeclReceive |
getIncomingSyncSandMessageDefaultValue()
Default value for incomingSyncSandMessage. |
java.lang.String |
getIncomingSyncSandMessageFieldPrintValue()
Return the print name of the incomingSyncSandMessage field. |
static boolean |
getIncomingSyncSandMessageFlag(int fieldflag)
Field flag accessor. |
static IODeclReceive |
getIncomingSyncSandMessageInvalidValue()
Invalid value for incomingSyncSandMessage. |
java.lang.String |
getIncomingSyncSandMessageMetatype()
Return the metatype text for this field, or "" if no metatype was declared. |
java.lang.String |
getIncomingSyncSandMessagePrintValue()
Retrieve the current value of this field as a print String. |
java.lang.String |
getIncomingSyncSandMessageRange()
Return the range specification for this field |
java.lang.String |
getIncomingSyncSandMessageValidityCheck()
Return the empty string if the value of this field is valid according to the base SAND declarations. |
Logger |
getLogger()
Accessor for logger |
static 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 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. |
int |
getMaxQueryReturn()
Accessor for maxQueryReturn |
static int |
getMaxQueryReturnDefaultValue()
Default value for maxQueryReturn. |
java.lang.String |
getMaxQueryReturnFieldPrintValue()
Return the print name of the maxQueryReturn field. |
static boolean |
getMaxQueryReturnFlag(int fieldflag)
Field flag accessor. |
static int |
getMaxQueryReturnInvalidValue()
Invalid value for maxQueryReturn. |
java.lang.String |
getMaxQueryReturnMetatype()
Return the metatype text for this field, or "" if no metatype was declared. |
java.lang.String |
getMaxQueryReturnPrintValue()
Retrieve the current value of this field as a print String. |
java.lang.String |
getMaxQueryReturnRange()
Return the range specification for this field |
int |
getMaxQueryReturnSizeKb()
Accessor for maxQueryReturnSizeKb |
static int |
getMaxQueryReturnSizeKbDefaultValue()
Default value for maxQueryReturnSizeKb. |
java.lang.String |
getMaxQueryReturnSizeKbFieldPrintValue()
Return the print name of the maxQueryReturnSizeKb field. |
static boolean |
getMaxQueryReturnSizeKbFlag(int fieldflag)
Field flag accessor. |
static int |
getMaxQueryReturnSizeKbInvalidValue()
Invalid value for maxQueryReturnSizeKb. |
java.lang.String |
getMaxQueryReturnSizeKbMetatype()
Return the metatype text for this field, or "" if no metatype was declared. |
java.lang.String |
getMaxQueryReturnSizeKbPrintValue()
Retrieve the current value of this field as a print String. |
java.lang.String |
getMaxQueryReturnSizeKbRange()
Return the range specification for this field |
java.lang.String |
getMaxQueryReturnSizeKbValidityCheck()
Return the empty string if the value of this field is valid according to the base SAND declarations. |
java.lang.String |
getMaxQueryReturnValidityCheck()
Return the empty string if the value of this field is valid according to the base SAND declarations. |
Messager |
getMessager()
Accessor for messager |
static 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 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. |
NodeInstance |
getNodeInstance()
Accessor for nodeInstance |
static 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 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. |
IODeclSend |
getOutgoingAsyncSandUpdateMessage()
Accessor for outgoingAsyncSandUpdateMessage |
static IODeclSend |
getOutgoingAsyncSandUpdateMessageDefaultValue()
Default value for outgoingAsyncSandUpdateMessage. |
java.lang.String |
getOutgoingAsyncSandUpdateMessageFieldPrintValue()
Return the print name of the outgoingAsyncSandUpdateMessage field. |
static boolean |
getOutgoingAsyncSandUpdateMessageFlag(int fieldflag)
Field flag accessor. |
static IODeclSend |
getOutgoingAsyncSandUpdateMessageInvalidValue()
Invalid value for outgoingAsyncSandUpdateMessage. |
java.lang.String |
getOutgoingAsyncSandUpdateMessageMetatype()
Return the metatype text for this field, or "" if no metatype was declared. |
java.lang.String |
getOutgoingAsyncSandUpdateMessagePrintValue()
Retrieve the current value of this field as a print String. |
java.lang.String |
getOutgoingAsyncSandUpdateMessageRange()
Return the range specification for this field |
java.lang.String |
getOutgoingAsyncSandUpdateMessageValidityCheck()
Return the empty string if the value of this field is valid according to the base SAND declarations. |
Controllable |
getParent()
accessor for parent |
java.lang.String |
getPersisterDataSource()
Accessor for persisterDataSource |
static java.lang.String |
getPersisterDataSourceDefaultValue()
Default value for persisterDataSource. |
java.lang.String |
getPersisterDataSourceFieldPrintValue()
Return the print name of the persisterDataSource field. |
static boolean |
getPersisterDataSourceFlag(int fieldflag)
Field flag accessor. |
static java.lang.String |
getPersisterDataSourceInvalidValue()
Invalid value for persisterDataSource. |
static int |
getPersisterDataSourceLengthMax()
Maximum persisterDataSource length is 255 characters |
static int |
getPersisterDataSourceLengthNorm()
Normal persisterDataSource length is 60 characters |
java.lang.String |
getPersisterDataSourceMetatype()
Return the metatype text for this field, or "" if no metatype was declared. |
java.lang.String |
getPersisterDataSourcePrintValue()
Retrieve the current value of this field as a print String. |
java.lang.String |
getPersisterDataSourceRange()
Return the range specification for this field |
java.lang.String |
getPersisterDataSourceValidityCheck()
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. |
SandRoot |
getSandRoot()
accessor for sandRoot |
java.lang.String |
getServername()
convenience wrapper method to retrieve our home server name |
int |
getUpdateTimeBatchOverride()
Accessor for updateTimeBatchOverride |
static java.lang.String[] |
getUpdateTimeBatchOverrideActualVals()
Return an array of the possible values for this field as Strings. |
static int |
getUpdateTimeBatchOverrideDefaultValue()
Default value for updateTimeBatchOverride. |
static java.lang.String |
getUpdateTimeBatchOverrideEnumSummary()
Return a single String summary of the possible enum values for debug and similar purposes. |
java.lang.String |
getUpdateTimeBatchOverrideFieldPrintValue()
Return the print name of the updateTimeBatchOverride field. |
static boolean |
getUpdateTimeBatchOverrideFlag(int fieldflag)
Field flag accessor. |
static int |
getUpdateTimeBatchOverrideInvalidValue()
Invalid value for updateTimeBatchOverride. |
static java.lang.String[] |
getUpdateTimeBatchOverrideKeyVals()
Return an array of unique keys for the values of this field. |
java.lang.String |
getUpdateTimeBatchOverrideMetatype()
Return the metatype text for this field, or "" if no metatype was declared. |
static java.lang.String[] |
getUpdateTimeBatchOverridePrintVals()
Return an array of the possible values for this field in display format. |
java.lang.String |
getUpdateTimeBatchOverridePrintValue()
Retrieve the current value of this field as a print String. |
java.lang.String |
getUpdateTimeBatchOverrideRange()
Return the range specification for this field |
java.lang.String |
getUpdateTimeBatchOverrideValidityCheck()
Return the empty string if the value of this field is valid according to the base SAND declarations. |
void |
init()
Initialize all fields to their default values |
boolean |
isUpdateTimeBatchOverrideOff()
boolean accessor for updateTimeBatchOverride value |
boolean |
isUpdateTimeBatchOverrideOn()
boolean accessor for updateTimeBatchOverride value |
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 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. |
protected void |
notifyStateChange(int prevState,
int currState)
Notify our registered control wrappers of our state change |
protected void |
onFailure()
Override this method to do work when the node enters the failed state. |
protected SandMessage |
onReceive(SandMessage 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(). |
SandMessage |
receive(SandMessage msg)
Synchronous inbound SandMessage |
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 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. |
void |
send(SandUpdateMessage msg)
Asynchronous outbound SandUpdateMessage |
void |
setHelperNodes(Controllable[] nodes)
mutator for helperNodes |
void |
setIncomingSyncSandMessage(IODeclReceive incomingSyncSandMessage)
Mutator for incomingSyncSandMessage |
void |
setIncomingSyncSandMessage(java.lang.Object incomingSyncSandMessage)
Generic mutator for incomingSyncSandMessage |
void |
setLogger(Logger logger)
Mutator for logger |
void |
setLogger(java.lang.Object logger)
Generic mutator for logger |
void |
setLogLevel(int logLevel)
Mutator for logLevel |
void |
setMaxQueryReturn(int maxQueryReturn)
Mutator for maxQueryReturn |
void |
setMaxQueryReturnSizeKb(int maxQueryReturnSizeKb)
Mutator for maxQueryReturnSizeKb |
void |
setMessager(Messager messager)
Mutator for messager |
void |
setMessager(java.lang.Object messager)
Generic mutator for messager |
void |
setNodeInstance(NodeInstance nodeInstance)
Mutator for nodeInstance |
void |
setNodeInstance(java.lang.Object nodeInstance)
Generic mutator for nodeInstance |
void |
setOutgoingAsyncSandUpdateMessage(IODeclSend outgoingAsyncSandUpdateMessage)
Mutator for outgoingAsyncSandUpdateMessage |
void |
setOutgoingAsyncSandUpdateMessage(java.lang.Object outgoingAsyncSandUpdateMessage)
Generic mutator for outgoingAsyncSandUpdateMessage |
void |
setParent(Controllable node)
mutator for parent |
void |
setPersisterDataSource(java.lang.Object persisterDataSource)
Generic mutator for persisterDataSource |
void |
setPersisterDataSource(java.lang.String persisterDataSource)
Mutator for persisterDataSource |
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(SandRoot val)
mutator for sandRoot |
void |
setUpdateTimeBatchOverride(int updateTimeBatchOverride)
Mutator for updateTimeBatchOverride |
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 |
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. |
static java.lang.String |
updateTimeBatchOverrideActual2Print(java.lang.String actualVal)
Utility method to transform an actual value for this field into a print value. |
int |
updateTimeBatchOverrideLabelToValue(java.lang.String label)
Given a label, return the value for it. |
static java.lang.String |
updateTimeBatchOverridePrint2Actual(java.lang.String printVal)
Utility method to transform a print value for this field into an actual value. |
static java.lang.String |
updateTimeBatchOverridePrint2Key(java.lang.String printVal)
Utility method to transform a print value for this field into a key value. |
java.lang.String |
updateTimeBatchOverrideValueToLabel(int val)
Given a value, return the declared label for it. |
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 |
public static final int UPDATETIMEBATCHOVERRIDE_OFF
public static final int UPDATETIMEBATCHOVERRIDE_ON
protected IODeclReceive incomingSyncSandMessage
protected IODeclSend outgoingAsyncSandUpdateMessage
protected int sandNodeState
Controllable
public static final int SANDNODESTATE_UNDEFINED
public static final int SANDNODESTATE_RUNNING
public static final int SANDNODESTATE_SUSPENDED
public static final int SANDNODESTATE_STOPPED
public static final int SANDNODESTATE_FAILED
public static final int SANDNODESTATE_STARTING
public static final int SANDNODESTATE_STOPPING
public static final int SANDNODESTATE_SUSPENDING
public static final int SANDNODESTATE_RESUMING
public static final int SANDNODESTATE_FAILING
protected java.lang.String sandNodeErrorMessage
protected Messager messager
protected Logger logger
protected int logLevel
public static final int LOGLEVEL_DEBUG
public static final int LOGLEVEL_INFO
public static final int LOGLEVEL_WARN
public static final int LOGLEVEL_ERROR