Class AddDocument
- java.lang.Object
-
- adams.core.logging.LoggingObject
-
- adams.core.logging.CustomLoggingLevelObject
-
- adams.core.option.AbstractOptionHandler
-
- adams.flow.transformer.mongodbcollectionupdate.AbstractMongoDbCollectionUpdate
-
- adams.flow.transformer.mongodbcollectionupdate.AddDocument
-
- 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
,MongoDbCollectionUpdate
,Serializable
public class AddDocument extends AbstractMongoDbCollectionUpdate
Adds a document.- Author:
- FracPete (fracpete at waikato dot ac dot nz)
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected String
m_ID
the ID for the document.protected MongoDbDocumentAppend[]
m_Updates
for appending key-value pairs.-
Fields inherited from class adams.flow.transformer.mongodbcollectionupdate.AbstractMongoDbCollectionUpdate
m_FlowContext
-
-
Constructor Summary
Constructors Constructor Description AddDocument()
-
Method Summary
All Methods Instance 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)
Updates the collection.String
getID()
Returns the ID to use for the document.String
getQuickInfo()
Returns a quick info about the actor, which will be displayed in the GUI.MongoDbDocumentAppend[]
getUpdates()
Returns the document updaters to apply.String
globalInfo()
Returns a string describing the object.String
IDTipText()
Returns the tip text for this property.void
setID(String value)
Sets the ID to use for the document.void
setUpdates(MongoDbDocumentAppend[] value)
Sets the document updaters to apply.String
updatesTipText()
Returns the tip text for this property.-
Methods inherited from class adams.flow.transformer.mongodbcollectionupdate.AbstractMongoDbCollectionUpdate
check, getFlowContext, 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
-
-
-
-
Field Detail
-
m_ID
protected String m_ID
the ID for the document.
-
m_Updates
protected MongoDbDocumentAppend[] m_Updates
for appending key-value pairs.
-
-
Method Detail
-
globalInfo
public String globalInfo()
Returns a string describing the object.- Specified by:
globalInfo
in interfaceadams.core.GlobalInfoSupporter
- Specified by:
globalInfo
in classadams.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 interfaceadams.core.option.OptionHandler
- Overrides:
defineOptions
in classadams.core.option.AbstractOptionHandler
-
getQuickInfo
public String getQuickInfo()
Returns a quick info about the actor, which will be displayed in the GUI.- Specified by:
getQuickInfo
in interfaceadams.core.QuickInfoSupporter
- Overrides:
getQuickInfo
in classAbstractMongoDbCollectionUpdate
- Returns:
- null if no info available, otherwise short string
-
setID
public void setID(String value)
Sets the ID to use for the document.- Parameters:
value
- the ID, empty for automatically created one
-
getID
public String getID()
Returns the ID to use for the document.- Returns:
- the ID, empty for automatically created one
-
IDTipText
public String IDTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setUpdates
public void setUpdates(MongoDbDocumentAppend[] value)
Sets the document updaters to apply.- Parameters:
value
- the updaters
-
getUpdates
public MongoDbDocumentAppend[] getUpdates()
Returns the document updaters to apply.- Returns:
- the updaters
-
updatesTipText
public String updatesTipText()
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)
Updates the collection.- Specified by:
doUpdate
in classAbstractMongoDbCollectionUpdate
- Parameters:
coll
- the collection to update- Returns:
- null if successful, otherwise the error message
-
-