org.sandev.basics.MessageDriver
Class MessageDriverNodeInstance

java.lang.Object
  org.sandev.basics.MessageDriver.MessageDriverNodeDecl
      org.sandev.basics.MessageDriver.MessageDriverNodeInstance

All Implemented Interfaces:

NodeInstance, Resolvable, SandInstanceMessage, SandMessage

public class MessageDriverNodeInstance

extends MessageDriverNodeDecl

implements NodeInstance, Resolvable

AUTOGENERATED FILE, DO NOT EDIT DIRECTLY.
source: org.sandev.basics.MessageDriver.MessageDriverNodeDecl
generator: org.sandev.generator.NodeInstClassGenerator
time: Dec 2, 2005 6:38:50 PM

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

Field Summary

protected NodeInstance[]	helperNodes Additional nodes instantiated with this node running together as a logical subsystem.
protected IODeclReceive	incomingSyncSandMessage Inbound org.sandev.basics.structs.SandMessage 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 IODeclSend	outgoingAsyncSandMessage Outbound org.sandev.basics.structs.SandMessage asynchronous messaging configuration
protected java.lang.String	servername The name of the server this instance will be running on.

Fields inherited from class org.sandev.basics.MessageDriver.MessageDriverNodeDecl

basePath, testScripts

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

MessageDriverNodeInstance()
Default constructor calls init.

Method Summary

