org.sandev.TaskHeap.PlanCalculator
Class PlanCalculatorNodeInstance

java.lang.Object
  org.sandev.TaskHeap.PlanCalculator.PlanCalculatorNodeDecl
      org.sandev.TaskHeap.PlanCalculator.PlanCalculatorNodeInstance

All Implemented Interfaces:

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

public class PlanCalculatorNodeInstance

extends PlanCalculatorNodeDecl

implements org.sandev.basics.structs.NodeInstance, org.sandev.basics.util.Resolvable

AUTOGENERATED FILE, DO NOT EDIT DIRECTLY.
source: org.sandev.TaskHeap.PlanCalculator.PlanCalculatorNodeDecl
generator: org.sandev.generator.NodeInstClassGenerator
time: Dec 2, 2005 6:38:51 PM

This file contains all declared configuration and messaging parameters for this node.

Field Summary

protected org.sandev.basics.structs.NodeInstance[]	helperNodes Additional nodes instantiated with this node running together as a logical subsystem.
protected org.sandev.basics.sandmessages.IODeclReceive	incomingSyncPlanRecalc Inbound org.sandev.TaskHeap.sandmessages.PlanRecalc synchronous messaging configuration
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 java.lang.String	nodeInstanceName The unique name identifying this specific node instance.
protected org.sandev.basics.sandmessages.IODeclSend	outgoingAsyncPlan Outbound org.sandev.TaskHeap.sandmessages.Plan asynchronous messaging configuration
protected org.sandev.basics.sandmessages.IODeclCall	outgoingSyncExternalPlanQuery Outbound org.sandev.TaskHeap.sandmessages.ExternalPlanQuery synchronous messaging configuration
protected org.sandev.basics.sandmessages.IODeclCall	outgoingSyncPlanQuery Outbound org.sandev.TaskHeap.sandmessages.PlanQuery synchronous messaging configuration
protected org.sandev.basics.sandmessages.IODeclCall	outgoingSyncTaskQuery Outbound org.sandev.TaskHeap.sandmessages.TaskQuery synchronous messaging configuration
protected org.sandev.basics.sandmessages.IODeclCall	outgoingSyncUpdaterNode Outbound org.sandev.basics.sandmessages.Ping synchronous messaging configuration
static int	RECURSIONLEVEL_FULL Possible value for recursionLevel
static int	RECURSIONLEVEL_OWNER Possible value for recursionLevel
protected java.lang.String	servername The name of the server this instance will be running on.

Fields inherited from class org.sandev.TaskHeap.PlanCalculator.PlanCalculatorNodeDecl

iDLookupInstanceName, recursionLevel

Fields inherited from interface org.sandev.basics.structs.NodeInstance

MSGMODE_DIRECT, MSGMODE_SECURE, MSGOPTIMIZE_IF_POSSIBLE, MSGOPTIMIZE_NEVER

Fields inherited from interface org.sandev.basics.structs.SandInstanceMessage

FIELDCHECK_INVALIDVAL, FIELDCHECK_NOTAREF, FIELDCHECK_NOTINRANGE, FIELDCHECK_NULLARRAY, FIELDCHECK_STRINGOVER, FIELDCHECK_UNKNOWNVAL, FIELDFLAG_BINARY, FIELDFLAG_ENCRYPT, FIELDFLAG_INTERNAL, FIELDFLAG_NOECHO, FIELDFLAG_OBFUSCATE, FIELDFLAG_STRINGPERSIST, FIELDFLAG_UNIQUE, GENMOD_ACTION_APPEND, GENMOD_ACTION_INSERT, GENMOD_ACTION_REMOVE, GENMOD_ACTION_SET

Constructor Summary

PlanCalculatorNodeInstance()
Default constructor calls init.

Method Summary

