java.lang.Object
- com.iizix.prop.GProp<GProp<?>[]>
- - com.iizix.prop.PropCnr
  - - com.iizix.prop.vs.AbstractVSVariable<VSField,VSFieldReference>
    - - com.iizix.ws.prop.OutputVariable

All Implemented Interfaces:
EventListener, IClassInstantiationAtResolve, IGProp<GProp<?>[]>, IPropCnr, java.lang.Cloneable
Direct Known Subclasses:
EditorOutputVariable
```
public class OutputVariable
extends AbstractVSVariable<VSField,VSFieldReference>
implements IClassInstantiationAtResolve
```
The Output Variable connects a reference variable from the reply output with a VSField.
Author:
Christopher Mindus

Field Summary
- Fields inherited from class com.iizix.prop.PropCnr
  EMPTY, EMPTY_CLASSES, EMPTY_CNRS, EXTENDS_FRAMEWORK_ERROR_ID
- Fields inherited from class com.iizix.prop.GProp
  GPDEBUG, PROP_ATTR_STRING_EDITOR_PROP, PROP_ATTR_STRING_ERRORED_NAME, PROP_ATTR_STRING_EXTENDS, PROP_ATTR_STRING_EXTENDS_FINAL, PROP_ATTR_STRING_EXTENDS_PRIVATE, PROP_ATTR_STRING_NULLABLE, PROP_ATTR_STRING_PRIVATE, PROP_ATTR_STRING_PRIVATE_CHANGE_EVENT, PROP_ATTR_STRING_READ_ONLY, PROP_USER_1, PROP_USER_2
- Fields inherited from interface com.iizix.prop.IGProp
  EQC_ERROR_IGNORE_ALL, EQC_ERROR_IGNORE_REFERENCES, EQC_IGNORE_ARRAY, EQC_IGNORE_VOLATILE_OR_EDITOR, EQC_PRIVATE, EQC_SAVE_FILE, EXT_CONTAINER_EXTENDS, EXT_CONTAINER_EXTENDS_VALID, EXT_EXTENDED, EXT_FINAL, EXT_OVERRIDES, EXT_OVERRIDES_FINAL_ERR, EXT_PRIVATE

Constructor Summary

Constructors
Constructor	Description
`OutputVariable()`	Creates an output variable property container with the specified name with a null value.
`OutputVariable(Atom propertyAtom)`	Creates an output variable property container with the specified name with a null value.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`OutputVariable`	`clone()`	Clones this variable instance.
`ClassReference`	`getClassReference()`	Gets the class reference for the output value converter.
`java.lang.String`	`getDescription()`	Gets the field description.
`Value`	`getNullReplacement()`	Get the Null Replacement Value.
`OutputProps`	`getOutputProps()`	Gets the output properties.
`IOutputVariableConverter`	`getOutputVariableConverter()`	Gets the instance of the output value converter.
`OutputVariables`	`getOutputVariables()`	Gets the output variables properties container.
`VSField`	`getVSField()`	Gets the VSField.
`java.lang.Class<VSField>`	`getVSPropertyClass()`	Gets the class wanted for the VS component being referenced.
`java.lang.Class<VSFieldReference>`	`getVSReferenceClass()`	Gets the class wanted for VS references.
`boolean`	`isIdentification()`	Indicates this variable is an identification variable and if it's not present in the output reply, then the processor doesn't match.
`boolean`	`isNullOmit()`	Flag indicating that the VS Field connected should not be assigned a Null value when the output reply doesn't contain this variable, and that this variable is not an identification.
`boolean`	`setVSRelativeReference(java.lang.String relRef)`	Sets the reference.

Methods inherited from class com.iizix.prop.vs.AbstractVSVariable
getVariableName, getVSTarget, getVSVariableReference, setVariableName

