[ 
https://issues.apache.org/jira/browse/NIFI-309?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14369767#comment-14369767
 ] 

Dan Bress commented on NIFI-309:
--------------------------------

Honestly, when I started this I did not want to use annotations to accomplish 
it, because all the information I need is sort-of-kind-of in:

{{protected PropertyDescriptor getSupportedDynamicPropertyDescriptor(final 
String propertyDescriptorName)}}

However, these properties are dynamically generated based on the property name 
the user passes in, so you can't ask a {{ConfigurableComponent}} to give you 
all of its dynamic properties.  Mark gave me an explanation as to why this is, 
I think to support different kinds of dynamic properties based on the property 
name?  Mark?  

When I was putting these annotations on yesterday, the closest thing I saw to 
this use case was {{PutFTP}}.  Maybe I missed it or didn't understand it in the 
first place.

> Support additional documentation annotations
> --------------------------------------------
>
>                 Key: NIFI-309
>                 URL: https://issues.apache.org/jira/browse/NIFI-309
>             Project: Apache NiFi
>          Issue Type: Improvement
>          Components: Core Framework, Documentation & Website
>    Affects Versions: 0.0.1
>            Reporter: Dan Bress
>            Assignee: Dan Bress
>            Priority: Trivial
>
> Additional documentation only annotations should be added to better describe 
> ConfigurableComponents.  These annotations are:
> DynamicProperties - this would indicate whether a component supports dynamic 
> properties or not, and provides a description.  This could be used by the UI 
> to determine whether or not to allow dynamic properties.  It could also be 
> reflected in the documentation.
> DynamicRelationships - this would indicate whether a component has dynamic 
> relationships, like RouteOnAttribute and DistributeLoad do.  This could be 
> reflected in the documentation.
> ReadsAttribute - indicates what attributes a Processor reads certain FlowFile 
> attributes on incoming FlowFiles.  This would be reflected in the 
> documentation.
> WritesAttribute - indicates what attributes a Processor creates on outgoing 
> FlowFile attributes.  This would be reflected in the documentation.
> SeeAlso - Provides a mechanism to link one configurable component to another. 
>  E.g. PutFile & GetFile.  This would be used in the documentation.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)

Reply via email to