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.TimeseriesInfo

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

public class TimeseriesInfo
extends AbstractTransformer
implements DataInfoActor

Outputs information for a timeseries.

Input/output:
- accepts:
adams.data.timeseries.Timeseries
- generates:
java.lang.String

Valid options are:

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING

-name <java.lang.String> (property: name)
    The name of the actor.
    default: TimeseriesInfo

-annotation <adams.core.base.BaseText> (property: annotations)
    The annotations to attach to this actor.
    default:

-skip <boolean> (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded 
    as it is.
    default: false

-stop-flow-on-error <boolean> (property: stopFlowOnError)
    If set to true, the flow gets stopped in case this actor encounters an error;
     useful for critical actors.
    default: false

-type <ID|DB_ID|NUM_POINTS|MIN_TIMESTAMP|MAX_TIMESTAMP|MIN_VALUE|MAX_VALUE> (property: type)
    The type of information to generate.
    default: ID

-format <adams.data.DateFormatString> (property: format)
    The format for turning the timestamps into a string.
    default: yyyy-MM-dd
    more: http://docs.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html

Version:: $Revision$
Author:: fracpete (fracpete at waikato dot ac dot nz)
See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class TimeseriesInfo.InfoType
The type of information to generate.

Field Summary

Fields
Modifier and Type	Field	Description
`protected DateFormatString`	`m_Format`	the format string to use for the timestamps.
`protected DateFormat`	`m_Formatter`	the formatter.
`protected ArrayList`	`m_Queue`	the tokens to output.
`protected TimeseriesInfo.InfoType`	`m_Type`	the type of information to generate.

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

TimeseriesInfo()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Class[]`	`accepts()`	Returns the class that the consumer accepts.
`void`	`defineOptions()`	Adds options to the internal list of options.
`protected String`	`doExecute()`	Executes the flow item.
`String`	`formatTipText()`	Returns the tip text for this property.
`Class[]`	`generates()`	Returns the class of objects that it generates.
`DateFormatString`	`getFormat()`	Returns the format in use for the timestamps.
`String`	`getQuickInfo()`	Returns a quick info about the actor, which will be displayed in the GUI.
`TimeseriesInfo.InfoType`	`getType()`	Returns the type of information to generate.
`String`	`globalInfo()`	Returns a string describing the object.
`boolean`	`hasPendingOutput()`	Checks whether there is pending output to be collected after executing the flow item.
`protected void`	`initialize()`	Initializes the members.
`Token`	`output()`	Returns the generated token.
`void`	`setFormat(DateFormatString value)`	Sets the format to use for the timestamps.
`void`	`setType(TimeseriesInfo.InfoType value)`	Sets the type of information to generate.
`String`	`typeTipText()`	Returns the tip text for this property.
`void`	`wrapUp()`	Cleans up after the execution has finished.

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

Methods inherited from class adams.flow.core.AbstractActor
annotationsTipText, canInspectOptions, canPerformSetUpCheck, cleanUp, compareTo, configureLogger, destroy, equals, finalUpdateVariables, findVariables, findVariables, forceVariables, forCommandLine, forName, forName, getAdditionalInformation, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowActors, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, handleException, hasErrorHandler, hasStopMessage, index, 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, 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

- Field Detail
  - m_Queue
```
protected ArrayList m_Queue
```
    the tokens to output.
  - m_Type
```
protected TimeseriesInfo.InfoType m_Type
```
    the type of information to generate.
  - m_Format
```
protected DateFormatString m_Format
```
    the format string to use for the timestamps.
  - m_Formatter
```
protected transient DateFormat m_Formatter
```
    the formatter.
- Constructor Detail
  - TimeseriesInfo
```
public TimeseriesInfo()
```
- Method Detail
  - globalInfo
```
public String globalInfo()
```
    Returns a string describing the object.
    
    Specified by:
    
    globalInfo in interface GlobalInfoSupporter
    
    Specified by:
    
    globalInfo in class AbstractOptionHandler
    
    Returns:
    
    a description suitable for displaying in the gui
  - defineOptions
```
public void defineOptions()
```
    Adds options to the internal list of options.
    
    Specified by:
    
    defineOptions in interface OptionHandler
    
    Overrides:
    
    defineOptions in class AbstractActor
  - initialize
```
protected void initialize()
```
    Initializes the members.
    
    Overrides:
    
    initialize in class AbstractActor
  - getQuickInfo
```
public String getQuickInfo()
```
    Returns a quick info about the actor, which will be displayed in the GUI.
    
    Specified by:
    
    getQuickInfo in interface Actor
    
    Specified by:
    
    getQuickInfo in interface QuickInfoSupporter
    
    Overrides:
    
    getQuickInfo in class AbstractActor
    
    Returns:
    
    null if no info available, otherwise short string
  - setType
```
public void setType(TimeseriesInfo.InfoType value)
```
    Sets the type of information to generate.
    
    Parameters:
    
    value - the type
  - getType
```
public TimeseriesInfo.InfoType getType()
```
    Returns the type of information to generate.
    
    Returns:
    
    the type
  - typeTipText
```
public String typeTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setFormat
```
public void setFormat(DateFormatString value)
```
    Sets the format to use for the timestamps.
    
    Parameters:
    
    value - the format
  - getFormat
```
public DateFormatString getFormat()
```
    Returns the format in use for the timestamps.
    
    Returns:
    
    the format
  - formatTipText
```
public String formatTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - accepts
```
public Class[] accepts()
```
    Returns the class that the consumer accepts.
    
    Specified by:
    
    accepts in interface InputConsumer
    
    Returns:
    
    adams.data.timeseries.Timeseries.class
  - generates
```
public Class[] generates()
```
    Returns the class of objects that it generates.
    
    Specified by:
    
    generates in interface OutputProducer
    
    Returns:
    
    java.lang.String.class
  - doExecute
```
protected String doExecute()
```
    Executes the flow item.
    
    Specified by:
    
    doExecute in class AbstractActor
    
    Returns:
    
    null if everything is fine, otherwise error message
  - output
```
public Token output()
```
    Returns the generated token.
    
    Specified by:
    
    output in interface OutputProducer
    
    Overrides:
    
    output in class AbstractTransformer
    
    Returns:
    
    the generated token
  - hasPendingOutput
```
public boolean hasPendingOutput()
```
    Checks whether there is pending output to be collected after executing the flow item.
    
    Specified by:
    
    hasPendingOutput in interface OutputProducer
    
    Overrides:
    
    hasPendingOutput in class AbstractTransformer
    
    Returns:
    
    true if there is pending output
  - wrapUp
```
public void wrapUp()
```
    Cleans up after the execution has finished.
    
    Specified by:
    
    wrapUp in interface Actor
    
    Overrides:
    
    wrapUp in class AbstractTransformer

Class TimeseriesInfo

Nested Class Summary

Field Summary

Fields inherited from class adams.flow.transformer.AbstractTransformer

Fields inherited from class adams.flow.core.AbstractActor

Fields inherited from class adams.core.option.AbstractOptionHandler

Fields inherited from class adams.core.logging.LoggingObject

Fields inherited from interface adams.flow.core.Actor

Constructor Summary

Method Summary

Methods inherited from class adams.flow.transformer.AbstractTransformer

Methods inherited from class adams.flow.core.AbstractActor

Methods inherited from class adams.core.option.AbstractOptionHandler

Methods inherited from class adams.core.logging.LoggingObject

Methods inherited from class java.lang.Object

Methods inherited from interface adams.flow.core.Actor

Methods inherited from interface adams.core.AdditionalInformationHandler

Methods inherited from interface adams.core.logging.LoggingLevelHandler

Methods inherited from interface adams.core.logging.LoggingSupporter

Methods inherited from interface adams.core.option.OptionHandler

Methods inherited from interface adams.core.VariablesInspectionHandler

Field Detail

m_Queue

m_Type

m_Format

m_Formatter

Constructor Detail

TimeseriesInfo

Method Detail

globalInfo

defineOptions

initialize

getQuickInfo

setType

getType

typeTipText

setFormat

getFormat

formatTipText

accepts

generates

doExecute

output

hasPendingOutput

wrapUp