Methods inherited from class com.iizix.prop.PropCnr
__transferChildProps, addPredefinedProps, addProp, addProp, addProp2, addProp2, appendPropValue, canRequestFocus, completeVirtualize, containsProp, containsProp, convertLoadedProp, couldRequestFocusIfVirtualized, createCopyOfAtom, createUniqueAtom, createUniqueAtom, createUniqueAtom, createVSReference, doPropEqualsArrayValues, doVirtualizePropCnr, enablePropCommunication, enablePropHashMap, equalsTree, equalsTree, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getAllProps, getBool, getBool, getBool, getBool, getChildPropError, getChildPropError, getChildPropErrorSeverity, getChildPropErrorSeverity, getErrorsProp, getExtendsContainer, getExtendsError, getExtendsName, getExtendsOverride, getExtendsPossibleClasses, getFirstProp, getFirstProp, getFocusEngine, getInt, getInt, getInt, getInt, getLong, getLong, getLong, getLong, getNumber, getNumber, getNumber, getNumber, getPossibleChildren, getPredefinedProps, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getProp, getPropBaseReference, getPropCnr, getPropCount, getPropCount, getPropIndex, getPropIndex, getPropIndexes, getProps, getProps, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue, getPropValue0, getReferences, getRetargetedVerifyContainer, getString, getString, getString, getString, getValueClasses, getVSReference, hasFocus, hasSendData, initializeElement, initializeExtendsFramework, initializeProp, initializeValue, initPropCnr, insertProp, insertProp2, isChild, isExtendsOverriden, isExtendsPropertyValid, isExtendsRoot, isPropAddRemoveAllowed, isPropCommunicating, isPropExtended, isSibling, list, list, logPropNotFound, maybeAddProp, onInsertProp, onPropDispose, onPropRemoved, onPropTreeInitialized, onReferenceEvent, paramString, prepare, removeAllProps, removeAllProps2, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp, removeProp2, removeProp2, removeProp2, removeProp2, removeProp2, removeProp2, removeProp2, reorderProps, replaceProps, requestFocus, requestFocus, requestFocusEx, requestFocusEx, resolveReferences, resolveRuntimeReferences, setBool, setBool, setBool, setBool, setCreateRequiredProp, setExtendsName, setExtendsOverride, setInt, setInt, setInt, setLong, setLong, setLong, setLong, setNumber, setNumber, setNumber, setNumber, setProp, setProp, setProp, setProp2, setProp2, setPropValue, setPropValue, setPropValue, setPropValue, setPropValue, setPropValue, setString, setString, setString, setString, shouldCreateProps, shouldSerializeToXML, toElementString, toNativeValue0, usePropHashMap, usesPropIndex, validateChildPropInValue, validateClassInstances, validatePropType, validatePropValue, verify, verifyInternalUseOnly, verifyTree, virtualize

