Package adams.flow.transformer.mongodbdocumentupdate

Class AppendStorage

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.flow.transformer.mongodbdocumentupdate.AbstractMongoDbDocumentUpdate

adams.flow.transformer.mongodbdocumentupdate.AppendStorage

All Implemented Interfaces:

adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter, adams.core.SizeOfHandler, adams.flow.core.FlowContextHandler, MongoDbDocumentAppend, MongoDbDocumentUpdate, Serializable

public class AppendStorage
extends AbstractMongoDbDocumentUpdate
implements MongoDbDocumentAppend

Appends the document with the specified key-value pairs from storage.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected adams.core.base.BaseKeyValuePair[]	m_KeyValuePairs	the key-value pairs to add.
protected adams.data.conversion.Conversion	m_ValueConversion	the storage item conversion.

Fields inherited from class adams.flow.transformer.mongodbdocumentupdate.AbstractMongoDbDocumentUpdate

m_FlowContext

Fields inherited from class adams.core.option.AbstractOptionHandler

m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject

m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors

Constructor	Description
AppendStorage()

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected String	doUpdate(com.mongodb.client.MongoCollection coll, org.bson.Document doc)	Updates the document.
adams.core.base.BaseKeyValuePair[]	getKeyValuePairs()	Returns the key-value pairs to add.
adams.data.conversion.Conversion	getValueConversion()	Returns the conversion for turning the storage value into the actual type.
String	globalInfo()	Returns a string describing the object.
String	keyValuePairsTipText()	Returns the tip text for this property.
void	setKeyValuePairs(adams.core.base.BaseKeyValuePair[] value)	Sets the key-value pairs to add.
void	setValueConversion(adams.data.conversion.Conversion value)	Sets the conversion for turning the storage value into the actual type.
String	valueConversionTipText()	Returns the tip text for this property.

Methods inherited from class adams.flow.transformer.mongodbdocumentupdate.AbstractMongoDbDocumentUpdate

check, getFlowContext, getQuickInfo, setFlowContext, update

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject

configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object

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

Methods inherited from interface adams.core.Destroyable

destroy

Methods inherited from interface adams.flow.core.FlowContextHandler

getFlowContext, setFlowContext

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.flow.transformer.mongodbdocumentupdate.MongoDbDocumentUpdate

update

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Methods inherited from interface adams.core.QuickInfoSupporter

getQuickInfo

Field Detail

m_KeyValuePairs

protected adams.core.base.BaseKeyValuePair[] m_KeyValuePairs

the key-value pairs to add.

m_ValueConversion

protected adams.data.conversion.Conversion m_ValueConversion

the storage item conversion.

Constructor Detail

AppendStorage

public AppendStorage()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface adams.core.GlobalInfoSupporter

Specified by:

globalInfo in class adams.core.option.AbstractOptionHandler

Returns:

a description suitable for displaying in the gui

defineOptions

public void defineOptions()

Adds options to the internal list of options.

Specified by:

defineOptions in interface adams.core.option.OptionHandler

Overrides:

defineOptions in class adams.core.option.AbstractOptionHandler

setKeyValuePairs

public void setKeyValuePairs(adams.core.base.BaseKeyValuePair[] value)

Sets the key-value pairs to add.

Parameters:

value - the pairs

getKeyValuePairs

public adams.core.base.BaseKeyValuePair[] getKeyValuePairs()

Returns the key-value pairs to add.

Returns:

the pairs

keyValuePairsTipText

public String keyValuePairsTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setValueConversion

public void setValueConversion(adams.data.conversion.Conversion value)

Sets the conversion for turning the storage value into the actual type.

Parameters:

value - the conversion

getValueConversion

public adams.data.conversion.Conversion getValueConversion()

Returns the conversion for turning the storage value into the actual type.

Returns:

the conversion

valueConversionTipText

public String valueConversionTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

doUpdate

protected String doUpdate(com.mongodb.client.MongoCollection coll,
                          org.bson.Document doc)

Updates the document.

Specified by:

doUpdate in class AbstractMongoDbDocumentUpdate

Parameters:

doc - the document to update

coll - the collection the document belongs to

Returns:

null if successful, otherwise the error message