[
https://issues.apache.org/jira/browse/NIFI-309?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14369927#comment-14369927
]
Matt Gilman edited comment on NIFI-309 at 3/19/15 7:09 PM:
-----------------------------------------------------------
1) Use Attribute/Property instead of [Reads|Writes]Attribute/DynamicProperty
unless there's something special about Reads vs Writes. But it doesn't appear
that is the case.
2) I would vote against using value. While this is usually what you see with
Java annotations, its just confusing to put the attribute name inside of the
Attribute.value field. I would probably lean towards Attribute.name instead.
3) If the change didn't break compatibility (as if it were included all along),
I would vote for 2. Considering that we're already breaking backwards
compatibility for this release I'm leaning to 2 for my actual vote. I could be
persuaded to go with 1. I do no think 3 is a good option. Why should the user
be bothered with a uncertain message ('Warning this processor may not support
dynamic properties') because a processor developer didn't know to specify the
attribute or didn't take the time to update the processor for this release.
Lets either do it or not.
4) 0
was (Author: mcgilman):
1) Use Attribute/Property instead of [Reads|Writes]Attribute/DynamicProperty
unless there's something special about Reads vs Writes. But it doesn't appear
that is the case.
2) I would vote against using value. While this is usually what you see with
Java annotations, its just confusing to put the attribute name instead of the
Attribute.value field. I would probably lean towards Attribute.name instead.
3) If the change didn't break compatibility (as if it were included all along),
I would vote for 2. Considering that we're already breaking backwards
compatibility for this release I'm leaning to 2 for my actual vote. I could be
persuaded to go with 1. I do no think 3 is a good option. Why should the user
be bothered with a uncertain message ('Warning this processor may not support
dynamic properties') because a processor developer didn't know to specify the
attribute or didn't take the time to update the processor for this release.
Lets either do it or not.
4) 0
> 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)