void	addHelperNodes(org.sandev.basics.structs.NodeInstance element) Appends a value to helperNodes
void	addHelperNodes(org.sandev.basics.structs.NodeInstance[] elements) Appends an array of values to helperNodes
void	clearHelperNodes() Clears all values from helperNodes
org.sandev.basics.structs.SandInstanceMessage	cloneMessage() Calls clonePlanCalculatorNodeInstance
PlanCalculatorNodeInstance	clonePlanCalculatorNodeInstance() Make a deep copy of this PlanCalculatorNodeInstance.
org.sandev.basics.structs.SandInstanceMessage	convertToSuperstructClass() Return a new instance of the message associated with the superstruct of this instance.
void	copyDataFrom(PlanCalculatorNodeInstance other) Deep copy all the data from the specified instance.
void	copyFieldValue(java.lang.String fieldName, org.sandev.basics.structs.SandInstanceMessage other) Copy the specified field from the given instance.
java.lang.String	debugDump(java.lang.String prefix) Dump this instance into a debug printable string.
void	defaultField(java.lang.String fieldname) Set the specified field to its default value.
boolean	fieldHasFlag(java.lang.String fieldname, int fieldflag) Return true if the named field declares the indicated flag, false otherwise.
boolean	fieldsValid() Validate the fields as specified in the SandInstanceMessage interface
org.sandev.basics.structs.SandAttrVal[]	fieldValidate(org.sandev.basics.structs.SandAttrVal[] checkFields) Validate the fields as specified in the SandInstanceMessage interface
java.lang.Object	generalAccessor(java.lang.String fieldspec) General field accessor method.
org.sandev.basics.structs.SandAttrVal	generalDereference(java.lang.String fieldspec) General reference field accessor method.
void	generalModifier(int action, java.lang.String field, int index, java.lang.Object val) General mutator method.
java.lang.String[]	getAllFields() Return an array of all fields for this class.
org.sandev.basics.structs.SandCollectionMessage	getCollectionMessage() Returns null
java.lang.String[]	getDisplayFields() Return an array of the summary field names for this class.
java.lang.String[]	getDisplayValues() Return the values for the summary fields.
java.lang.String[]	getDisplayValues(org.sandev.basics.util.IDLookup lookup, org.sandev.basics.util.AuthUser user, java.lang.String defaultVal) Return the values for the summary fields, including dereference expressions.
org.sandev.basics.structs.NodeInstance[]	getHelperNodes() Accessor for helperNodes
org.sandev.basics.structs.NodeInstance	getHelperNodes(int index) Returns the element at the specified index.
static org.sandev.basics.structs.NodeInstance[]	getHelperNodesDefaultValue() Default value for helperNodes.
static org.sandev.basics.structs.NodeInstance	getHelperNodesElementInvalidValue() Invalid value for helperNodeselement.
static boolean	getHelperNodesFlag(int fieldflag) Field flag accessor.
static org.sandev.basics.structs.NodeInstance[]	getHelperNodesInvalidValue() Invalid value for helperNodes.
java.lang.String	getHelperNodesMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getHelperNodesRange() Return the range specification for this field
java.lang.String	getHelperNodesValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
java.lang.String	getIDLookupInstanceName() Accessor for iDLookupInstanceName
static java.lang.String	getIDLookupInstanceNameDefaultValue() Default value for iDLookupInstanceName.
java.lang.String	getIDLookupInstanceNameFieldPrintValue() Return the print name of the iDLookupInstanceName field.
static boolean	getIDLookupInstanceNameFlag(int fieldflag) Field flag accessor.
static java.lang.String	getIDLookupInstanceNameInvalidValue() Invalid value for iDLookupInstanceName.
static int	getIDLookupInstanceNameLengthMax() Maximum iDLookupInstanceName length is 70 characters
static int	getIDLookupInstanceNameLengthNorm() Normal iDLookupInstanceName length is 30 characters
java.lang.String	getIDLookupInstanceNameMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getIDLookupInstanceNamePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getIDLookupInstanceNameRange() Return the range specification for this field
java.lang.String	getIDLookupInstanceNameValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
org.sandev.basics.sandmessages.IODeclReceive	getIncomingSyncPlanRecalc() Accessor for incomingSyncPlanRecalc
static org.sandev.basics.sandmessages.IODeclReceive	getIncomingSyncPlanRecalcDefaultValue() Default value for incomingSyncPlanRecalc.
java.lang.String	getIncomingSyncPlanRecalcFieldPrintValue() Return the print name of the incomingSyncPlanRecalc field.
static boolean	getIncomingSyncPlanRecalcFlag(int fieldflag) Field flag accessor.
static org.sandev.basics.sandmessages.IODeclReceive	getIncomingSyncPlanRecalcInvalidValue() Invalid value for incomingSyncPlanRecalc.
java.lang.String	getIncomingSyncPlanRecalcMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getIncomingSyncPlanRecalcPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getIncomingSyncPlanRecalcRange() Return the range specification for this field
java.lang.String	getIncomingSyncPlanRecalcValidityCheck() 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.
java.lang.String	getNodeInstanceName() Accessor for nodeInstanceName
static java.lang.String	getNodeInstanceNameDefaultValue() Default value for nodeInstanceName.
java.lang.String	getNodeInstanceNameFieldPrintValue() Return the print name of the nodeInstanceName field.
static boolean	getNodeInstanceNameFlag(int fieldflag) Field flag accessor.
static java.lang.String	getNodeInstanceNameInvalidValue() Invalid value for nodeInstanceName.
static int	getNodeInstanceNameLengthMax() Maximum nodeInstanceName length is 70 characters
static int	getNodeInstanceNameLengthNorm() Normal nodeInstanceName length is 30 characters
java.lang.String	getNodeInstanceNameMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getNodeInstanceNamePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getNodeInstanceNameRange() Return the range specification for this field
java.lang.String	getNodeInstanceNameValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
org.sandev.basics.sandmessages.IODeclSend	getOutgoingAsyncPlan() Accessor for outgoingAsyncPlan
static org.sandev.basics.sandmessages.IODeclSend	getOutgoingAsyncPlanDefaultValue() Default value for outgoingAsyncPlan.
java.lang.String	getOutgoingAsyncPlanFieldPrintValue() Return the print name of the outgoingAsyncPlan field.
static boolean	getOutgoingAsyncPlanFlag(int fieldflag) Field flag accessor.
static org.sandev.basics.sandmessages.IODeclSend	getOutgoingAsyncPlanInvalidValue() Invalid value for outgoingAsyncPlan.
java.lang.String	getOutgoingAsyncPlanMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getOutgoingAsyncPlanPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getOutgoingAsyncPlanRange() Return the range specification for this field
java.lang.String	getOutgoingAsyncPlanValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
org.sandev.basics.sandmessages.IODeclCall	getOutgoingSyncExternalPlanQuery() Accessor for outgoingSyncExternalPlanQuery
static org.sandev.basics.sandmessages.IODeclCall	getOutgoingSyncExternalPlanQueryDefaultValue() Default value for outgoingSyncExternalPlanQuery.
java.lang.String	getOutgoingSyncExternalPlanQueryFieldPrintValue() Return the print name of the outgoingSyncExternalPlanQuery field.
static boolean	getOutgoingSyncExternalPlanQueryFlag(int fieldflag) Field flag accessor.
static org.sandev.basics.sandmessages.IODeclCall	getOutgoingSyncExternalPlanQueryInvalidValue() Invalid value for outgoingSyncExternalPlanQuery.
java.lang.String	getOutgoingSyncExternalPlanQueryMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getOutgoingSyncExternalPlanQueryPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getOutgoingSyncExternalPlanQueryRange() Return the range specification for this field
java.lang.String	getOutgoingSyncExternalPlanQueryValidityCheck() 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.sandmessages.IODeclCall	getOutgoingSyncTaskQuery() Accessor for outgoingSyncTaskQuery
static org.sandev.basics.sandmessages.IODeclCall	getOutgoingSyncTaskQueryDefaultValue() Default value for outgoingSyncTaskQuery.
java.lang.String	getOutgoingSyncTaskQueryFieldPrintValue() Return the print name of the outgoingSyncTaskQuery field.
static boolean	getOutgoingSyncTaskQueryFlag(int fieldflag) Field flag accessor.
static org.sandev.basics.sandmessages.IODeclCall	getOutgoingSyncTaskQueryInvalidValue() Invalid value for outgoingSyncTaskQuery.
java.lang.String	getOutgoingSyncTaskQueryMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getOutgoingSyncTaskQueryPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getOutgoingSyncTaskQueryRange() Return the range specification for this field
java.lang.String	getOutgoingSyncTaskQueryValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
org.sandev.basics.sandmessages.IODeclCall	getOutgoingSyncUpdaterNode() Accessor for outgoingSyncUpdaterNode
static org.sandev.basics.sandmessages.IODeclCall	getOutgoingSyncUpdaterNodeDefaultValue() Default value for outgoingSyncUpdaterNode.
java.lang.String	getOutgoingSyncUpdaterNodeFieldPrintValue() Return the print name of the outgoingSyncUpdaterNode field.
static boolean	getOutgoingSyncUpdaterNodeFlag(int fieldflag) Field flag accessor.
static org.sandev.basics.sandmessages.IODeclCall	getOutgoingSyncUpdaterNodeInvalidValue() Invalid value for outgoingSyncUpdaterNode.
java.lang.String	getOutgoingSyncUpdaterNodeMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getOutgoingSyncUpdaterNodePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getOutgoingSyncUpdaterNodeRange() Return the range specification for this field
java.lang.String	getOutgoingSyncUpdaterNodeValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
org.sandev.basics.structs.SandQueryMessage	getQueryMessage() Returns null
int	getRecursionLevel() Accessor for recursionLevel
static java.lang.String[]	getRecursionLevelActualVals() Return an array of the possible values for this field as Strings.
static int	getRecursionLevelDefaultValue() Default value for recursionLevel.
static java.lang.String	getRecursionLevelEnumSummary() Return a single String summary of the possible enum values for debug and similar purposes.
java.lang.String	getRecursionLevelFieldPrintValue() Return the print name of the recursionLevel field.
static boolean	getRecursionLevelFlag(int fieldflag) Field flag accessor.
static int	getRecursionLevelInvalidValue() Invalid value for recursionLevel.
static java.lang.String[]	getRecursionLevelKeyVals() Return an array of unique keys for the values of this field.
java.lang.String	getRecursionLevelMetatype() Return the metatype text for this field, or "" if no metatype was declared.
static java.lang.String[]	getRecursionLevelPrintVals() Return an array of the possible values for this field in display format.
java.lang.String	getRecursionLevelPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getRecursionLevelRange() Return the range specification for this field
java.lang.String	getRecursionLevelValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
java.lang.String	getServername() Accessor for servername
static java.lang.String	getServernameDefaultValue() Default value for servername.
java.lang.String	getServernameFieldPrintValue() Return the print name of the servername field.
static boolean	getServernameFlag(int fieldflag) Field flag accessor.
static java.lang.String	getServernameInvalidValue() Invalid value for servername.
static int	getServernameLengthMax() Maximum servername length is 70 characters
static int	getServernameLengthNorm() Normal servername length is 30 characters
java.lang.String	getServernameMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getServernamePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getServernameRange() Return the range specification for this field
java.lang.String	getServernameValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
java.lang.String	getShortName() Returns the unqualified name of this message.
org.sandev.basics.structs.SandStructMessage	getStructMessage() Returns a new PlanCalculatorNodeInstance instance
org.sandev.basics.structs.SandUpdateMessage	getUpdateMessage() Returns null
java.lang.String	getValueForFieldName(java.lang.String fieldname, org.sandev.basics.util.IDLookup lookup, org.sandev.basics.util.AuthUser user, java.lang.String defaultVal) Returns the print representation of the value of the specified field, or the given default value if innaccessible.
boolean	helperNodesContains(org.sandev.basics.structs.NodeInstance val) Returns true if helperNodes contains the specified value.
int	helperNodesIndexOf(org.sandev.basics.structs.NodeInstance val) Return the index of the specified value in helperNodes, or -1 if not found.
void	init() Initialize all fields to their default values
void	insertHelperNodes(int index, org.sandev.basics.structs.NodeInstance value) Insert the specified element at the specified index.
boolean	isEquivalent(org.sandev.basics.structs.SandMessage sm) Declared field equivalence check as specified by the SandMessage interface.
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.
static java.lang.String	recursionLevelActual2Print(java.lang.String actualVal) Utility method to transform an actual value for this field into a print value.
int	recursionLevelLabelToValue(java.lang.String label) Given a label, return the value for it.
static java.lang.String	recursionLevelPrint2Actual(java.lang.String printVal) Utility method to transform a print value for this field into an actual value.
static java.lang.String	recursionLevelPrint2Key(java.lang.String printVal) Utility method to transform a print value for this field into a key value.
java.lang.String	recursionLevelValueToLabel(int val) Given a value, return the declared label for it.
java.lang.String[]	referenceValidate(java.lang.String[] locations, java.lang.String prefix, org.sandev.basics.util.IDLookup idlookup, org.sandev.basics.util.NameLookup namelookup, org.sandev.basics.util.AuthUser au) Validate the references as specified in the Resolvable interface.
org.sandev.basics.structs.NodeInstance	removeHelperNodes(int index) Remove the element at the specified index and return it.
boolean	removeHelperNodesValue(org.sandev.basics.structs.NodeInstance value) Removes the given element from helperNodes.
org.sandev.basics.sandmessages.ServerDeclaration	resolveServernameReference(org.sandev.basics.util.NameLookup lookup, org.sandev.basics.util.AuthUser au) Converts a reference to an instance by looking it up.
org.sandev.basics.sandmessages.ServerDeclaration	resolveServernameReferenceNonCrit(org.sandev.basics.util.NameLookup lookup, org.sandev.basics.util.AuthUser au) Calls standard method, eating any SandException and returning a new instance with all default values instead.
void	setHelperNodes(int index, org.sandev.basics.structs.NodeInstance value) Set the value at the index specified.
void	setHelperNodes(org.sandev.basics.structs.NodeInstance[] helperNodes) Mutator for helperNodes
void	setHelperNodes(java.lang.Object[] helperNodes) Generic mutator for helperNodes
void	setIDLookupInstanceName(java.lang.Object iDLookupInstanceName) Generic mutator for iDLookupInstanceName
void	setIDLookupInstanceName(java.lang.String iDLookupInstanceName) Mutator for iDLookupInstanceName
void	setIncomingSyncPlanRecalc(org.sandev.basics.sandmessages.IODeclReceive incomingSyncPlanRecalc) Mutator for incomingSyncPlanRecalc
void	setIncomingSyncPlanRecalc(java.lang.Object incomingSyncPlanRecalc) Generic mutator for incomingSyncPlanRecalc
void	setLogLevel(int logLevel) Mutator for logLevel
void	setNodeInstanceName(java.lang.Object nodeInstanceName) Generic mutator for nodeInstanceName
void	setNodeInstanceName(java.lang.String nodeInstanceName) Mutator for nodeInstanceName
void	setOutgoingAsyncPlan(org.sandev.basics.sandmessages.IODeclSend outgoingAsyncPlan) Mutator for outgoingAsyncPlan
void	setOutgoingAsyncPlan(java.lang.Object outgoingAsyncPlan) Generic mutator for outgoingAsyncPlan
void	setOutgoingSyncExternalPlanQuery(org.sandev.basics.sandmessages.IODeclCall outgoingSyncExternalPlanQuery) Mutator for outgoingSyncExternalPlanQuery
void	setOutgoingSyncExternalPlanQuery(java.lang.Object outgoingSyncExternalPlanQuery) Generic mutator for outgoingSyncExternalPlanQuery
void	setOutgoingSyncPlanQuery(org.sandev.basics.sandmessages.IODeclCall outgoingSyncPlanQuery) Mutator for outgoingSyncPlanQuery
void	setOutgoingSyncPlanQuery(java.lang.Object outgoingSyncPlanQuery) Generic mutator for outgoingSyncPlanQuery
void	setOutgoingSyncTaskQuery(org.sandev.basics.sandmessages.IODeclCall outgoingSyncTaskQuery) Mutator for outgoingSyncTaskQuery
void	setOutgoingSyncTaskQuery(java.lang.Object outgoingSyncTaskQuery) Generic mutator for outgoingSyncTaskQuery
void	setOutgoingSyncUpdaterNode(org.sandev.basics.sandmessages.IODeclCall outgoingSyncUpdaterNode) Mutator for outgoingSyncUpdaterNode
void	setOutgoingSyncUpdaterNode(java.lang.Object outgoingSyncUpdaterNode) Generic mutator for outgoingSyncUpdaterNode
void	setRecursionLevel(int recursionLevel) Mutator for recursionLevel
void	setServername(java.lang.Object servername) Generic mutator for servername
void	setServername(java.lang.String servername) Mutator for servername
int	sizeofHelperNodes() Returns the size of helperNodes.
java.lang.String	toString() Return a string representation of this object.

