Class AbstractMongoDbCollectionUpdate
- java.lang.Object
-
- adams.core.logging.LoggingObject
-
- adams.core.logging.CustomLoggingLevelObject
-
- adams.core.option.AbstractOptionHandler
-
- adams.flow.transformer.mongodbcollectionupdate.AbstractMongoDbCollectionUpdate
-
- 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
- Direct Known Subclasses:
AddDocument
,Drop
,PassThrough
,RemoveDocument
public abstract class AbstractMongoDbCollectionUpdate extends adams.core.option.AbstractOptionHandler implements MongoDbCollectionUpdate
Ancestor for MongoDB collection update schemes.- Author:
- FracPete (fracpete at waikato dot ac dot nz)
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected adams.flow.core.Actor
m_FlowContext
the context.
-
Constructor Summary
Constructors Constructor Description AbstractMongoDbCollectionUpdate()
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected String
check(com.mongodb.client.MongoCollection coll)
Hook method for checking the collection before updating it.protected abstract String
doUpdate(com.mongodb.client.MongoCollection coll)
Updates the collection.adams.flow.core.Actor
getFlowContext()
Returns the context.String
getQuickInfo()
Returns a quick info about the object, which can be displayed in the GUI.void
setFlowContext(adams.flow.core.Actor value)
Sets the context.String
update(com.mongodb.client.MongoCollection coll)
Updates the collection.-
Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, defineOptions, 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
-
-
-
-
Method Detail
-
setFlowContext
public void setFlowContext(adams.flow.core.Actor value)
Sets the context.- Specified by:
setFlowContext
in interfaceadams.flow.core.FlowContextHandler
- Parameters:
value
- the context
-
getFlowContext
public adams.flow.core.Actor getFlowContext()
Returns the context.- Specified by:
getFlowContext
in interfaceadams.flow.core.FlowContextHandler
- Returns:
- the context, null if none set
-
getQuickInfo
public String getQuickInfo()
Returns a quick info about the object, which can be displayed in the GUI.
Default implementation returns null.- Specified by:
getQuickInfo
in interfaceadams.core.QuickInfoSupporter
- Returns:
- null if no info available, otherwise short string
-
check
protected String check(com.mongodb.client.MongoCollection coll)
Hook method for checking the collection before updating it.- Parameters:
coll
- the collection to check- Returns:
- null if successful, otherwise error message
-
doUpdate
protected abstract String doUpdate(com.mongodb.client.MongoCollection coll)
Updates the collection.- Parameters:
coll
- the collection to update- Returns:
- null if successful, otherwise the error message
-
update
public String update(com.mongodb.client.MongoCollection coll)
Updates the collection.- Specified by:
update
in interfaceMongoDbCollectionUpdate
- Parameters:
coll
- the collection to update- Returns:
- null if successful, otherwise the error message
-
-