AbstractInstrumentSupplier (adams-pom 24.10.0-SNAPSHOT API)

java.lang.Object
- adams.core.logging.LoggingObject
- - adams.core.logging.CustomLoggingLevelObject
  - - adams.core.option.AbstractOptionHandler
    - - adams.flow.core.AbstractActor
      - adams.flow.source.AbstractSource
        
        adams.flow.source.AbstractArrayProvider
        
        adams.flow.source.AbstractDbArrayProvider
        
        adams.flow.source.AbstractInstrumentSupplier

All Implemented Interfaces:

AdditionalInformationHandler, ArrayProvider, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, DatabaseConnectionUser, VariableChangeListener, Actor, ArrayProvider, ErrorHandler, OutputProducer, Serializable, Comparable
```
public abstract class AbstractInstrumentSupplier
extends AbstractDbArrayProvider
```
Abstract ancestor for instrument suppliers.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary
- Fields inherited from class adams.flow.source.AbstractDbArrayProvider
  m_DatabaseConnection
- Fields inherited from class adams.flow.source.AbstractArrayProvider
  m_Index, m_OutputArray, m_Queue
- Fields inherited from class adams.flow.core.AbstractActor
  m_Annotations, m_BackupState, m_DetectedObjectVariables, m_DetectedVariables, m_ErrorHandler, m_Executed, m_Executing, m_ExecutionListeningSupporter, m_FullName, m_LoggingPrefix, m_Name, m_Parent, m_ScopeHandler, m_Self, m_Silent, m_Skip, m_StopFlowOnError, m_StopMessage, m_Stopped, m_StorageHandler, m_VariablesUpdated
- Fields inherited from class adams.core.option.AbstractOptionHandler
  m_OptionManager
- Fields inherited from class adams.core.logging.LoggingObject
  m_Logger, m_LoggingIsEnabled, m_LoggingLevel
- Fields inherited from interface adams.flow.core.Actor
  FILE_EXTENSION, FILE_EXTENSION_GZ

Constructor Summary

Constructors
Constructor Description

AbstractInstrumentSupplier()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected Class`	`getItemClass()`	Returns the based class of the items.
`protected abstract InstrumentProvider`	`getProvider()`	Returns the instrument provider to use for retrieving the instruments.
`String`	`outputArrayTipText()`	Returns the tip text for this property.
`protected String`	`queryDatabase()`	Performs the actual database query.

Methods inherited from class adams.flow.source.AbstractDbArrayProvider
doExecute, getDatabaseConnection, getDefaultDatabaseConnection, initialize, setUpDatabaseConnection, wrapUp

Methods inherited from class adams.flow.source.AbstractArrayProvider
defineOptions, generates, getOutputArray, hasPendingOutput, output, preExecute, reset, setOutputArray

Methods inherited from class adams.flow.core.AbstractActor
annotationsTipText, backupState, canInspectOptions, canPerformSetUpCheck, cleanUp, compareTo, configureLogger, destroy, equals, execute, finalUpdateVariables, findVariables, findVariables, forceVariables, forCommandLine, forName, forName, getAdditionalInformation, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowActors, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getQuickInfo, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, handleException, hasErrorHandler, hasStopMessage, index, isBackedUp, isExecuted, isExecuting, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, performVariableChecks, postExecute, pruneBackup, pruneBackup, restoreState, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, silentTipText, sizeOf, skipTipText, stopExecution, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged

Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, loggingLevelTipText, newOptionManager, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject
getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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, getOptionManager

Methods inherited from interface adams.core.VariablesInspectionHandler
canInspectOptions

- Constructor Detail
  - AbstractInstrumentSupplier
```
public AbstractInstrumentSupplier()
```
- Method Detail
  - getItemClass
```
protected Class getItemClass()
```
    Returns the based class of the items.
    
    Specified by:
    
    getItemClass in class AbstractArrayProvider
    
    Returns:
    
    the class
  - outputArrayTipText
```
public String outputArrayTipText()
```
    Returns the tip text for this property.
    
    Specified by:
    
    outputArrayTipText in interface ArrayProvider
    
    Specified by:
    
    outputArrayTipText in interface ArrayProvider
    
    Specified by:
    
    outputArrayTipText in class AbstractArrayProvider
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - getProvider
```
protected abstract InstrumentProvider getProvider()
```
    Returns the instrument provider to use for retrieving the instruments.
    
    Returns:
    
    the instrument provider
  - queryDatabase
```
protected String queryDatabase()
```
    Performs the actual database query.
    
    Specified by:
    
    queryDatabase in class AbstractDbArrayProvider
    
    Returns:
    
    null if everything is fine, otherwise error message