Methods inherited from class java.lang.Object

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

Field Detail

RECURSIONLEVEL_OWNER

public static final int RECURSIONLEVEL_OWNER

Possible value for recursionLevel

See Also:

Constant Field Values

RECURSIONLEVEL_FULL

public static final int RECURSIONLEVEL_FULL

Possible value for recursionLevel

See Also:

Constant Field Values

nodeInstanceName

protected java.lang.String nodeInstanceName

The unique name identifying this specific node instance.

servername

protected java.lang.String servername

The name of the server this instance will be running on.

helperNodes

protected org.sandev.basics.structs.NodeInstance[] helperNodes

Additional nodes instantiated with this node running together as a logical subsystem.

outgoingSyncPlanQuery

protected org.sandev.basics.sandmessages.IODeclCall outgoingSyncPlanQuery

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

outgoingSyncTaskQuery

protected org.sandev.basics.sandmessages.IODeclCall outgoingSyncTaskQuery

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

outgoingSyncExternalPlanQuery

protected org.sandev.basics.sandmessages.IODeclCall outgoingSyncExternalPlanQuery

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

outgoingSyncUpdaterNode

protected org.sandev.basics.sandmessages.IODeclCall outgoingSyncUpdaterNode

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

incomingSyncPlanRecalc

protected org.sandev.basics.sandmessages.IODeclReceive incomingSyncPlanRecalc

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

