Package com.ptc.mvc.components

Interface ComponentResultProcessor

All Superinterfaces:
ResultProcessor
All Known Implementing Classes:
AbstractComponentResultProcessor, DefaultComponentResultProcessor, DefaultTreeResultProcessor
public interface ComponentResultProcessor extends ResultProcessor
ResultProcessor interface for DataSource. If the MVC component is marked to be of DataSourceMode = ASYNCHRONOUS, this processor will be available in its ComponeentDataBuilder. In the ComponentDataBuilder, you need to add the data from your query layer/other sources.

Supported API: true

Extendable: false

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addElements(Iterable<?> elements)


    Supported API: true
    default void
    addElements(Iterable<?> elements, boolean handleInOneChunk)


    Supported API: true
    void
    addFeedback(List<? extends ClientFeedback> feedback)
    Add ClientFeedback

    Supported API: true
    int
    getChunkSize()
    When the added elements reaches this size, it will be send for processing, after which gets added to DataSource

    Supported API: true
    ComponentConfig
    getConfig()
    Get the ComponentConfig

    Supported API: true
    com.ptc.mvc.components.ComponentData
    getInitialData()
    Get the intialData.
    ComponentParams
    getParams()
    Get the ComponentParams

    Supported API: true
    boolean
    isOffSetData()
    Whether the data added is from offSet or not

    Supported API: true
    boolean
    isOpen()
    Determine if results can still be added.
    boolean
    isPresorted()


    Supported API: true
    void
    setFeedbackGenerator(ClientFeedbackGenerator generator)
    Set the Generator that will generate ClientFeedback for the chunkables that gets added into the DataSource

    Supported API: true
    void
    setOffSetData(boolean offSetData)
    Inform that we are going to add data from offset

    Supported API: true
    void
    setPresorted(boolean preSorted)
    Specify whether the data that is added is sorted or not.

    Methods inherited from interface wt.fc.ResultProcessor

    addElement

  • Method Details

    • getConfig

      ComponentConfig getConfig()
      Get the ComponentConfig

      Supported API: true
      Returns:

    • getInitialData

      com.ptc.mvc.components.ComponentData getInitialData()
      Get the intialData.

      Supported API: true
      Returns:

    • getParams

      ComponentParams getParams()
      Get the ComponentParams

      Supported API: true
      Returns:

    • addElements

      void addElements(Iterable<?> elements) throws WTException


      Supported API: true
      Parameters:
      elements -
      Throws:
      WTException

    • addElements

      default void addElements(Iterable<?> elements, boolean handleInOneChunk) throws WTException


      Supported API: true
      Parameters:
      elements -
      handleInOneChunk - whether the elements that is provided here is to be handled in the same chunk or not
      Throws:
      WTException

    • setPresorted

      void setPresorted(boolean preSorted)
      Specify whether the data that is added is sorted or not. [default is false]

      Supported API: true
      Parameters:
      memorySort -

    • isPresorted

      boolean isPresorted()


      Supported API: true
      Returns:
      boolean

    • isOpen

      boolean isOpen()
      Determine if results can still be added. If the processor is not open, then calls to addElement may throw runtime Exceptions.

      Supported API: true
      Returns:
      boolean

    • setFeedbackGenerator

      void setFeedbackGenerator(ClientFeedbackGenerator generator)
      Set the Generator that will generate ClientFeedback for the chunkables that gets added into the DataSource

      Supported API: true
      Parameters:
      generator -

    • addFeedback

      void addFeedback(List<? extends ClientFeedback> feedback)
      Add ClientFeedback

      Supported API: true
      Parameters:
      feedback -

    • setOffSetData

      void setOffSetData(boolean offSetData)
      Inform that we are going to add data from offset

      Supported API: true
      Parameters:
      offSetData -

    • isOffSetData

      boolean isOffSetData()
      Whether the data added is from offSet or not

      Supported API: true
      Returns:

    • getChunkSize

      int getChunkSize()
      When the added elements reaches this size, it will be send for processing, after which gets added to DataSource

      Supported API: true
      Returns:
      int