Package adams.flow.transformer.mongodbdocumentupdate

Class Remove

  • 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, MongoDbDocumentUpdate, Serializable
    public class Remove
extends AbstractMongoDbDocumentUpdate
    Removes the specified keys from the document.
    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.BaseString[] m_Keys
      the keys to remove.

      • 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
      Remove()  

    • 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, org.bson.Document doc)
      Updates the document.
      adams.core.base.BaseString[] getKeys()
      Returns the keys to remove.
      String globalInfo()
      Returns a string describing the object.
      String keysTipText()
      Returns the tip text for this property.
      void setKeys​(adams.core.base.BaseString[] value)
      Sets the keys to remove.

      • 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 interface adams.core.Destroyable

        destroy

      • Methods inherited from interface adams.core.logging.LoggingLevelHandler

        getLoggingLevel

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

        cleanUpOptions, getOptionManager, toCommandLine

    • Field Detail

      • m_Keys

        protected adams.core.base.BaseString[] m_Keys
        the keys to remove.

    • Constructor Detail

      • Remove

        public Remove()

    • 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

      • setKeys

        public void setKeys​(adams.core.base.BaseString[] value)
        Sets the keys to remove.
        Parameters:
        value - the keys

      • getKeys

        public adams.core.base.BaseString[] getKeys()
        Returns the keys to remove.
        Returns:
        the keys

      • keysTipText

        public String keysTipText()
        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