Package adams.flow.transformer.indexedsplitsrunsgenerator

Class AbstractInstancesIndexedSplitsRunsGenerator

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Class[] accepts()
      Returns the type of classes that are accepted as input.
      String addAttributeInformationTipText()
      Returns the tip text for this property.
      String addDatasetInformationTipText()
      Returns the tip text for this property.
      void defineOptions()
      Adds options to the internal list of options.
      boolean getAddAttributeInformation()
      Returns whether to add attribute information to the metadata.
      boolean getAddDatasetInformation()
      Returns whether to add dataset information to the metadata.
      String getQuickInfo()
      Returns a quick info about the actor, which will be displayed in the GUI.
      protected adams.data.indexedsplits.IndexedSplitsRuns postGenerate​(Object data, adams.data.indexedsplits.IndexedSplitsRuns runs, adams.core.MessageCollection errors)
      For post-processing successfully generated splits.
      void setAddAttributeInformation​(boolean value)
      Sets whether to add attribute information to the metadata.
      void setAddDatasetInformation​(boolean value)
      Sets whether to add dataset information to the metadata.

      • Methods inherited from class adams.flow.transformer.indexedsplitsrunsgenerator.AbstractIndexedSplitsRunsGenerator

        check, doGenerate, generate, getFlowContext, getMetaData, metaDataTipText, setFlowContext, setMetaData

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

        cleanUpOptions, 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.flow.core.FlowContextHandler

        getFlowContext, setFlowContext

      • Methods inherited from interface adams.flow.transformer.indexedsplitsrunsgenerator.IndexedSplitsRunsGenerator

        generate

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

        getLoggingLevel

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

        cleanUpOptions, getOptionManager, toCommandLine

    • Field Detail

      • m_AddDatasetInformation

        protected boolean m_AddDatasetInformation
        whether to added basic dataset information to the meta-data as well.

      • m_AddAttributeInformation

        protected boolean m_AddAttributeInformation
        whether to added attribute information to the meta-data as well.

    • Constructor Detail

      • AbstractInstancesIndexedSplitsRunsGenerator

        public AbstractInstancesIndexedSplitsRunsGenerator()

    • Method Detail

      • 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.flow.transformer.indexedsplitsrunsgenerator.AbstractIndexedSplitsRunsGenerator

      • setAddDatasetInformation

        public void setAddDatasetInformation​(boolean value)
        Sets whether to add dataset information to the metadata.
        Parameters:
        value - true if to add

      • getAddDatasetInformation

        public boolean getAddDatasetInformation()
        Returns whether to add dataset information to the metadata.
        Returns:
        true if to add

      • addDatasetInformationTipText

        public String addDatasetInformationTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setAddAttributeInformation

        public void setAddAttributeInformation​(boolean value)
        Sets whether to add attribute information to the metadata.
        Parameters:
        value - true if to add

      • getAddAttributeInformation

        public boolean getAddAttributeInformation()
        Returns whether to add attribute information to the metadata.
        Returns:
        true if to add

      • addAttributeInformationTipText

        public String addAttributeInformationTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • getQuickInfo

        public String getQuickInfo()
        Returns a quick info about the actor, which will be displayed in the GUI.
        Specified by:
        getQuickInfo in interface adams.core.QuickInfoSupporter
        Overrides:
        getQuickInfo in class adams.flow.transformer.indexedsplitsrunsgenerator.AbstractIndexedSplitsRunsGenerator
        Returns:
        null if no info available, otherwise short string

      • accepts

        public Class[] accepts()
        Returns the type of classes that are accepted as input.
        Specified by:
        accepts in interface adams.flow.transformer.indexedsplitsrunsgenerator.IndexedSplitsRunsGenerator
        Specified by:
        accepts in class adams.flow.transformer.indexedsplitsrunsgenerator.AbstractIndexedSplitsRunsGenerator
        Returns:
        the classes

      • postGenerate

        protected adams.data.indexedsplits.IndexedSplitsRuns postGenerate​(Object data,
                                                                  adams.data.indexedsplits.IndexedSplitsRuns runs,
                                                                  adams.core.MessageCollection errors)
        For post-processing successfully generated splits.
        Overrides:
        postGenerate in class adams.flow.transformer.indexedsplitsrunsgenerator.AbstractIndexedSplitsRunsGenerator
        Parameters:
        data - the input data
        runs - the generated runs
        errors - for storing errors
        Returns:
        the runs, null if failed to post-process