Package com.iizix.ws.prop

Class OutputVariable

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

  • Constructor Details

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

    • 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 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 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(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 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.