AbstractStringOperation (adams-pom 24.5.0-SNAPSHOT API)

java.lang.Object
- adams.core.logging.LoggingObject
- - adams.core.logging.CustomLoggingLevelObject
  - - adams.core.option.AbstractOptionHandler
    - - adams.flow.core.AbstractActor
      - adams.flow.transformer.AbstractTransformer
        
        adams.flow.transformer.AbstractStringOperation

All Implemented Interfaces:

AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ErrorHandler, InputConsumer, OutputProducer, Serializable, Comparable

Direct Known Subclasses:

ExpandStorage, ExpandVariables, SimpleStringReplace, StringCut, StringIndent, StringInsert, StringMatcher, StringRangeCut, StringReplace, StringSanitizer, StringTrim
```
public abstract class AbstractStringOperation
extends AbstractTransformer
```
Ancestor for transformers that perform operations on strings.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary
- Fields inherited from class adams.flow.transformer.AbstractTransformer
  BACKUP_INPUT, BACKUP_OUTPUT, m_InputToken, m_OutputToken
- 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

AbstractStringOperation()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`Class[]`	`accepts()`	Returns the class that the consumer accepts.
`protected String`	`doExecute()`	Executes the flow item.
`Class[]`	`generates()`	Returns the class of objects that it generates.
`protected abstract String`	`process(String s, int index)`	Processes the string.

Methods inherited from class adams.flow.transformer.AbstractTransformer
backupState, currentInput, execute, hasInput, hasPendingOutput, input, output, postExecute, restoreState, wrapUp

Methods inherited from class adams.flow.core.AbstractActor
annotationsTipText, canInspectOptions, canPerformSetUpCheck, cleanUp, compareTo, configureLogger, defineOptions, destroy, equals, 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, initialize, isBackedUp, isExecuted, isExecuting, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, performVariableChecks, preExecute, pruneBackup, pruneBackup, reset, 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, defineOptions, getOptionManager

Methods inherited from interface adams.core.VariablesInspectionHandler
canInspectOptions

- Constructor Detail
  - AbstractStringOperation
```
public AbstractStringOperation()
```
- Method Detail
  - accepts
```
public Class[] accepts()
```
    Returns the class that the consumer accepts.
    
    Returns:
    
    String/String[]
  - generates
```
public Class[] generates()
```
    Returns the class of objects that it generates.
    
    Returns:
    
    String/String[]
  - process
```
protected abstract String process(String s,
                                  int index)
```
    Processes the string. If null is returned, this output will be ignored.
    
    Parameters:
    
    s - the string to process
    
    index - the 0-based index of the string currently being processed
    
    Returns:
    
    the processed string or null if nothing produced
  - doExecute
```
protected String doExecute()
```
    Executes the flow item.
    
    Specified by:
    
    doExecute in class AbstractActor
    
    Returns:
    
    null if everything is fine, otherwise error message