Methods inherited from class com.iizix.prop.GProp
addPropError, addPropListener, convertPropError, dispose, equals, equals, equalsErrors, equalsObj, equalsPropValue, equalValues, extendsClone, finalize, fine, fine, finer, finer, finest, finest, fromElementString, getAliasName, getAppSessionGyro, getAppWorker, getAtomPath, getAttribute, getChildReferencePropName, getClientSessionGyro, getClientWorker, getConstraints, getEnvironment, getErroredPropItems, getErroredProps, getErrorsProp, getExtendsRootContainer, getFullPropName, getFullPropName, getFullPropNameDebug, getFullPropNameDebug, getListeners, getModuleFolder, getModuleFolder, getParent, getParent, getProjectName, getPropAtom, getPropError, getPropError, getPropErroredName, getPropErrorSeverity, getPropExtendsFlags, getPropFromPath, getPropFromPath, getPropFromReference, getPropFromReference, getPropIndex, getPropName, getPropPath, getPropPath, getPropReferenceTarget, getPropRootPropMgr, getPropTreeErrorSeverity, getPropValue, getPropValue, getPropValueObject, getReferencePropName, getRelativePropName, getRootFromName, getRootName, getRootParent, getRootParent, getTreeLock, hasChanged, hasPrivateChangeEventProp, hasPropError, hasPropTreeError, info, info, initializeGElement, initializeGProp, isDisposed, isPropChildOf, isPropClientCreated, isPropCreateRequired, isPropExtended, isPropExtendsFinal, isPropExtendsPrivate, isPropExtendsPrivateInRoot, isPropExtendsPrivateInRoot, isPropFile, isPropFolder, isPropForEditor, isPropNullable, isPropPrivate, isPropPrivateAtCreation, isPropReadOnly, isPropReferenceTreeValid, isPropRoot, isPropUSER, isPropValueTreeLockNeeded, isPropVirtualized, isPropVirtualizing, isPropVolatile, isPropVolatileOrEditorOnly, isProxied, list, list, list, mapAliasToReference, mapAliasToReference, mapReferenceToAlias, mapReferenceToAlias, mapReferenceToProjectRelative, modifyPropValue, moveProp, moveProp, moveProp, onEvent, onEventSelf, onPrepare, onPropInvalidateCache, onPropParentChanged, onPropValueSet, onRemoteEvent, onVirtualizationCompleted, onVirtualized, paramValue, post, post, removePropError, removePropListener, removePropUSER, renameProp, renameProp2, resetChangedTree, setChanged, setConstraints, setConstraints, setParent, setPrivateChangeEventProp, setPrivateCreateRequiredProp, setPropError, setPropErroredName, setPropExtended, setPropExtendsFinal, setPropExtendsPrivate, setPropForEditor, setPropNullable, setPropPrivate, setPropReadOnly, setPropUSER, setPropValue, setPropValue, setPropValue, setPropValueIncognito, setPropVolatile, severe, severe, severe, shouldSerializeToXML, throwIfReadOnly, toNativeValue, toString, toString, triggerRemoteEvent, triggerRemoteEvent, validateProp, verifyHasPropertyItem, warning, warning, warning

Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.iizix.prop.IClassInstantiationAtResolve
shouldInstantiateAtResolve

Methods inherited from interface com.iizix.prop.IGProp
addPropError, addPropListener, dispose, equals, fine, fine, finer, finer, finest, finest, fromElementString, getAppSessionGyro, getAtomPath, getClientSessionGyro, getConstraints, getEnvironment, getErroredPropItems, getErroredProps, getErrorsProp, getExtendsRootContainer, getFullPropName, getFullPropNameDebug, getModuleFolder, getModuleFolder, getParent, getParent, getPropAtom, getPropError, getPropError, getPropErrorSeverity, getPropExtendsFlags, getPropFromPath, getPropFromReference, getPropIndex, getPropName, getPropPath, getPropPath, getPropRootPropMgr, getPropTreeErrorSeverity, getPropValue, getPropValue, getReferencePropName, getRelativePropName, getRootParent, getTreeLock, hasChanged, hasPrivateChangeEventProp, hasPropError, hasPropTreeError, info, info, initializeGElement, initializeGProp, isDisposed, isPropChildOf, isPropClientCreated, isPropCreateRequired, isPropExtended, isPropExtendsFinal, isPropExtendsPrivate, isPropExtendsPrivateInRoot, isPropExtendsPrivateInRoot, isPropFile, isPropFolder, isPropNullable, isPropPrivate, isPropReadOnly, isPropReferenceTreeValid, isPropRoot, isPropVirtualized, list, list, list, mapAliasToReference, mapReferenceToAlias, mapReferenceToProjectRelative, moveProp, moveProp, moveProp, onEvent, onEventSelf, onRemoteEvent, removePropError, removePropListener, renameProp, setChanged, setConstraints, setConstraints, setParent, setPrivateChangeEventProp, setPropError, setPropExtendsFinal, setPropExtendsPrivate, setPropNullable, setPropPrivate, setPropReadOnly, setPropValue, setPropValue, severe, severe, severe, toNativeValue, triggerRemoteEvent, triggerRemoteEvent, validateProp, verifyHasPropertyItem, warning, warning, warning

Methods inherited from interface com.iizix.prop.IPropCnr
canRequestFocus, canRequestFocus, couldRequestFocusIfVirtualized, couldRequestFocusIfVirtualized

