[
https://issues.apache.org/jira/browse/NIFI-309?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14371314#comment-14371314
]
Dan Bress commented on NIFI-309:
--------------------------------
Mark,
On #4 I've kind of wrestled with how to describe dynamic properties. Right
now there are 4 things you can specify
# {{name}} The format/meaning of the name of the dynamic property
# {{value}} the format/meaning of the value of the property
# {{supportsExpressionLanguage}} Whether the value supports expression language
# {{description}} A description of what setting this property will do
Here is an Example from {{RouteOnAttribute}}
{code:title=DynamicProperty.java|borderStyle=solid}
@DynamicProperty(name="Relationship Name", value="Attribute Expression
Language", supportsExpressionLanguage=true, description="Routes FlowFiles whose
" +
"attributes match the Attribute Expression Language specified in the Dynamic
Property Value to the Relationship specified in the Dynamic Property Key")
{code}
The reason I was thinking of changing "value" to "valueDescription" is "value"
has a special meaning in Java annotations, and I didn't want to override it. I
don't feel strongly about it.
> 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)
