com.northconcepts.datapipeline.multiplex.SplitWriter

public class SplitWriter extends DataWriter

Converts a single source DataReader into many downstream sources using one of the provided strategies.

Nested Class Summary

Nested Classes

Modifier and Type

Class

Description

static interface

SplitWriter.IStrategy

Strategy for distributing the records written to a SplitWriter among the readers it created.

static enum

SplitWriter.Strategy

The built-in strategies: send every record to all readers or each record to one reader in turn.

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

Fields

Modifier and Type

Field

Description

static final int

DEFAULT_QUEUE_SIZE

protected static final Record

EOF

static final Logger

log

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, name, TIMESTAMP_FORMAT
Constructor Summary

Constructors

Constructor

Description

SplitWriter()

Creates a splitter using the SplitWriter.Strategy.BROADCAST strategy.

SplitWriter(SplitWriter.IStrategy strategy)
Method Summary

Modifier and Type

Method

Description

void

close()

Indicates that this endpoint has finished reading or writing.

DataReader

createReader()

Creates a reader that receives the written records according to the strategy; create all readers before writing so none miss records.

int

getQueueSize()

Retrieves the buffer size for downstream readers of this splitter (default is 100 records).

SplitWriter.IStrategy

getStrategy()

List<SplitReader>

getTargets()

Returns the readers created by createReader(), which receive the records written to this splitter.

void

open()

Makes this endpoint ready for reading or writing.

void

removeClosedTargets()

Drops closed readers from getTargets(); the round-robin strategy calls it when it reaches a closed reader.

SplitWriter

setQueueSize(int queueSize)

Sets the buffer size for downstream readers of this splitter (default is 100 records).

protected void

writeImpl(Record record)

Overridden by subclasses to write the specified record to this DataWriter.

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

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

Field Details
- log
  
  public static final Logger log
- DEFAULT_QUEUE_SIZE
  
  public static final int DEFAULT_QUEUE_SIZE
  See Also:
  
  Constant Field Values
- EOF
  
  protected static final Record EOF
Constructor Details
- SplitWriter
  
  public SplitWriter(SplitWriter.IStrategy strategy)
- SplitWriter
  
  public SplitWriter()
  
  Creates a splitter using the SplitWriter.Strategy.BROADCAST strategy.
Method Details
- getStrategy
  
  public SplitWriter.IStrategy getStrategy()
- getTargets
  
  public List<SplitReader> getTargets()
  
  Returns the readers created by createReader(), which receive the records written to this splitter.
- getQueueSize
  
  public int getQueueSize()
  
  Retrieves the buffer size for downstream readers of this splitter (default is 100 records).
- setQueueSize
  
  public SplitWriter setQueueSize(int queueSize)
  
  Sets the buffer size for downstream readers of this splitter (default is 100 records).
- createReader
  
  public DataReader createReader()
  
  Creates a reader that receives the written records according to the strategy; create all readers before writing so none miss records. The reader's queue size is fixed at creation, so call setQueueSize(int) first.
- writeImpl
  
  protected void writeImpl(Record record) throws Throwable
  
  Description copied from class: DataWriter
  Overridden by subclasses to write the specified record to this DataWriter.
  Contract for subclasses (see also docs/authoring/DataWriter.md):
  
  Do not call this method directly — DataWriter.write(Record) is the template method that wraps exceptions, increments the record count, and attaches the offending record to thrown DataExceptions.
  
  Do not call DataEndpoint.incrementRecordCount() here; DataWriter.write(Record) already does.
  
  Throw raw exceptions; DataWriter.write(Record) wraps them via exception(throwable).setRecord(record).
  Specified by:
  
  writeImpl in class DataWriter
  
  Throws:
  
  Throwable
- open
  
  public void open() throws DataException
  
  Description copied from class: DataEndpoint
  
  Makes this endpoint ready for reading or writing.
  
  Overrides:
  
  open in class DataEndpoint
  
  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 DataEndpoint
  
  Throws:
  
  DataException
- removeClosedTargets
  
  public void removeClosedTargets()
  
  Drops closed readers from getTargets(); the round-robin strategy calls it when it reaches a closed reader.

Class SplitWriter

Nested Class Summary

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

Field Summary

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.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

Field Details

log

DEFAULT_QUEUE_SIZE

EOF

Constructor Details

SplitWriter

SplitWriter

Method Details

getStrategy

getTargets

getQueueSize

setQueueSize

createReader

writeImpl

open

close

removeClosedTargets