Class ResultProps

All Implemented Interfaces:
EventListener, IClassInstantiationAtResolve, IGProp<GProp<?>[]>, IPropCnr, IReferrerParticipant, IVSAccessor, IVSComponentListener, IVSComponentState, IVSFieldListener, IVSParticipant, Cloneable
Direct Known Subclasses:
EditorResultProps

public class ResultProps extends PropCnr implements IVSParticipant, IVSFieldListener, IClassInstantiationAtResolve
Result property that ties a result from the execution of an SQL query statement to VirtualSpace of type UPDATE, DELETE, etc.
Author:
Christopher Mindus
  • Constructor Details Link icon

    • ResultProps Link icon

      public ResultProps()
      Creates a Result property container with the specified name with a null value.
    • ResultProps Link icon

      public ResultProps(Atom propertyAtom)
      Creates a Result property container with the specified name with a null value.
      Parameters:
      propertyAtom - the property atom.
  • Method Details Link icon

    • clone Link icon

      public ResultProps clone()
      Clones this ResultProps instance.
      Overrides:
      clone in class PropCnr
    • getDatabaseProps Link icon

      public DatabaseProps getDatabaseProps()
      Gets the Database Transaction properties.
      Returns:
      The Database Transaction properties, or null if this property is orphaned.
    • getDescription Link icon

      public String getDescription()
      Gets the result set description.
      Returns:
      A description, or null for none.
    • getParticipantDescription Link icon

      public String getParticipantDescription()
      Returns the given description of the referrer participant.
      Specified by:
      getParticipantDescription in interface IReferrerParticipant
    • getParticipantType Link icon

      public String getParticipantType()
      Returns the given type of the referrer participant.
      Specified by:
      getParticipantType in interface IReferrerParticipant
    • getVSReference Link icon

      public VSParticipant getVSReference(Atom refAtom)
      Gets a VSReference instance from the container or any parent containers. The method is used by VSRelativeReference to look up the VSReference instance in order to resolve the relative path to the target property.
      Specified by:
      getVSReference in interface IGProp<GProp<?>[]>
      Overrides:
      getVSReference in class PropCnr
      Parameters:
      refAtom - The property atom of the requesting relative reference property.
      Returns:
      The instance of the VSReference or null if unassigned.
    • getVirtualSpace Link icon

      public VirtualSpace getVirtualSpace()
      Gets the VirtualSpace.
      Specified by:
      getVirtualSpace in interface IVSAccessor
      Returns:
      The VirtualSpace connected to the result set, or null for none.
    • getTargetVirtualSpaceParticipant Link icon

      public VSParticipant getTargetVirtualSpaceParticipant()
      Gets the target VirtualSpace participant for output data.
      Returns:
      The target VirtualSpace participating with the output data, null for none.
    • getVSFieldReference Link icon

      public VSFieldReference getVSFieldReference()
      Gets the VSField reference.
      Returns:
      The VSField refence instance, or null if undefined.
    • getVSField Link icon

      public VSField getVSField()
      Gets the VirtualSpace table for all the output.
      Returns:
      The VirtualSpace Table, null for none.
    • getBestVSFieldValueType Link icon

      public Value.Type getBestVSFieldValueType(VSRelativeReference<?> reference)
      Requests the value type that would best suit the listener.
      Specified by:
      getBestVSFieldValueType in interface IVSFieldListener
      Parameters:
      reference - The VSRelativeReference instance holding the reference.
      Returns:
      Value.Type.Long.
    • onResolved Link icon

      public void onResolved(VSRelativeReference<?> reference, VSField field)
      Called when the property reference has been resolved. UI components use this method to set its state according to the field.
      Specified by:
      onResolved in interface IVSFieldListener
      Parameters:
      reference - The VSRelativeReference instance holding the reference.
      field - The target reference.
    • onBroken Link icon

      public void onBroken(VSRelativeReference<?> reference, VSField field)
      Called when the property reference has been broken, i.e. unresolved.
      Specified by:
      onBroken in interface IVSFieldListener
      Parameters:
      reference - The VSRelativeReference instance holding the reference.
      field - The target reference.
    • onStateChanged Link icon

      public void onStateChanged(VSField field, IVSComponentState.State state, boolean on)
      Called when the field changes state.
      Specified by:
      onStateChanged in interface IVSFieldListener
      Parameters:
      field - The VS field.
      state - The state change.
      on - New state.
    • onParentStateChanged Link icon

      public void onParentStateChanged(IVSComponent parent, IVSComponentState.State state, boolean on)
      Called when the column changes state.
      Specified by:
      onParentStateChanged in interface IVSComponentListener
      Parameters:
      parent - The parent who's state was changed.
      state - The state change, possible values PARENT_ENABLED, PARENT_READONLY, PARENT_VISIBLE.
      on - New state.
    • onValueChanged Link icon

      public void onValueChanged(VSField field, Value value, GProp<?> trigger, IPostEventProcessing postProcessing)
      Called when the field value is set.
      Specified by:
      onValueChanged in interface IVSFieldListener
      Parameters:
      field - The VS field.
      value - The value, never null, but value.isNull() could be true.
      trigger - The trigger property that may be null.
      postProcessing - Post-processing instance.
    • getClassReference Link icon

      public ClassReference getClassReference()
      The Java class associated with result set output.
      Returns:
      The ClassReference instance, or null for none.
    • getResultProcessor Link icon

      public IUpdateProcessor getResultProcessor()
      Gets the instance of the IUpdateProcessor.
      Returns:
      The instance of IResultProcessor, or null for none.
    • onVirtualSpaceVirtualized Link icon

      public void onVirtualSpaceVirtualized(IAppSessionGyro appGyro, VirtualSpace virtualizedVirtualSpace)
      Called when the VirtualSpace has been virtualized, giving the opportunity for e.g. data connectors to prepare it's virtualized counterparts if this is required.

      This call is done to the non-virtualized instance of the VirtualSpace participant.

      Specified by:
      onVirtualSpaceVirtualized in interface IVSParticipant
      Parameters:
      appGyro - The application gyro instance.
      virtualizedVirtualSpace - The virtualized VirtualSpace instance.