Package adams.flow.source

Interface SampleIdSource

  • All Superinterfaces:
    adams.flow.core.Actor, adams.core.AdditionalInformationHandler, adams.core.CleanUpHandler, Comparable, adams.core.Destroyable, adams.flow.core.ErrorHandler, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.flow.core.OutputProducer, adams.core.QuickInfoSupporter, Serializable, adams.core.ShallowCopySupporter<adams.flow.core.Actor>, SpectrumIdSource, adams.core.Stoppable, adams.core.StoppableWithFeedback, adams.event.VariableChangeListener, adams.core.VariablesInspectionHandler
    All Known Implementing Classes:
    SpectrumIdSupplier
    public interface SampleIdSource
extends SpectrumIdSource
    Interface for ID sources that output either database IDs (= integers) or sample IDs (= strings).
    Version:
    $Revision: 1866 $
    Author:
    fracpete (fracpete at waikato dot ac dot nz)

    • Field Summary

      • Fields inherited from interface adams.flow.core.Actor

        FILE_EXTENSION, FILE_EXTENSION_GZ

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String generateSampleIDsTipText()
      Returns the tip text for this property.
      boolean getGenerateSampleIDs()
      Returns whether to read from the active or store table.
      void setGenerateSampleIDs​(boolean value)
      Sets whether to generate database IDs or sample IDs.

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

        cleanUp, compareTo, destroy, equals, execute, findVariables, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getQuickInfo, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, isExecuted, isFinished, isHeadless, isStopped, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, sizeOf, stopExecution, stopExecution, toCommandLine, variableChanged, wrapUp

      • Methods inherited from interface adams.core.AdditionalInformationHandler

        getAdditionalInformation

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

        getLoggingLevel, setLoggingLevel

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

        getLogger, isLoggingEnabled

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

        cleanUpOptions, defineOptions, getOptionManager

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

        generates, hasPendingOutput, output

      • Methods inherited from interface adams.core.VariablesInspectionHandler

        canInspectOptions

    • Method Detail

      • setGenerateSampleIDs

        void setGenerateSampleIDs​(boolean value)
        Sets whether to generate database IDs or sample IDs.
        Parameters:
        value - if true then sample IDs are generated

      • getGenerateSampleIDs

        boolean getGenerateSampleIDs()
        Returns whether to read from the active or store table.
        Returns:
        true if the store table is used

      • generateSampleIDsTipText

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