Package org.apache.nifi.documentation.html

Class HtmlProcessorDocumentationWriter

java.lang.Object

org.apache.nifi.documentation.html.HtmlDocumentationWriter

org.apache.nifi.documentation.html.HtmlProcessorDocumentationWriter

All Implemented Interfaces:

DocumentationWriter

public class HtmlProcessorDocumentationWriter
extends HtmlDocumentationWriter

Writes documentation specific for a Processor. This includes everything for a ConfigurableComponent as well as Relationship information.

Field Summary

Fields inherited from class org.apache.nifi.documentation.html.HtmlDocumentationWriter

ADDITIONAL_DETAILS_HTML, LOGGER

Constructor Summary

Constructors

Constructor	Description
HtmlProcessorDocumentationWriter(ExtensionManager extensionManager)

Method Summary

Modifier and Type	Method	Description
private String	defaultIfBlank(String test, String defaultValue)
private List<DynamicRelationship>	getDynamicRelationships(Processor processor)
private List<ReadsAttribute>	getReadsAttributes(Processor processor)	Collects the attributes that a processor is reading from.
private List<WritesAttribute>	getWritesAttributes(Processor processor)	Collects the attributes that a processor is writing to.
private void	handleReadsAttributes(XMLStreamWriter xmlStreamWriter, Processor processor)	Writes out just the attributes that are being read in a table form.
private void	handleWritesAttributes(XMLStreamWriter xmlStreamWriter, Processor processor)	Writes out just the attributes that are being written to in a table form.
protected void	writeAdditionalBodyInfo(ConfigurableComponent configurableComponent, XMLStreamWriter xmlStreamWriter)	This method may be overridden by sub classes to write additional information to the body of the documentation.
private void	writeAttributeInfo(Processor processor, XMLStreamWriter xmlStreamWriter)	Writes all the attributes that a processor says it reads and writes
private void	writeDynamicRelationships(Processor processor, XMLStreamWriter xmlStreamWriter)
private void	writeRelationships(Processor processor, XMLStreamWriter xmlStreamWriter)	Writes a table describing the relations a processor has.

Methods inherited from class org.apache.nifi.documentation.html.HtmlDocumentationWriter

getDescription, getTitle, iterateAndLinkComponents, join, write, writeDescription, writeHead, writeLink, writeMultiComponentUseCases, writeProperties, writeSimpleElement, writeSimpleElement, writeUseCases, writeValidValues

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

HtmlProcessorDocumentationWriter

public HtmlProcessorDocumentationWriter(ExtensionManager extensionManager)

Method Details

writeAdditionalBodyInfo

protected void writeAdditionalBodyInfo(ConfigurableComponent configurableComponent,
 XMLStreamWriter xmlStreamWriter)
                                throws XMLStreamException

Description copied from class: HtmlDocumentationWriter

This method may be overridden by sub classes to write additional information to the body of the documentation.

Overrides:

writeAdditionalBodyInfo in class HtmlDocumentationWriter

Parameters:

configurableComponent - the component to describe

xmlStreamWriter - the stream writer

Throws:

XMLStreamException - thrown if there was a problem writing to the XML stream

writeAttributeInfo

private void writeAttributeInfo(Processor processor,
 XMLStreamWriter xmlStreamWriter)
                         throws XMLStreamException

Writes all the attributes that a processor says it reads and writes

Parameters:

processor - the processor to describe

xmlStreamWriter - the xml stream writer to use

Throws:

XMLStreamException - thrown if there was a problem writing the XML

defaultIfBlank

private String defaultIfBlank(String test,
 String defaultValue)

handleReadsAttributes

private void handleReadsAttributes(XMLStreamWriter xmlStreamWriter,
 Processor processor)
                            throws XMLStreamException

Writes out just the attributes that are being read in a table form.

Parameters:

xmlStreamWriter - the xml stream writer to use

processor - the processor to describe

Throws:

XMLStreamException - xse

handleWritesAttributes

private void handleWritesAttributes(XMLStreamWriter xmlStreamWriter,
 Processor processor)
                             throws XMLStreamException

Writes out just the attributes that are being written to in a table form.

Parameters:

xmlStreamWriter - the xml stream writer to use

processor - the processor to describe

Throws:

XMLStreamException - xse

getReadsAttributes

private List<ReadsAttribute> getReadsAttributes(Processor processor)

Collects the attributes that a processor is reading from.

Parameters:

processor - the processor to describe

Returns:

the list of attributes that processor is reading

getWritesAttributes

private List<WritesAttribute> getWritesAttributes(Processor processor)

Collects the attributes that a processor is writing to.

Parameters:

processor - the processor to describe

Returns:

the list of attributes the processor is writing

writeRelationships

private void writeRelationships(Processor processor,
 XMLStreamWriter xmlStreamWriter)
                         throws XMLStreamException

Writes a table describing the relations a processor has.

Parameters:

processor - the processor to describe

xmlStreamWriter - the stream writer to use

Throws:

XMLStreamException - thrown if there was a problem writing the xml

writeDynamicRelationships

private void writeDynamicRelationships(Processor processor,
 XMLStreamWriter xmlStreamWriter)
                                throws XMLStreamException

Throws:

XMLStreamException

getDynamicRelationships

private List<DynamicRelationship> getDynamicRelationships(Processor processor)