com.northconcepts.datapipeline.microsoft.word.MicrosoftWordWriter

public class MicrosoftWordWriter extends BinaryWriter

Writes records to a Microsoft Word (OOXML .docx) document stream containing a single table.

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static enum

MicrosoftWordWriter.PageOrientation

The page orientations available to a Word document.

static enum

MicrosoftWordWriter.PageSize

The page sizes available to a Word document, with their portrait dimensions in twips (1/1440 of an inch).

Nested classes/interfaces inherited from class com.northconcepts.datapipeline.core.DataEndpoint
DataEndpoint.State
Field Summary

Fields inherited from class com.northconcepts.datapipeline.core.AbstractWriter
currentRecord

Fields inherited from class com.northconcepts.datapipeline.core.DataEndpoint
lastRecord, PRODUCT, PRODUCT_VERSION, VENDOR, XML_INPUT_FACTORY_KEY

Fields inherited from class com.northconcepts.datapipeline.core.Endpoint
BUFFER_SIZE, captureElapsedTime, DEFAULT_READ_BUFFER_SIZE

Fields inherited from class com.northconcepts.datapipeline.core.DataObject
id, log, name, TIMESTAMP_FORMAT
Constructor Summary

Constructors

Constructor

Description

MicrosoftWordWriter(File file)

MicrosoftWordWriter(OutputStream outputStream)
Method Summary

Modifier and Type

Method

Description

DataException

addExceptionProperties(DataException exception)

Adds this endpoint's current state to a DataException.

void

close()

Indicates that this endpoint has finished reading or writing.

MicrosoftWordWriter.PageOrientation

getPageOrientation()

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

MicrosoftWordWriter.PageSize

getPageSize()

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

void

open()

Makes this endpoint ready for reading or writing.

MicrosoftWordWriter

setPageOrientation(MicrosoftWordWriter.PageOrientation pageOrientation)

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

MicrosoftWordWriter

setPageSize(MicrosoftWordWriter.PageSize pageSize)

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

protected void

writeRecord(Record record)

Writes one row; called first for the header row (see AbstractWriter.isHeaderRow()) when field names are written, then for each record.

Methods inherited from class com.northconcepts.datapipeline.core.BinaryWriter
getOutputStream

Methods inherited from class com.northconcepts.datapipeline.core.AbstractWriter
createHeaderRecord, isFieldNamesInFirstRow, isHeaderRow, setFieldNamesInFirstRow, write, writeImpl

Methods inherited from class com.northconcepts.datapipeline.core.DataWriter
available, getNestedEndpoint, getNestedWriter, getRootEndpoint, getRootWriter, getWriter

Methods inherited from class com.northconcepts.datapipeline.core.DataEndpoint
decrementRecordCount, enableJmx, getLastRecord, getRecordCount, getRecordCountAsBigInteger, getRecordCountAsString, incrementRecordCount, isRecordCountBigInteger, resetRecordCount, toString

Methods inherited from class com.northconcepts.datapipeline.core.Endpoint
addElapsedtime, assertClosed, assertNotOpened, assertOpened, finalize, getClosedOn, getDescription, getElapsedTime, getElapsedTimeAsString, getOpenedOn, getOpenElapsedTime, getOpenElapsedTimeAsString, getSelfTime, getSelfTimeAsString, getState, isCaptureElapsedTime, isClosed, isOpen, setCaptureElapsedTime, setDescription

Methods inherited from class com.northconcepts.datapipeline.core.DataObject
exception, exception, exception, getId, getName, resetID

Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details
- MicrosoftWordWriter
  
  public MicrosoftWordWriter(File file)
- MicrosoftWordWriter
  
  public MicrosoftWordWriter(OutputStream outputStream)
Method Details
- open
  
  public void open() throws DataException
  
  Description copied from class: DataEndpoint
  
  Makes this endpoint ready for reading or writing.
  
  Overrides:
  
  open in class AbstractWriter
  
  Throws:
  
  DataException
- close
  
  public void close() throws DataException
  
  Description copied from class: DataEndpoint
  
  Indicates that this endpoint has finished reading or writing.
  
  Overrides:
  
  close in class BinaryWriter
  
  Throws:
  
  DataException
- writeRecord
  
  protected void writeRecord(Record record) throws Throwable
  
  Description copied from class: AbstractWriter
  
  Writes one row; called first for the header row (see AbstractWriter.isHeaderRow()) when field names are written, then for each record.
  
  Specified by:
  
  writeRecord in class AbstractWriter
  
  Throws:
  
  Throwable
- getPageSize
  
  public MicrosoftWordWriter.PageSize getPageSize()
  
  Returns the page size for the Word document (default MicrosoftWordWriter.PageSize.LETTER).
- setPageSize
  
  public MicrosoftWordWriter 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 MicrosoftWordWriter setPageOrientation(MicrosoftWordWriter.PageOrientation pageOrientation)
  
  Specifies the page orientation for the Word document (default MicrosoftWordWriter.PageOrientation.PORTRAIT).
- addExceptionProperties
  
  public DataException addExceptionProperties(DataException exception)
  
  Description copied from class: Endpoint
  
  Adds this endpoint's current state to a DataException. Since this method is called whenever an exception is thrown, subclasses should override it to add their specific information.
  
  Overrides:
  
  addExceptionProperties in class BinaryWriter

Class MicrosoftWordWriter

Nested Class Summary

Nested classes/interfaces inherited from class com.northconcepts.datapipeline.core.DataEndpoint

Field Summary

Fields inherited from class com.northconcepts.datapipeline.core.AbstractWriter

Fields inherited from class com.northconcepts.datapipeline.core.DataEndpoint

Fields inherited from class com.northconcepts.datapipeline.core.Endpoint

Fields inherited from class com.northconcepts.datapipeline.core.DataObject

Constructor Summary

Method Summary

Methods inherited from class com.northconcepts.datapipeline.core.BinaryWriter

Methods inherited from class com.northconcepts.datapipeline.core.AbstractWriter

Methods inherited from class com.northconcepts.datapipeline.core.DataWriter

Methods inherited from class com.northconcepts.datapipeline.core.DataEndpoint

Methods inherited from class com.northconcepts.datapipeline.core.Endpoint

Methods inherited from class com.northconcepts.datapipeline.core.DataObject

Methods inherited from class java.lang.Object

Constructor Details

MicrosoftWordWriter

MicrosoftWordWriter

Method Details

open

close

writeRecord

getPageSize

setPageSize

getPageOrientation

setPageOrientation

addExceptionProperties