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, 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

  • Constructor Details

    • 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 Details

    • clone

      public OutputColumn clone()
      Clones this column instance.
      Overrides:
      clone in class AbstractVSVariable<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 interface IVSTableColumnReferenceOwner
      Returns:
      The VSReferenceOwnerData instance, always non-null.

    • getVSTable

      public VSTable getVSTable(VSTableColumnReference ref)
      Gets the VSTable for a VSTableColumnReference instance.
      Specified by:
      getVSTable in interface IVSTableColumnReferenceOwner
      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 Class<VSColumnHeader> getVSPropertyClass()
      Gets the class wanted for the VS component being referenced.
      Specified by:
      getVSPropertyClass in class AbstractVSVariable<VSColumnHeader,VSTableColumnReference>
      Returns:
      VSField.class, VSColumnHeader.class or VSTable.class.

    • getVSReferenceClass

      public Class<VSTableColumnReference> getVSReferenceClass()
      Gets the class wanted for VS references.
      Specified by:
      getVSReferenceClass in class AbstractVSVariable<VSColumnHeader,VSTableColumnReference>
      Returns:
      VSTableReference.class.

    • setVSRelativeReference

      public boolean setVSRelativeReference(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 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.