outgoingAsyncPlan

protected org.sandev.basics.sandmessages.IODeclSend outgoingAsyncPlan

Outbound org.sandev.TaskHeap.sandmessages.Plan asynchronous messaging configuration

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

Constructor Detail

PlanCalculatorNodeInstance

public PlanCalculatorNodeInstance()

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.

Specified by:

fieldHasFlag in interface org.sandev.basics.structs.SandInstanceMessage

getRecursionLevel

public int getRecursionLevel()

Accessor for recursionLevel

setRecursionLevel

public void setRecursionLevel(int recursionLevel)

Mutator for recursionLevel

recursionLevelValueToLabel

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

recursionLevelLabelToValue

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

getRecursionLevelPrintVals

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

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.

getRecursionLevelKeyVals

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

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.

getRecursionLevelActualVals

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

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

recursionLevelPrint2Key

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

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

recursionLevelPrint2Actual

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

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

recursionLevelActual2Print

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

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

getRecursionLevelEnumSummary

public static java.lang.String getRecursionLevelEnumSummary()

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

getRecursionLevelFlag

public static boolean getRecursionLevelFlag(int fieldflag)

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

getRecursionLevelDefaultValue

public static int getRecursionLevelDefaultValue()

Default value for recursionLevel. Returns RECURSIONLEVEL_FULL

