Class MicrosoftWordPipelineOutput

Method Details

• getName

  public String getName()

  Description copied from class: PipelineOutput

  Returns a display name for this output, such as the destination's name followed by its format.

  Overrides:

  getName in class FileSinkPipelineOutput

• getFileSink

  public FileSink getFileSink()

  Specified by:

  getFileSink in class FileSinkPipelineOutput

• setFileSink

  public MicrosoftWordPipelineOutput setFileSink(FileSink fileSink)

  Specified by:

  setFileSink in class FileSinkPipelineOutput

• createDataWriter

  public DataWriter createDataWriter()

• getPageSize

  public MicrosoftWordWriter.PageSize getPageSize()

  Returns the page size for the Word document (default MicrosoftWordWriter.PageSize.LETTER).

• setPageSize

  public MicrosoftWordPipelineOutput setPageSize(MicrosoftWordWriter.PageSize pageSize)

  Specifies the page size for the Word document (default MicrosoftWordWriter.PageSize.LETTER).

• getPageOrientation

  public MicrosoftWordWriter.PageOrientation getPageOrientation()

  Returns the page orientation for the Word document (default MicrosoftWordWriter.PageOrientation.PORTRAIT).

• setPageOrientation

  public MicrosoftWordPipelineOutput setPageOrientation(MicrosoftWordWriter.PageOrientation pageOrientation)

  Specifies the page orientation for the Word document (default MicrosoftWordWriter.PageOrientation.PORTRAIT).

• isFieldNamesInFirstRow

  public boolean isFieldNamesInFirstRow()

  Returns whether field names are written as the first row (default true).

• setFieldNamesInFirstRow

  public MicrosoftWordPipelineOutput setFieldNamesInFirstRow(boolean fieldNamesInFirstRow)

  Specifies whether field names are written as the first row (default true).

• generateJavaCode

  public void generateJavaCode(JavaCodeBuilder code)

  Description copied from interface: JavaCodeGenerator

  Appends Java source code representing this object to the given builder.

• fromRecord

  public MicrosoftWordPipelineOutput fromRecord(Record source)

  Description copied from interface: RecordSerializable

  Loads this instance's state from a record and returns this (for fluid API call chaining). For fluid API call chaining, the overridden method should change the declared return type to its class.

  Specified by:

  fromRecord in interface RecordSerializable

  Overrides:

  fromRecord in class PipelineOutput

  Parameters:

  source -

  Returns:

  this instance.

• toRecord

  public Record toRecord()

  Description copied from interface: RecordSerializable

  Converts this object's state to a record that RecordSerializable.fromRecord(Record) can load.

  Specified by:

  toRecord in interface RecordSerializable

  Overrides:

  toRecord in class Bean

• toXmlElement

  public Element toXmlElement(Document document)

  Description copied from interface: XmlSerializable

  Returns an element, created with document, describing this object; the default implementation throws a DataException.

  Specified by:

  toXmlElement in interface XmlSerializable

  Overrides:

  toXmlElement in class PipelineOutput

• fromXmlElement

  public XmlSerializable fromXmlElement(Element pipelineOutputElement)