Package com.iizix.ws.prop

Class OutputProps

java.lang.Object
com.iizix.prop.GProp<GProp<?>[]>
com.iizix.prop.PropCnr
com.iizix.ws.prop.OutputProps
All Implemented Interfaces:
EventListener, IClassInstantiationAtResolve, IGProp<GProp<?>[]>, IPropCnr, IReferrerParticipant, IVSAccessor, IVSParticipant, Cloneable
Direct Known Subclasses:
EditorOutputProps
public class OutputProps extends PropCnr implements IVSParticipant, IClassInstantiationAtResolve
Output property that ties a result set from the execution of a Web Service request to VirtualSpace.
Author:
Christopher Mindus

  • Constructor Details

    • OutputProps

      public OutputProps()
      Creates an Output property container with the specified name with a null value.

    • OutputProps

      public OutputProps(Atom propertyAtom)
      Creates a Output property container with the specified name with a null value.
      Parameters:
      propertyAtom - the property atom.

  • Method Details

    • createOutputVariables

      protected OutputVariables createOutputVariables()
      Creates the output properties.

    • getOutputVariables

      public OutputVariables getOutputVariables()
      Gets the output variables.
      Returns:
      The output variables instance.

    • addPredefinedProps

      protected void addPredefinedProps() throws PropException
      Adds the predefined properties for this container. This method is called once just after construction of the property container.

      Properties added:

        - InputProps as Atom.INPUT

      Overrides:
      addPredefinedProps in class PropCnr
      Throws:
      PropException - for property exceptions.

    • getPredefinedProps

      protected void getPredefinedProps()
      Gets potential references to predefined properties for this container. This method is called once just after cloning of the property container.

      The method should get reference to using the getProp(...) methods. This allows the subclass to be able to retrieve the new instances to the properties created during addPredefinedProps() if stored in instance variables.

      Overrides:
      getPredefinedProps in class PropCnr

    • clone

      public OutputProps clone()
      Clones this Output property container.
      Overrides:
      clone in class PropCnr

    • getWebServiceProp

      public WebServiceProp getWebServiceProp()
      Gets the Web Service property.
      Returns:
      The Web Service property, or null if this property is orphaned.

    • getDescription

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

    • getEncoding

      public String getEncoding()
      Gets the encoding.
      Returns:
      The encoding, default "UTF-8".

    • areUnicodeZeroWidthCharsIgnored

      public boolean areUnicodeZeroWidthCharsIgnored()
      Checks if Unicode zero-width non-breaking space (0xFEFF) should be ignored.
      Returns:
      Flag for ignoring these characters, true by default.

    • isPlainTextAccepted

      public boolean isPlainTextAccepted()
      Verifies if the Plain Text is accepted.
      Returns:
      true if plain text is OK.

    • isHTMLAccepted

      public boolean isHTMLAccepted()
      Verifies if the HTML text is accepted.
      Returns:
      true if HTML is OK.

    • isXMLAccepted

      public boolean isXMLAccepted()
      Verifies if the XML is accepted.
      Returns:
      true if XML is OK.

    • isJSONAccepted

      public boolean isJSONAccepted()
      Verifies if JSON is accepted.
      Returns:
      true if JSON is OK.

    • getParticipantDescription

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

    • getParticipantType

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

    • getVSReference

      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.

    • createVSReference

      public VSParticipant createVSReference(Atom refAtom, PropCnr[] returnParent)
      Creates a VSReference instance from the container or any parent containers. The method is used in the Designer to create a VirtualSpace connection for VSRelativeReference to look up the VSReference instance in order to resolve the relative path to the target property.

      This method needs to be overridden by subclasses of PropCnr that has a VSReference as property, and *SHOULD* match getVSReference(Atom).

      The default is to re-target the call to the parent container, and if the root, a folder or a file property is reached, null is returned.

      Overrides:
      createVSReference in class PropCnr
      Parameters:
      refAtom - The property asking for the VSReference.
      returnParent - An array of PropCnr [1] that will be filled in with the parent property of the VSRefernce.
      Returns:
      The instance of the VSReference or null if unassigned. The returned instance could also be a VSParticipant and should therefore be processed accordingly.

      For this method, it's a VSParticipant.

    • getVirtualSpace

      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

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

    • getClassReference

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

    • getMatchingProcessor

      public IReplyProcessor getMatchingProcessor(IReplyContent reply)
      Verifies if the reply matches the current output properties.
      Parameters:
      reply - The reply contents.
      Returns:
      The first matching processor, null for none.

    • getMatchingProcessors

      public List<IReplyProcessor> getMatchingProcessors(IReplyContent reply)
      Verifies if the reply matches the current output properties.
      Parameters:
      reply - The reply contents.
      Returns:
      The list of matching processors.

    • onVirtualSpaceVirtualized

      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.