getRecursionLevelInvalidValue

public static int getRecursionLevelInvalidValue()

Invalid value for recursionLevel. Returns Integer.MIN_VALUE

getRecursionLevelPrintValue

public java.lang.String getRecursionLevelPrintValue()

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.

getRecursionLevelFieldPrintValue

public java.lang.String getRecursionLevelFieldPrintValue()

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

getRecursionLevelRange

public java.lang.String getRecursionLevelRange()

Return the range specification for this field

getRecursionLevelValidityCheck

public java.lang.String getRecursionLevelValidityCheck()

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.

getRecursionLevelMetatype

public java.lang.String getRecursionLevelMetatype()

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

getIDLookupInstanceName

public java.lang.String getIDLookupInstanceName()

Accessor for iDLookupInstanceName

setIDLookupInstanceName

public void setIDLookupInstanceName(java.lang.String iDLookupInstanceName)

Mutator for iDLookupInstanceName

setIDLookupInstanceName

public void setIDLookupInstanceName(java.lang.Object iDLookupInstanceName)

Generic mutator for iDLookupInstanceName

getIDLookupInstanceNameFlag

public static boolean getIDLookupInstanceNameFlag(int fieldflag)

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

getIDLookupInstanceNameLengthNorm

public static int getIDLookupInstanceNameLengthNorm()

Normal iDLookupInstanceName length is 30 characters

getIDLookupInstanceNameLengthMax

public static int getIDLookupInstanceNameLengthMax()

Maximum iDLookupInstanceName length is 70 characters

getIDLookupInstanceNameDefaultValue

public static java.lang.String getIDLookupInstanceNameDefaultValue()

Default value for iDLookupInstanceName. Returns ""

getIDLookupInstanceNameInvalidValue

public static java.lang.String getIDLookupInstanceNameInvalidValue()

Invalid value for iDLookupInstanceName. Returns null

getIDLookupInstanceNamePrintValue

public java.lang.String getIDLookupInstanceNamePrintValue()

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.

getIDLookupInstanceNameFieldPrintValue

public java.lang.String getIDLookupInstanceNameFieldPrintValue()

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

getIDLookupInstanceNameRange

public java.lang.String getIDLookupInstanceNameRange()

Return the range specification for this field

getIDLookupInstanceNameValidityCheck

public java.lang.String getIDLookupInstanceNameValidityCheck()

Return the empty string