- Constructor Detail
  - OutputVariable
```
public OutputVariable()
```
    Creates an output variable property container with the specified name with a null value.
  - OutputVariable
```
public OutputVariable(Atom propertyAtom)
```
    Creates an output variable property container with the specified name with a null value.
    Parameters:
    propertyAtom - the property atom.
- Method Detail
  - clone
```
public OutputVariable clone()
```
    Clones this variable instance.
    Overrides:
    clone in class AbstractVSVariable<VSField,VSFieldReference>
  - getOutputVariables
```
public OutputVariables getOutputVariables()
```
    Gets the output variables properties container.
    Returns:
    The instance, or null if orphaned.
  - getOutputProps
```
public OutputProps getOutputProps()
```
    Gets the output properties.
    Returns:
    The instance, or null if orphaned.
  - getVSPropertyClass
```
public java.lang.Class<VSField> getVSPropertyClass()
```
    Gets the class wanted for the VS component being referenced.
    Specified by:
    getVSPropertyClass in class AbstractVSVariable<VSField,VSFieldReference>
    Returns:
    VSField.class, VSColumnHeader.class or VSTable.class.
  - getVSReferenceClass
```
public java.lang.Class<VSFieldReference> getVSReferenceClass()
```
    Gets the class wanted for VS references.
    Specified by:
    getVSReferenceClass in class AbstractVSVariable<VSField,VSFieldReference>
    Returns:
    VSFieldReference.class.
  - setVSRelativeReference
```
public boolean setVSRelativeReference(java.lang.String relRef)
```
    Sets the reference.
    Parameters:
    relRef - The relative VS reference.
    Returns:
    true for changed, false for no change.
  - getVSField
```
public VSField getVSField()
```
    Gets the VSField.
    Returns:
    The VSField associated, or null for none (or unresolved).
  - getDescription
```
public java.lang.String getDescription()
```
    Gets the field description.
    Returns:
    A description, or null for none.
  - isNullOmit
```
public boolean isNullOmit()
```
    Flag indicating that the VS Field connected should not be assigned a Null value when the output reply doesn't contain this variable, and that this variable is not an identification. If this flag is true, the VS Field value will remain untouched, otherwise the VS Field will be assigned Null.
    Returns:
    true to omit parameter for null value, or to use the null replacement value when false.
  - getNullReplacement
```
public Value getNullReplacement()
```
    Get the Null Replacement Value.
    Returns:
    The value to use when the output value is null (not present), null to omit changes.
  - isIdentification
```
public boolean isIdentification()
```
    Indicates this variable is an identification variable and if it's not present in the output reply, then the processor doesn't match.
    Returns:
    Flag for identification, true by default.
  - getClassReference
```
public ClassReference getClassReference()
```
    Gets the class reference for the output value converter.
    Returns:
    The class reference, or null for none.
  - getOutputVariableConverter
```
public IOutputVariableConverter getOutputVariableConverter()
```
    Gets the instance of the output value converter.
    Returns:
    The instance of the converter, or null for none.

Class OutputVariable

Field Summary

Fields inherited from class com.iizix.prop.PropCnr

Fields inherited from class com.iizix.prop.GProp

Fields inherited from interface com.iizix.prop.IGProp

Constructor Summary

Method Summary

Methods inherited from class com.iizix.prop.vs.AbstractVSVariable

Methods inherited from class com.iizix.prop.PropCnr

Methods inherited from class com.iizix.prop.GProp

Methods inherited from class java.lang.Object

Methods inherited from interface com.iizix.prop.IClassInstantiationAtResolve

Methods inherited from interface com.iizix.prop.IGProp

Methods inherited from interface com.iizix.prop.IPropCnr

Constructor Detail

OutputVariable

OutputVariable

Method Detail

clone

getOutputVariables

getOutputProps

getVSPropertyClass

getVSReferenceClass

setVSRelativeReference

getVSField

getDescription

isNullOmit

getNullReplacement

isIdentification

getClassReference

getOutputVariableConverter