fix(QTDI-1656): what is a processor

[thboileau]

Requirements

• Any code change adding any logic MUST be tested through a unit test executed with the default build
• Any API addition MUST be done with a documentation update if relevant

Why this PR is needed?

What does this PR adds (design/code thoughts)?

[thboileau]

to be honest, this is not clear at all. and the whole chapter should be rephrased.

I expect an answer to the following question: what are the characteristics of a Processor? What's the contract?
And I see two characteristics:

• a class with a @Processor annotation that allows to name the processor.
• a mandatory method annotated @ElementListener with an input record and and output record.

Then, what's the purpose to mention Combiner which is an answer to another question: What is not a processor or an output?

Then it is not clear what are the characteristics of an output? There is just no answer to this question. If we want to say that a processor can serve as an output, we must add what are the differences between processor and output.

Another point related to the previous comment, the documentation does not mention clearly another aspect of components: how to link them.
From my current understanding, there are two kind of links:

• records that can be generated by an input component, a processor. the second component is "activated" when a record is generated, and it should be either a processor or an output component
• "subjob" links (OK or KO): the second component is activated when the first one is over. second component could whatever that can start without record: input or standalone components.

[sonar-eks]

Analysis Details

0 Issues

• 0 Bugs
• 0 Vulnerabilities
• 0 Code Smells

Coverage and Duplications

• No coverage information (56.40% Estimated after merge)
• No duplication information (1.30% Estimated after merge)

Project ID: org.talend.sdk.component:component-runtime

View in SonarQube