Class AbstractAppend
- java.lang.Object
-
- adams.core.logging.LoggingObject
-
- adams.core.logging.CustomLoggingLevelObject
-
- adams.core.option.AbstractOptionHandler
-
- adams.flow.transformer.mongodbdocumentupdate.AbstractMongoDbDocumentUpdate
-
- adams.flow.transformer.mongodbdocumentupdate.AbstractAppend
-
- 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
- Direct Known Subclasses:
Append
,AppendVariables
public abstract class AbstractAppend extends AbstractMongoDbDocumentUpdate implements MongoDbDocumentAppend
Appends the document with the specified key-value pairs.- 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.ConversionFromString
m_ValueConversion
the value conversion.-
Fields inherited from class adams.flow.transformer.mongodbdocumentupdate.AbstractMongoDbDocumentUpdate
m_FlowContext
-
-
Constructor Summary
Constructors Constructor Description AbstractAppend()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods 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.protected abstract Object
getActualValue(String value)
Returns the actual value.protected abstract adams.data.conversion.ConversionFromString
getDefaultValueConversion()
Returns the default conversion.adams.core.base.BaseKeyValuePair[]
getKeyValuePairs()
Returns the key-value pairs to add.adams.data.conversion.ConversionFromString
getValueConversion()
Returns the conversion for turning the value string into the actual type.abstract 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.ConversionFromString value)
Sets the conversion for turning the value string into the actual type.abstract 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, globalInfo, 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.flow.transformer.mongodbdocumentupdate.MongoDbDocumentUpdate
update
-
-
-
-
Method Detail
-
defineOptions
public void defineOptions()
Adds options to the internal list of options.- Specified by:
defineOptions
in interfaceadams.core.option.OptionHandler
- Overrides:
defineOptions
in classadams.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 abstract 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.
-
getDefaultValueConversion
protected abstract adams.data.conversion.ConversionFromString getDefaultValueConversion()
Returns the default conversion.- Returns:
- the default
-
setValueConversion
public void setValueConversion(adams.data.conversion.ConversionFromString value)
Sets the conversion for turning the value string into the actual type.- Parameters:
value
- the conversion
-
getValueConversion
public adams.data.conversion.ConversionFromString getValueConversion()
Returns the conversion for turning the value string into the actual type.- Returns:
- the conversion
-
valueConversionTipText
public abstract 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.
-
getActualValue
protected abstract Object getActualValue(String value)
Returns the actual value.- Parameters:
value
- the value to turn into the actual value- Returns:
- the actual value
-
doUpdate
protected String doUpdate(com.mongodb.client.MongoCollection coll, org.bson.Document doc)
Updates the document.- Specified by:
doUpdate
in classAbstractMongoDbDocumentUpdate
- Parameters:
doc
- the document to updatecoll
- the collection the document belongs to- Returns:
- null if successful, otherwise the error message
-
-