Package com.iizix.ws.prop
Class OutputColumn
- java.lang.Object
- com.iizix.prop.GProp<GProp<?>[]>
- com.iizix.prop.PropCnr
- com.iizix.prop.vs.AbstractVSVariable<VSColumnHeader,VSTableColumnReference>
- com.iizix.ws.prop.OutputColumn
- All Implemented Interfaces:
EventListener
,IClassInstantiationAtResolve
,IGProp<GProp<?>[]>
,IPropCnr
,IVSTableColumnReferenceOwner
,java.lang.Cloneable
- Direct Known Subclasses:
EditorOutputColumn
public class OutputColumn extends AbstractVSVariable<VSColumnHeader,VSTableColumnReference> implements IVSTableColumnReferenceOwner, IClassInstantiationAtResolve
The Output Column connects a table column from the reply output with a VSTable column.- 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 OutputColumn()
Creates an output column property container with the specified name with a null value.OutputColumn(Atom propertyAtom)
Creates an output column property container with the specified name with a null value.
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description OutputColumn
clone()
Clones this column instance.ClassReference
getClassReference()
Gets the class reference for the output value converter.java.lang.String
getDescription()
Gets the table description.Value
getNullReplacement()
Get the Null Replacement Value.OutputProps
getOutputProps()
Gets the output properties.OutputTable
getOutputTable()
Gets the Output Table.IOutputVariableConverter
getOutputVariableConverter()
Gets the instance of the output value converter.OutputVariables
getOutputVariables()
Gets the output variables properties container.VSColumnHeader
getVSColumnHeader()
Gets the VSColumnHeader.java.lang.Class<VSColumnHeader>
getVSPropertyClass()
Gets the class wanted for the VS component being referenced.java.lang.Class<VSTableColumnReference>
getVSReferenceClass()
Gets the class wanted for VS references.VSTable
getVSTable(VSTableColumnReference ref)
Gets the VSTable for a VSTableColumnReference instance.VSReferenceOwnerData<VSTable,VSTableReference>
getVSTableReferenceOwnerData()
Gets the table reference owner data for the table column reference.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 table column cell 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
OutputColumn
public OutputColumn()
Creates an output column property container with the specified name with a null value.
OutputColumn
public OutputColumn(Atom propertyAtom)
Creates an output column property container with the specified name with a null value.- Parameters:
propertyAtom
- the property atom.
Method Detail
clone
public OutputColumn clone()
Clones this column instance.- Overrides:
clone
in classAbstractVSVariable<VSColumnHeader,VSTableColumnReference>
getOutputTable
public OutputTable getOutputTable()
Gets the Output Table.- Returns:
- The instance, or null if orphaned.
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.
getVSTableReferenceOwnerData
public VSReferenceOwnerData<VSTable,VSTableReference> getVSTableReferenceOwnerData()
Gets the table reference owner data for the table column reference.- Specified by:
getVSTableReferenceOwnerData
in interfaceIVSTableColumnReferenceOwner
- Returns:
- The VSReferenceOwnerData instance, always non-null.
getVSTable
public VSTable getVSTable(VSTableColumnReference ref)
Gets the VSTable for a VSTableColumnReference instance.- Specified by:
getVSTable
in interfaceIVSTableColumnReferenceOwner
- Parameters:
ref
- The reference instance, null when property-editing the reference in the Designer.- Returns:
- The table for the reference, or null if not found.
getVSPropertyClass
public java.lang.Class<VSColumnHeader> getVSPropertyClass()
Gets the class wanted for the VS component being referenced.- Specified by:
getVSPropertyClass
in classAbstractVSVariable<VSColumnHeader,VSTableColumnReference>
- Returns:
- VSField.class, VSColumnHeader.class or VSTable.class.
getVSReferenceClass
public java.lang.Class<VSTableColumnReference> getVSReferenceClass()
Gets the class wanted for VS references.- Specified by:
getVSReferenceClass
in classAbstractVSVariable<VSColumnHeader,VSTableColumnReference>
- Returns:
- VSTableReference.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.
getVSColumnHeader
public VSColumnHeader getVSColumnHeader()
Gets the VSColumnHeader.- Returns:
- The VSColumnHeader associated, or null for none (or unresolved).
getDescription
public java.lang.String getDescription()
Gets the table description.- Returns:
- A description, or null for none.
isNullOmit
public boolean isNullOmit()
Flag indicating that the VS table column cell 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 cell value will remain untouched, otherwise the VS cell will be assigned Null.- Returns:
- true to omit if null, false to use null replacement.
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.