mirror of https://github.com/apache/nifi.git
Merge branch 'NIFI-441d' of https://github.com/danbress/incubator-nifi into develop
This commit is contained in:
commit
220ec94c09
|
@ -302,12 +302,13 @@ public class HtmlDocumentationWriter implements DocumentationWriter {
|
||||||
List<PropertyDescriptor> properties = configurableComponent.getPropertyDescriptors();
|
List<PropertyDescriptor> properties = configurableComponent.getPropertyDescriptors();
|
||||||
if (properties.size() > 0) {
|
if (properties.size() > 0) {
|
||||||
xmlStreamWriter.writeStartElement("table");
|
xmlStreamWriter.writeStartElement("table");
|
||||||
|
xmlStreamWriter.writeAttribute("id", "properties");
|
||||||
|
|
||||||
// write the header row
|
// write the header row
|
||||||
xmlStreamWriter.writeStartElement("tr");
|
xmlStreamWriter.writeStartElement("tr");
|
||||||
writeSimpleElement(xmlStreamWriter, "th", "Name");
|
writeSimpleElement(xmlStreamWriter, "th", "Name");
|
||||||
writeSimpleElement(xmlStreamWriter, "th", "Default Value");
|
writeSimpleElement(xmlStreamWriter, "th", "Default Value");
|
||||||
writeSimpleElement(xmlStreamWriter, "th", "Valid Values");
|
writeSimpleElement(xmlStreamWriter, "th", "Allowable Values");
|
||||||
writeSimpleElement(xmlStreamWriter, "th", "Description");
|
writeSimpleElement(xmlStreamWriter, "th", "Description");
|
||||||
xmlStreamWriter.writeEndElement();
|
xmlStreamWriter.writeEndElement();
|
||||||
|
|
||||||
|
@ -315,6 +316,7 @@ public class HtmlDocumentationWriter implements DocumentationWriter {
|
||||||
for (PropertyDescriptor property : properties) {
|
for (PropertyDescriptor property : properties) {
|
||||||
xmlStreamWriter.writeStartElement("tr");
|
xmlStreamWriter.writeStartElement("tr");
|
||||||
xmlStreamWriter.writeStartElement("td");
|
xmlStreamWriter.writeStartElement("td");
|
||||||
|
xmlStreamWriter.writeAttribute("id", "name");
|
||||||
if (property.isRequired()) {
|
if (property.isRequired()) {
|
||||||
writeSimpleElement(xmlStreamWriter, "strong", property.getDisplayName());
|
writeSimpleElement(xmlStreamWriter, "strong", property.getDisplayName());
|
||||||
} else {
|
} else {
|
||||||
|
@ -322,11 +324,13 @@ public class HtmlDocumentationWriter implements DocumentationWriter {
|
||||||
}
|
}
|
||||||
|
|
||||||
xmlStreamWriter.writeEndElement();
|
xmlStreamWriter.writeEndElement();
|
||||||
writeSimpleElement(xmlStreamWriter, "td", property.getDefaultValue());
|
writeSimpleElement(xmlStreamWriter, "td", property.getDefaultValue(), false, "default-value");
|
||||||
xmlStreamWriter.writeStartElement("td");
|
xmlStreamWriter.writeStartElement("td");
|
||||||
|
xmlStreamWriter.writeAttribute("id", "allowable-values");
|
||||||
writeValidValues(xmlStreamWriter, property);
|
writeValidValues(xmlStreamWriter, property);
|
||||||
xmlStreamWriter.writeEndElement();
|
xmlStreamWriter.writeEndElement();
|
||||||
xmlStreamWriter.writeStartElement("td");
|
xmlStreamWriter.writeStartElement("td");
|
||||||
|
xmlStreamWriter.writeAttribute("id", "description");
|
||||||
if (property.getDescription() != null && property.getDescription().trim().length() > 0) {
|
if (property.getDescription() != null && property.getDescription().trim().length() > 0) {
|
||||||
xmlStreamWriter.writeCharacters(property.getDescription());
|
xmlStreamWriter.writeCharacters(property.getDescription());
|
||||||
} else {
|
} else {
|
||||||
|
@ -372,6 +376,7 @@ public class HtmlDocumentationWriter implements DocumentationWriter {
|
||||||
xmlStreamWriter
|
xmlStreamWriter
|
||||||
.writeCharacters("Dynamic Properties allow the user to specify both the name and value of a property.");
|
.writeCharacters("Dynamic Properties allow the user to specify both the name and value of a property.");
|
||||||
xmlStreamWriter.writeStartElement("table");
|
xmlStreamWriter.writeStartElement("table");
|
||||||
|
xmlStreamWriter.writeAttribute("id", "dynamic-properties");
|
||||||
xmlStreamWriter.writeStartElement("tr");
|
xmlStreamWriter.writeStartElement("tr");
|
||||||
writeSimpleElement(xmlStreamWriter, "th", "Name");
|
writeSimpleElement(xmlStreamWriter, "th", "Name");
|
||||||
writeSimpleElement(xmlStreamWriter, "th", "Value");
|
writeSimpleElement(xmlStreamWriter, "th", "Value");
|
||||||
|
@ -379,8 +384,8 @@ public class HtmlDocumentationWriter implements DocumentationWriter {
|
||||||
xmlStreamWriter.writeEndElement();
|
xmlStreamWriter.writeEndElement();
|
||||||
for (final DynamicProperty dynamicProperty : dynamicProperties) {
|
for (final DynamicProperty dynamicProperty : dynamicProperties) {
|
||||||
xmlStreamWriter.writeStartElement("tr");
|
xmlStreamWriter.writeStartElement("tr");
|
||||||
writeSimpleElement(xmlStreamWriter, "td", dynamicProperty.name());
|
writeSimpleElement(xmlStreamWriter, "td", dynamicProperty.name(), false, "name");
|
||||||
writeSimpleElement(xmlStreamWriter, "td", dynamicProperty.value());
|
writeSimpleElement(xmlStreamWriter, "td", dynamicProperty.value(), false, "value");
|
||||||
xmlStreamWriter.writeStartElement("td");
|
xmlStreamWriter.writeStartElement("td");
|
||||||
xmlStreamWriter.writeCharacters(dynamicProperty.description());
|
xmlStreamWriter.writeCharacters(dynamicProperty.description());
|
||||||
if (dynamicProperty.supportsExpressionLanguage()) {
|
if (dynamicProperty.supportsExpressionLanguage()) {
|
||||||
|
@ -489,7 +494,26 @@ public class HtmlDocumentationWriter implements DocumentationWriter {
|
||||||
*/
|
*/
|
||||||
protected final static void writeSimpleElement(final XMLStreamWriter writer, final String elementName,
|
protected final static void writeSimpleElement(final XMLStreamWriter writer, final String elementName,
|
||||||
final String characters, boolean strong) throws XMLStreamException {
|
final String characters, boolean strong) throws XMLStreamException {
|
||||||
writer.writeStartElement(elementName);
|
writeSimpleElement(writer, elementName, characters, strong, null);
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Writes a begin element, an id attribute(if specified), then text, then end element for
|
||||||
|
* element of the users choosing. Example: <p id="p-id">text</p>
|
||||||
|
*
|
||||||
|
* @param writer the stream writer to use
|
||||||
|
* @param elementName the name of the element
|
||||||
|
* @param characters the text of the element
|
||||||
|
* @param strong whether to bold the text of the element or not
|
||||||
|
* @param id the id of the element. specifying null will cause no element to be written.
|
||||||
|
* @throws XMLStreamException
|
||||||
|
*/
|
||||||
|
protected final static void writeSimpleElement(final XMLStreamWriter writer, final String elementName,
|
||||||
|
final String characters, boolean strong, String id) throws XMLStreamException {
|
||||||
|
writer.writeStartElement(elementName);
|
||||||
|
if (id != null) {
|
||||||
|
writer.writeAttribute("id", id);
|
||||||
|
}
|
||||||
if (strong) {
|
if (strong) {
|
||||||
writer.writeStartElement("strong");
|
writer.writeStartElement("strong");
|
||||||
}
|
}
|
||||||
|
|
|
@ -83,6 +83,7 @@ public class HtmlProcessorDocumentationWriter extends HtmlDocumentationWriter {
|
||||||
writeSimpleElement(xmlStreamWriter, "h3", "Reads Attributes: ");
|
writeSimpleElement(xmlStreamWriter, "h3", "Reads Attributes: ");
|
||||||
if (attributesRead.size() > 0) {
|
if (attributesRead.size() > 0) {
|
||||||
xmlStreamWriter.writeStartElement("table");
|
xmlStreamWriter.writeStartElement("table");
|
||||||
|
xmlStreamWriter.writeAttribute("id", "reads-attributes");
|
||||||
xmlStreamWriter.writeStartElement("tr");
|
xmlStreamWriter.writeStartElement("tr");
|
||||||
writeSimpleElement(xmlStreamWriter, "th", "Name");
|
writeSimpleElement(xmlStreamWriter, "th", "Name");
|
||||||
writeSimpleElement(xmlStreamWriter, "th", "Description");
|
writeSimpleElement(xmlStreamWriter, "th", "Description");
|
||||||
|
@ -120,6 +121,7 @@ public class HtmlProcessorDocumentationWriter extends HtmlDocumentationWriter {
|
||||||
writeSimpleElement(xmlStreamWriter, "h3", "Writes Attributes: ");
|
writeSimpleElement(xmlStreamWriter, "h3", "Writes Attributes: ");
|
||||||
if (attributesRead.size() > 0) {
|
if (attributesRead.size() > 0) {
|
||||||
xmlStreamWriter.writeStartElement("table");
|
xmlStreamWriter.writeStartElement("table");
|
||||||
|
xmlStreamWriter.writeAttribute("id", "writes-attributes");
|
||||||
xmlStreamWriter.writeStartElement("tr");
|
xmlStreamWriter.writeStartElement("tr");
|
||||||
writeSimpleElement(xmlStreamWriter, "th", "Name");
|
writeSimpleElement(xmlStreamWriter, "th", "Name");
|
||||||
writeSimpleElement(xmlStreamWriter, "th", "Description");
|
writeSimpleElement(xmlStreamWriter, "th", "Description");
|
||||||
|
@ -203,6 +205,7 @@ public class HtmlProcessorDocumentationWriter extends HtmlDocumentationWriter {
|
||||||
|
|
||||||
if (processor.getRelationships().size() > 0) {
|
if (processor.getRelationships().size() > 0) {
|
||||||
xmlStreamWriter.writeStartElement("table");
|
xmlStreamWriter.writeStartElement("table");
|
||||||
|
xmlStreamWriter.writeAttribute("id", "relationships");
|
||||||
xmlStreamWriter.writeStartElement("tr");
|
xmlStreamWriter.writeStartElement("tr");
|
||||||
writeSimpleElement(xmlStreamWriter, "th", "Name");
|
writeSimpleElement(xmlStreamWriter, "th", "Name");
|
||||||
writeSimpleElement(xmlStreamWriter, "th", "Description");
|
writeSimpleElement(xmlStreamWriter, "th", "Description");
|
||||||
|
@ -236,6 +239,7 @@ public class HtmlProcessorDocumentationWriter extends HtmlDocumentationWriter {
|
||||||
xmlStreamWriter.writeStartElement("p");
|
xmlStreamWriter.writeStartElement("p");
|
||||||
xmlStreamWriter.writeCharacters("A Dynamic Relationship may be created based on how the user configures the Processor.");
|
xmlStreamWriter.writeCharacters("A Dynamic Relationship may be created based on how the user configures the Processor.");
|
||||||
xmlStreamWriter.writeStartElement("table");
|
xmlStreamWriter.writeStartElement("table");
|
||||||
|
xmlStreamWriter.writeAttribute("id", "dynamic-relationships");
|
||||||
xmlStreamWriter.writeStartElement("tr");
|
xmlStreamWriter.writeStartElement("tr");
|
||||||
writeSimpleElement(xmlStreamWriter, "th", "Name");
|
writeSimpleElement(xmlStreamWriter, "th", "Name");
|
||||||
writeSimpleElement(xmlStreamWriter, "th", "Description");
|
writeSimpleElement(xmlStreamWriter, "th", "Description");
|
||||||
|
|
|
@ -113,6 +113,10 @@ table tr:last-child td:last-child {
|
||||||
border-bottom-right-radius:3px;
|
border-bottom-right-radius:3px;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
td#allowable-values, td#default-value, td#name, td#value {
|
||||||
|
white-space:nowrap;
|
||||||
|
}
|
||||||
|
|
||||||
/* links */
|
/* links */
|
||||||
|
|
||||||
a, a:link, a:visited {
|
a, a:link, a:visited {
|
||||||
|
|
Loading…
Reference in New Issue