void	addHelperNodes(NodeInstance element) Appends a value to helperNodes
void	addHelperNodes(NodeInstance[] elements) Appends an array of values to helperNodes
void	addTestScripts(java.lang.String element) Appends a value to testScripts
void	addTestScripts(java.lang.String[] elements) Appends an array of values to testScripts
void	clearHelperNodes() Clears all values from helperNodes
void	clearTestScripts() Clears all values from testScripts
SandInstanceMessage	cloneMessage() Calls cloneMessageDriverNodeInstance
MessageDriverNodeInstance	cloneMessageDriverNodeInstance() Make a deep copy of this MessageDriverNodeInstance.
SandInstanceMessage	convertToSuperstructClass() Return a new instance of the message associated with the superstruct of this instance.
void	copyDataFrom(MessageDriverNodeInstance other) Deep copy all the data from the specified instance.
void	copyFieldValue(java.lang.String fieldName, SandInstanceMessage other) Copy the specified field from the given instance.
java.lang.String	debugDump(java.lang.String prefix) Dump this instance into a debug printable string.
void	defaultField(java.lang.String fieldname) Set the specified field to its default value.
boolean	fieldHasFlag(java.lang.String fieldname, int fieldflag) Return true if the named field declares the indicated flag, false otherwise.
boolean	fieldsValid() Validate the fields as specified in the SandInstanceMessage interface
SandAttrVal[]	fieldValidate(SandAttrVal[] checkFields) Validate the fields as specified in the SandInstanceMessage interface
java.lang.Object	generalAccessor(java.lang.String fieldspec) General field accessor method.
SandAttrVal	generalDereference(java.lang.String fieldspec) General reference field accessor method.
void	generalModifier(int action, java.lang.String field, int index, java.lang.Object val) General mutator method.
java.lang.String[]	getAllFields() Return an array of all fields for this class.
java.lang.String	getBasePath() Accessor for basePath
static java.lang.String	getBasePathDefaultValue() Default value for basePath.
java.lang.String	getBasePathFieldPrintValue() Return the print name of the basePath field.
static boolean	getBasePathFlag(int fieldflag) Field flag accessor.
static java.lang.String	getBasePathInvalidValue() Invalid value for basePath.
static int	getBasePathLengthMax() Maximum basePath length is 70 characters
static int	getBasePathLengthNorm() Normal basePath length is 30 characters
java.lang.String	getBasePathMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getBasePathPrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getBasePathRange() Return the range specification for this field
java.lang.String	getBasePathValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
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(IDLookup lookup, AuthUser user, java.lang.String defaultVal) Return the values for the summary fields, including dereference expressions.
NodeInstance[]	getHelperNodes() Accessor for helperNodes
NodeInstance	getHelperNodes(int index) Returns the element at the specified index.
static NodeInstance[]	getHelperNodesDefaultValue() Default value for helperNodes.
static NodeInstance	getHelperNodesElementInvalidValue() Invalid value for helperNodeselement.
static boolean	getHelperNodesFlag(int fieldflag) Field flag accessor.
static 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.
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.
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.
IODeclSend	getOutgoingAsyncSandMessage() Accessor for outgoingAsyncSandMessage
static IODeclSend	getOutgoingAsyncSandMessageDefaultValue() Default value for outgoingAsyncSandMessage.
java.lang.String	getOutgoingAsyncSandMessageFieldPrintValue() Return the print name of the outgoingAsyncSandMessage field.
static boolean	getOutgoingAsyncSandMessageFlag(int fieldflag) Field flag accessor.
static IODeclSend	getOutgoingAsyncSandMessageInvalidValue() Invalid value for outgoingAsyncSandMessage.
java.lang.String	getOutgoingAsyncSandMessageMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getOutgoingAsyncSandMessagePrintValue() Retrieve the current value of this field as a print String.
java.lang.String	getOutgoingAsyncSandMessageRange() Return the range specification for this field
java.lang.String	getOutgoingAsyncSandMessageValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
SandQueryMessage	getQueryMessage() Returns null
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.
SandStructMessage	getStructMessage() Returns a new MessageDriverNodeInstance instance
java.lang.String[]	getTestScripts() Accessor for testScripts
java.lang.String	getTestScripts(int index) Returns the element at the specified index.
static java.lang.String[]	getTestScriptsDefaultValue() Default value for testScripts.
static java.lang.String	getTestScriptsElementInvalidValue() Invalid value for testScriptselement.
static boolean	getTestScriptsFlag(int fieldflag) Field flag accessor.
static java.lang.String[]	getTestScriptsInvalidValue() Invalid value for testScripts.
static int	getTestScriptsLengthMax() Maximum testScripts length is 70 characters
static int	getTestScriptsLengthNorm() Normal testScripts length is 30 characters
java.lang.String	getTestScriptsMetatype() Return the metatype text for this field, or "" if no metatype was declared.
java.lang.String	getTestScriptsRange() Return the range specification for this field
java.lang.String	getTestScriptsValidityCheck() Return the empty string if the value of this field is valid according to the base SAND declarations.
SandUpdateMessage	getUpdateMessage() Returns null
java.lang.String	getValueForFieldName(java.lang.String fieldname, IDLookup lookup, AuthUser user, java.lang.String defaultVal) Returns the print representation of the value of the specified field, or the given default value if innaccessible.
boolean	helperNodesContains(NodeInstance val) Returns true if helperNodes contains the specified value.
int	helperNodesIndexOf(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, NodeInstance value) Insert the specified element at the specified index.
void	insertTestScripts(int index, java.lang.String value) Insert the specified element at the specified index.
boolean	isEquivalent(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.
java.lang.String[]	referenceValidate(java.lang.String[] locations, java.lang.String prefix, IDLookup idlookup, NameLookup namelookup, AuthUser au) Validate the references as specified in the Resolvable interface.
NodeInstance	removeHelperNodes(int index) Remove the element at the specified index and return it.
boolean	removeHelperNodesValue(NodeInstance value) Removes the given element from helperNodes.
java.lang.String	removeTestScripts(int index) Remove the element at the specified index and return it.
boolean	removeTestScriptsValue(java.lang.String value) Removes the given element from testScripts.
ServerDeclaration	resolveServernameReference(NameLookup lookup, AuthUser au) Converts a reference to an instance by looking it up.
ServerDeclaration	resolveServernameReferenceNonCrit(NameLookup lookup, AuthUser au) Calls standard method, eating any SandException and returning a new instance with all default values instead.
void	setBasePath(java.lang.Object basePath) Generic mutator for basePath
void	setBasePath(java.lang.String basePath) Mutator for basePath
void	setHelperNodes(int index, NodeInstance value) Set the value at the index specified.
void	setHelperNodes(NodeInstance[] helperNodes) Mutator for helperNodes
void	setHelperNodes(java.lang.Object[] helperNodes) Generic mutator for helperNodes
void	setIncomingSyncSandMessage(IODeclReceive incomingSyncSandMessage) Mutator for incomingSyncSandMessage
void	setIncomingSyncSandMessage(java.lang.Object incomingSyncSandMessage) Generic mutator for incomingSyncSandMessage
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	setOutgoingAsyncSandMessage(IODeclSend outgoingAsyncSandMessage) Mutator for outgoingAsyncSandMessage
void	setOutgoingAsyncSandMessage(java.lang.Object outgoingAsyncSandMessage) Generic mutator for outgoingAsyncSandMessage
void	setServername(java.lang.Object servername) Generic mutator for servername
void	setServername(java.lang.String servername) Mutator for servername
void	setTestScripts(int index, java.lang.String value) Set the value at the index specified.
void	setTestScripts(java.lang.String[] testScripts) Mutator for testScripts
int	sizeofHelperNodes() Returns the size of helperNodes.
int	sizeofTestScripts() Returns the size of testScripts.
boolean	testScriptsContains(java.lang.String val) Returns true if testScripts contains the specified value.
int	testScriptsIndexOf(java.lang.String val) Return the index of the specified value in testScripts, or -1 if not found.
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

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 NodeInstance[] helperNodes

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

incomingSyncSandMessage

protected IODeclReceive incomingSyncSandMessage

Inbound org.sandev.basics.structs.SandMessage synchronous messaging configuration

outgoingAsyncSandMessage

protected IODeclSend outgoingAsyncSandMessage

Outbound org.sandev.basics.structs.SandMessage 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

MessageDriverNodeInstance

public MessageDriverNodeInstance()

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 SandInstanceMessage

getBasePath

public java.lang.String getBasePath()

Accessor for basePath

setBasePath

public void setBasePath(java.lang.String basePath)

Mutator for basePath

setBasePath

public void setBasePath(java.lang.Object basePath)

Generic mutator for basePath

getBasePathFlag

public static boolean getBasePathFlag(int fieldflag)

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

getBasePathLengthNorm

public static int getBasePathLengthNorm()

Normal basePath length is 30 characters

getBasePathLengthMax

public static int getBasePathLengthMax()

Maximum basePath length is 70 characters

getBasePathDefaultValue

public static java.lang.String getBasePathDefaultValue()

Default value for basePath. Returns ""

getBasePathInvalidValue

public static java.lang.String getBasePathInvalidValue()

Invalid value for basePath. Returns null

getBasePathPrintValue

public java.lang.String getBasePathPrintValue()

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.

getBasePathFieldPrintValue

public java.lang.String getBasePathFieldPrintValue()

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

getBasePathRange

public java.lang.String getBasePathRange()

Return the range specification for this field

getBasePathValidityCheck

public java.lang.String getBasePathValidityCheck()

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.

getBasePathMetatype

public java.lang.String getBasePathMetatype()

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

getTestScripts

public java.lang.String[] getTestScripts()

Accessor for testScripts

setTestScripts

public void setTestScripts(java.lang.String[] testScripts)

Mutator for testScripts

addTestScripts

public void addTestScripts(java.lang.String element)

Appends a value to testScripts

addTestScripts

public void addTestScripts(java.lang.String[] elements)

Appends an array of values to testScripts

getTestScripts

public java.lang.String getTestScripts(int index)

Returns the element at the specified index. Returns null/-1 if the index was out of bounds.

setTestScripts

public void setTestScripts(int index,
                           java.lang.String value)

Set the value at the index specified.

insertTestScripts

public void insertTestScripts(int index,
                              java.lang.String value)

Insert the specified element at the specified index. If the index specified is greater than the index of the last element, then the value is appended to the existing array.

removeTestScripts

public java.lang.String removeTestScripts(int index)

Remove the element at the specified index and return it.

removeTestScriptsValue

public boolean removeTestScriptsValue(java.lang.String value)

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

clearTestScripts

public void clearTestScripts()

Clears all values from testScripts

testScriptsContains

public boolean testScriptsContains(java.lang.String val)

Returns true if testScripts contains the specified value.

testScriptsIndexOf

public int testScriptsIndexOf(java.lang.String val)

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

sizeofTestScripts

public int sizeofTestScripts()

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

getTestScriptsFlag

public static boolean getTestScriptsFlag(int fieldflag)

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

getTestScriptsLengthNorm

public static int getTestScriptsLengthNorm()

Normal testScripts length is 30 characters

getTestScriptsLengthMax

public static int getTestScriptsLengthMax()

Maximum testScripts length is 70 characters

getTestScriptsDefaultValue

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

Default value for testScripts. Returns new String[0]

getTestScriptsElementInvalidValue

public static java.lang.String getTestScriptsElementInvalidValue()

Invalid value for testScriptselement. Returns null

getTestScriptsInvalidValue

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

Invalid value for testScripts. Returns null

getTestScriptsRange

public java.lang.String getTestScriptsRange()

Return the range specification for this field

getTestScriptsValidityCheck

public java.lang.String getTestScriptsValidityCheck()

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.

getTestScriptsMetatype

public java.lang.String getTestScriptsMetatype()

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

getNodeInstanceName

public java.lang.String getNodeInstanceName()

Accessor for nodeInstanceName

Specified by:

getNodeInstanceName in interface NodeInstance

setNodeInstanceName

public void setNodeInstanceName(java.lang.String nodeInstanceName)

Mutator for nodeInstanceName

setNodeInstanceName

public void setNodeInstanceName(java.lang.Object nodeInstanceName)

Generic mutator for nodeInstanceName

getNodeInstanceNameFlag

public static boolean getNodeInstanceNameFlag(int fieldflag)

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

getNodeInstanceNameLengthNorm

public static int getNodeInstanceNameLengthNorm()

Normal nodeInstanceName length is 30 characters

getNodeInstanceNameLengthMax

public static int getNodeInstanceNameLengthMax()

Maximum nodeInstanceName length is 70 characters

getNodeInstanceNameDefaultValue

public static java.lang.String getNodeInstanceNameDefaultValue()

Default value for nodeInstanceName. Returns ""

getNodeInstanceNameInvalidValue

public static java.lang.String getNodeInstanceNameInvalidValue()

Invalid value for nodeInstanceName. Returns null

getNodeInstanceNamePrintValue

public java.lang.String getNodeInstanceNamePrintValue()

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.

getNodeInstanceNameFieldPrintValue

public java.lang.String getNodeInstanceNameFieldPrintValue()

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

getNodeInstanceNameRange

public java.lang.String getNodeInstanceNameRange()

Return the range specification for this field

getNodeInstanceNameValidityCheck

public java.lang.String getNodeInstanceNameValidityCheck()

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.

getNodeInstanceNameMetatype

public java.lang.String getNodeInstanceNameMetatype()

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

getServername

public java.lang.String getServername()

Accessor for servername

Specified by:

getServername in interface NodeInstance

setServername

public void setServername(java.lang.String servername)

Mutator for servername

Specified by:

setServername in interface NodeInstance

setServername

public void setServername(java.lang.Object servername)

Generic mutator for servername

getServernameFlag

public static boolean getServernameFlag(int fieldflag)

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

getServernameLengthNorm

public static int getServernameLengthNorm()

Normal servername length is 30 characters

getServernameLengthMax

public static int getServernameLengthMax()

Maximum servername length is 70 characters

getServernameDefaultValue

public static java.lang.String getServernameDefaultValue()

Default value for servername. Returns ""

getServernameInvalidValue

public static java.lang.String getServernameInvalidValue()

Invalid value for servername. Returns null

getServernamePrintValue

public java.lang.String getServernamePrintValue()

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.

getServernameFieldPrintValue

public java.lang.String getServernameFieldPrintValue()

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

getServernameRange

public java.lang.String getServernameRange()

Return the range specification for this field

resolveServernameReferenceNonCrit

public ServerDeclaration resolveServernameReferenceNonCrit(NameLookup lookup,
                                                           AuthUser au)

Calls standard method, eating any SandException and returning a new instance with all default values instead. This is to support the UI, which is calling to get detail for a richer display. If the detail is not available, it's not critical.

resolveServernameReference

public ServerDeclaration resolveServernameReference(NameLookup lookup,
                                                    AuthUser au)
                                             throws SandException

Converts a reference to an instance by looking it up.

Throws:

SandException

getServernameValidityCheck

public java.lang.String getServernameValidityCheck()

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.

getServernameMetatype

public java.lang.String getServernameMetatype()

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

getHelperNodes

public NodeInstance[] getHelperNodes()

Accessor for helperNodes

Specified by:

getHelperNodes in interface NodeInstance

setHelperNodes

public void setHelperNodes(NodeInstance[] helperNodes)

Mutator for helperNodes

Specified by:

setHelperNodes in interface NodeInstance

setHelperNodes

public void setHelperNodes(java.lang.Object[] helperNodes)

Generic mutator for helperNodes

addHelperNodes

public void addHelperNodes(NodeInstance element)

Appends a value to helperNodes

addHelperNodes

public void addHelperNodes(NodeInstance[] elements)

Appends an array of values to helperNodes

getHelperNodes

public NodeInstance getHelperNodes(int index)

Returns the element at the specified index. Returns null/-1 if the index was out of bounds.

setHelperNodes

public void setHelperNodes(int index,
                           NodeInstance value)

Set the value at the index specified.

insertHelperNodes

public void insertHelperNodes(int index,
                              NodeInstance value)

Insert the specified element at the specified index. If the index specified is greater than the index of the last element, then the value is appended to the existing array.

removeHelperNodes

public NodeInstance removeHelperNodes(int index)

Remove the element at the specified index and return it.

removeHelperNodesValue

public boolean removeHelperNodesValue(NodeInstance value)

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

clearHelperNodes

public void clearHelperNodes()

Clears all values from helperNodes

helperNodesContains

public boolean helperNodesContains(NodeInstance val)

Returns true if helperNodes contains the specified value.

helperNodesIndexOf

public int helperNodesIndexOf(NodeInstance val)

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

sizeofHelperNodes

public int sizeofHelperNodes()

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

getHelperNodesFlag

public static boolean getHelperNodesFlag(int fieldflag)

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

getHelperNodesDefaultValue

public static NodeInstance[] getHelperNodesDefaultValue()

Default value for helperNodes. Returns new org.sandev.basics.structs.NodeInstance[0]

getHelperNodesElementInvalidValue

public static NodeInstance getHelperNodesElementInvalidValue()

Invalid value for helperNodeselement. Returns null

getHelperNodesInvalidValue

public static