NIFI-309 better support for See also using class names
Project: http://git-wip-us.apache.org/repos/asf/incubator-nifi/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-nifi/commit/6722fc9d Tree: http://git-wip-us.apache.org/repos/asf/incubator-nifi/tree/6722fc9d Diff: http://git-wip-us.apache.org/repos/asf/incubator-nifi/diff/6722fc9d Branch: refs/heads/develop Commit: 6722fc9dbc2fcbe91ca69e12a5d85cd3134577de Parents: 376a9c6 Author: danbress <[email protected]> Authored: Thu Mar 5 14:01:24 2015 -0500 Committer: danbress <[email protected]> Committed: Fri Mar 20 09:46:02 2015 -0400 ---------------------------------------------------------------------- .../java/org/apache/nifi/annotation/documentation/SeeAlso.java | 4 ++-- .../apache/nifi/documentation/html/HtmlDocumentationWriter.java | 4 ++-- .../documentation/html/HtmlProcessorDocumentationWriter.java | 3 +++ .../nifi/documentation/example/FullyDocumentedProcessor.java | 2 +- .../org/apache/nifi/processors/standard/DetectDuplicate.java | 2 +- 5 files changed, 9 insertions(+), 6 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/6722fc9d/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/documentation/SeeAlso.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/documentation/SeeAlso.java b/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/documentation/SeeAlso.java index 3ad8081..d664117 100644 --- a/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/documentation/SeeAlso.java +++ b/nifi/nifi-api/src/main/java/org/apache/nifi/annotation/documentation/SeeAlso.java @@ -46,7 +46,7 @@ public @interface SeeAlso { * * @return */ - public Class<? extends ConfigurableComponent>[] value(); + public Class<? extends ConfigurableComponent>[] value() default {}; /** * Fully qualified class names you want to link to. Use this when the class @@ -55,5 +55,5 @@ public @interface SeeAlso { * * @return */ - public String[] classNames() default ""; + public String[] classNames() default {}; } http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/6722fc9d/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-documentation/src/main/java/org/apache/nifi/documentation/html/HtmlDocumentationWriter.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-documentation/src/main/java/org/apache/nifi/documentation/html/HtmlDocumentationWriter.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-documentation/src/main/java/org/apache/nifi/documentation/html/HtmlDocumentationWriter.java index 1bfdd27..f3c0edf 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-documentation/src/main/java/org/apache/nifi/documentation/html/HtmlDocumentationWriter.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-documentation/src/main/java/org/apache/nifi/documentation/html/HtmlDocumentationWriter.java @@ -144,7 +144,7 @@ public class HtmlDocumentationWriter implements DocumentationWriter { private void writeSeeAlso(ConfigurableComponent configurableComponent, XMLStreamWriter xmlStreamWriter) throws XMLStreamException { final SeeAlso seeAlso = configurableComponent.getClass().getAnnotation(SeeAlso.class); - if (seeAlso != null && seeAlso.value().length > 0) { + if (seeAlso != null) { writeSimpleElement(xmlStreamWriter, "h3", "See Also:"); xmlStreamWriter.writeStartElement("p"); int index = 0; @@ -167,7 +167,7 @@ public class HtmlDocumentationWriter implements DocumentationWriter { final String link = "../" + linkedComponent + "/index.html"; - final int indexOfLastPeriod = Math.min(0, linkedComponent.lastIndexOf(".")); + final int indexOfLastPeriod = Math.max(0, linkedComponent.lastIndexOf(".")); writeLink(xmlStreamWriter, linkedComponent.substring(indexOfLastPeriod), link); http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/6722fc9d/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-documentation/src/main/java/org/apache/nifi/documentation/html/HtmlProcessorDocumentationWriter.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-documentation/src/main/java/org/apache/nifi/documentation/html/HtmlProcessorDocumentationWriter.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-documentation/src/main/java/org/apache/nifi/documentation/html/HtmlProcessorDocumentationWriter.java index f83b2f6..af218d8 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-documentation/src/main/java/org/apache/nifi/documentation/html/HtmlProcessorDocumentationWriter.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-documentation/src/main/java/org/apache/nifi/documentation/html/HtmlProcessorDocumentationWriter.java @@ -88,9 +88,11 @@ public class HtmlProcessorDocumentationWriter extends HtmlDocumentationWriter { xmlStreamWriter.writeStartElement("tr"); writeSimpleElement(xmlStreamWriter, "td", StringUtils.defaultIfBlank(attribute.attribute(), "Not Specified")); + // TODO allow for HTML characters here. writeSimpleElement(xmlStreamWriter, "td", StringUtils.defaultIfBlank(attribute.description(), "Not Specified")); xmlStreamWriter.writeEndElement(); + } xmlStreamWriter.writeEndElement(); @@ -123,6 +125,7 @@ public class HtmlProcessorDocumentationWriter extends HtmlDocumentationWriter { xmlStreamWriter.writeStartElement("tr"); writeSimpleElement(xmlStreamWriter, "td", StringUtils.defaultIfBlank(attribute.attribute(), "Not Specified")); + // TODO allow for HTML characters here. writeSimpleElement(xmlStreamWriter, "td", StringUtils.defaultIfBlank(attribute.description(), "Not Specified")); xmlStreamWriter.writeEndElement(); http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/6722fc9d/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-documentation/src/test/java/org/apache/nifi/documentation/example/FullyDocumentedProcessor.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-documentation/src/test/java/org/apache/nifi/documentation/example/FullyDocumentedProcessor.java b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-documentation/src/test/java/org/apache/nifi/documentation/example/FullyDocumentedProcessor.java index b9bce91..84dc88f 100644 --- a/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-documentation/src/test/java/org/apache/nifi/documentation/example/FullyDocumentedProcessor.java +++ b/nifi/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-documentation/src/test/java/org/apache/nifi/documentation/example/FullyDocumentedProcessor.java @@ -42,7 +42,7 @@ import org.apache.nifi.processor.util.StandardValidators; @CapabilityDescription("This is a processor that is used to test documentation.") @WritesAttributes({@WritesAttribute(attribute="first", description="this is the first attribute i write"), @WritesAttribute(attribute="second")}) @ReadsAttribute(attribute = "incoming", description="this specifies the format of the thing") -@SeeAlso({FullyDocumentedControllerService.class, FullyDocumentedReportingTask.class}) +@SeeAlso(value={FullyDocumentedControllerService.class, FullyDocumentedReportingTask.class}, classNames={"org.apache.nifi.processor.ExampleProcessor"}) public class FullyDocumentedProcessor extends AbstractProcessor { public static final PropertyDescriptor DIRECTORY = new PropertyDescriptor.Builder().name("Input Directory") http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/6722fc9d/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/java/org/apache/nifi/processors/standard/DetectDuplicate.java ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/java/org/apache/nifi/processors/standard/DetectDuplicate.java b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/java/org/apache/nifi/processors/standard/DetectDuplicate.java index f2a9e3e..eb0d6c7 100644 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/java/org/apache/nifi/processors/standard/DetectDuplicate.java +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/java/org/apache/nifi/processors/standard/DetectDuplicate.java @@ -57,7 +57,7 @@ import org.apache.nifi.processor.util.StandardValidators; + "\"description\", which is specified in the <FlowFile Description> property. If the FlowFile is not determined to be a duplicate, the Processor " + "routes the FlowFile to 'non-duplicate'") @WritesAttribute(attribute="original.flowfile.description", description="All FlowFiles routed to the duplicate relationship will have an attribute added named original.flowfile.description. The value of this attribute is determined by the attributes of the original copy of the data and by the FlowFile Description property.") -@SeeAlso(value={DistributedMapCacheClient.class}, classNames={"org.apache.nifi.distributed.cache.server.map.DistributedMapCacheServer"}) +@SeeAlso(classNames={"org.apache.nifi.distributed.cache.client.DistributedMapCacheClientService", "org.apache.nifi.distributed.cache.server.map.DistributedMapCacheServer"}) public class DetectDuplicate extends AbstractProcessor { public static final String ORIGINAL_DESCRIPTION_ATTRIBUTE_NAME = "original.flowfile.description";
