Package adams.flow.transformer.mongodbcollectionupdate

Interface MongoDbCollectionUpdate

  • All Superinterfaces:
    adams.core.Destroyable, adams.flow.core.FlowContextHandler, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter
    All Known Implementing Classes:
    AbstractMongoDbCollectionUpdate, AddDocument, Drop, PassThrough, RemoveDocument
    public interface MongoDbCollectionUpdate
extends adams.core.option.OptionHandler, adams.flow.core.FlowContextHandler, adams.core.QuickInfoSupporter
    Interface for MongoDB collection update schemes.
    Author:
    FracPete (fracpete at waikato dot ac dot nz)

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String update​(com.mongodb.client.MongoCollection coll)
      Updates the collection.

      • Methods inherited from interface adams.core.Destroyable

        destroy

      • Methods inherited from interface adams.flow.core.FlowContextHandler

        getFlowContext, setFlowContext

      • Methods inherited from interface adams.core.option.OptionHandler

        cleanUpOptions, defineOptions, getOptionManager, toCommandLine

      • Methods inherited from interface adams.core.QuickInfoSupporter

        getQuickInfo

    • Method Detail

      • update

        String update​(com.mongodb.client.MongoCollection coll)
        Updates the collection.
        Parameters:
        coll - the collection to update
        Returns:
        null if successful, otherwise the error message