com.northconcepts.datapipeline.mongodb

Class MongoWriter

java.lang.Object

com.northconcepts.datapipeline.core.DataObject

com.northconcepts.datapipeline.core.Endpoint

com.northconcepts.datapipeline.core.DataEndpoint

com.northconcepts.datapipeline.core.DataWriter

com.northconcepts.datapipeline.internal.lang.IntegrationWriter

com.northconcepts.datapipeline.mongodb.MongoWriter

public class MongoWriter
extends IntegrationWriter

Writes records to a MongoDB database collection.

Nested Class Summary

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

DataEndpoint.State

Field Summary

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 and Description
MongoWriter(MongoClient client, String database, String collection) Connects to the MongoDB server as specified in MongoClient.
MongoWriter(String database, String collection) Connects to the MongoDB server in localhost on the default port 27017.

Method Summary

Modifier and Type	Method and 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.
int	getBatchSize()
boolean	isAutoCloseConnection() Indicates if the MongoDB client should be closed when this writer closes (defaults to false).
boolean	isBatchMode()
void	open() Makes this endpoint ready for reading or writing.
MongoWriter	setAutoCloseConnection(boolean closeConnection) Indicates if the MongoDB client should be closed when this writer closes (defaults to false).
MongoWriter	setBatchSize(int size) Sets the number of records to chunk together in batch updates.
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

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

Constructor Detail

MongoWriter

public MongoWriter(String database,
                   String collection)

Connects to the MongoDB server in localhost on the default port 27017.

Parameters:

database - name of the database to be used.

collection - name of the collection to be used.

MongoWriter

public MongoWriter(MongoClient client,
                   String database,
                   String collection)

Connects to the MongoDB server as specified in MongoClient. Use this to connect to non-default host and port.

Parameters:

client - the MongoClient instance.

database - name of the database to be used.

collection - name of the collection to be used.

Method Detail

setBatchSize

public MongoWriter setBatchSize(int size)

Sets the number of records to chunk together in batch updates. Updates are not batched if this value is 1 or less. MongoWriter defaults to non batching updates.

Parameters:

size - the number of records to chunk together.

getBatchSize

public int getBatchSize()

isBatchMode

public boolean isBatchMode()

writeImpl

protected void writeImpl(Record record)
                  throws Throwable

Description copied from class: DataWriter

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

Specified by:

writeImpl in class DataWriter

Throws:

Throwable

isAutoCloseConnection

public boolean isAutoCloseConnection()

Indicates if the MongoDB client should be closed when this writer closes (defaults to false).

setAutoCloseConnection

public MongoWriter setAutoCloseConnection(boolean closeConnection)

Indicates if the MongoDB client should be closed when this writer closes (defaults to false).

open

public void open()
          throws DataException

Description copied from class: DataEndpoint

Makes this endpoint ready for reading or writing.

Overrides:

open in class IntegrationWriter

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

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 DataWriter