Package adams.flow.transformer.mongodbfinddocuments.filter

Class AbstractMongoDbDocumentFilter

  • 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, MongoDbDocumentFilter, Serializable
    Direct Known Subclasses:
    AbstractMongoDbKeyValueDocumentFilter, And, Not, Or, Text
    public abstract class AbstractMongoDbDocumentFilter
extends adams.core.option.AbstractOptionHandler
implements MongoDbDocumentFilter
    Ancestor for filters.
    Author:
    FracPete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Summary

      • Fields inherited from class adams.core.option.AbstractOptionHandler

        m_OptionManager

      • Fields inherited from class adams.core.logging.LoggingObject

        m_Logger, m_LoggingIsEnabled, m_LoggingLevel

    • Method Summary

      All Methods Instance Methods Abstract Methods Concrete Methods 
      Modifier and Type Method Description
      protected String check()
      Checks setup before configuring filter.
      org.bson.conversions.Bson configure()
      Configures the filter.
      protected abstract org.bson.conversions.Bson doConfigure()
      Configures the filter.
      String getQuickInfo()
      Returns a quick info about the object, which can be displayed in the GUI.

      • 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

      • 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, defineOptions, getOptionManager, toCommandLine

    • Constructor Detail

      • AbstractMongoDbDocumentFilter

        public AbstractMongoDbDocumentFilter()

    • Method Detail

      • 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 interface adams.core.QuickInfoSupporter
        Returns:
        null if no info available, otherwise short string

      • check

        protected String check()
        Checks setup before configuring filter.
        Returns:
        null if OK, otherwise error message

      • doConfigure

        protected abstract org.bson.conversions.Bson doConfigure()
        Configures the filter.
        Returns:
        the filter

      • configure

        public org.bson.conversions.Bson configure()
        Configures the filter.
        Specified by:
        configure in interface MongoDbDocumentFilter
        Returns:
        the filter