java.lang.Object
- adams.core.logging.LoggingObject
- - adams.core.logging.CustomLoggingLevelObject
  - - adams.core.option.AbstractOptionHandler
    - - adams.core.option.AbstractOptionGroup
      - adams.flow.core.LagMakerOptions

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, Serializable
```
public class LagMakerOptions
extends AbstractOptionGroup
```
Option group for TSLagMaker objects.

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`protected boolean`	`m_AddAMIndicator`	the am-pm indicator.
`protected boolean`	`m_AddDayOfMonth`	the day of month indicator.
`protected boolean`	`m_AddDayOfWeek`	the day of week indicator.
`protected boolean`	`m_AddMonthOfYear`	the month indicator.
`protected boolean`	`m_AddNumDaysInMonth`	the number of days in month indicator.
`protected boolean`	`m_AddQuarterOfYear`	the quarted indicator.
`protected boolean`	`m_AddWeekendIndicator`	the weekend indicator.
`protected boolean`	`m_AdjustForTrends`	whether to adjust for trends.
`protected boolean`	`m_AdjustForVariance`	whether to adjust for variance.
`protected boolean`	`m_AverageConsecutiveLongLags`	average consecutive long lags.
`protected int`	`m_AverageLagsAfter`	average lags after.
`protected String`	`m_LagFineTune`	lag fine tune.
`protected int`	`m_MaxLag`	the maximum lag.
`protected int`	`m_MinLag`	the minimum lag.
`protected int`	`m_NumConsecutiveLongLagsToAverage`	number of consecutive long lags to average.
`protected String`	`m_SkipEntries`	the entries to skip.
`protected String`	`m_TimeStampField`	the timestamp field.

Fields inherited from class adams.core.option.AbstractOptionHandler
m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject
m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors
Constructor Description

LagMakerOptions()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`addAMIndicatorTipText()`	Returns the tip text for this property.
`String`	`addDayOfMonthTipText()`	Returns the tip text for this property.
`String`	`addDayOfWeekTipText()`	Returns the tip text for this property.
`String`	`addMonthOfYearTipText()`	Returns the tip text for this property.
`String`	`addNumDaysInMonthTipText()`	Returns the tip text for this property.
`String`	`addQuarterOfYearTipText()`	Returns the tip text for this property.
`String`	`addWeekendIndicatorTipText()`	Returns the tip text for this property.
`String`	`adjustForTrendsTipText()`	Returns the tip text for this property.
`String`	`adjustForVarianceTipText()`	Returns the tip text for this property.
`String`	`averageConsecutiveLongLagsTipText()`	Returns the tip text for this property.
`String`	`averageLagsAfterTipText()`	Returns the tip text for this property.
`void`	`defineOptions()`	Adds options to the internal list of options.
`boolean`	`getAddAMIndicator()`	Returns whether to add the AM indicator.
`boolean`	`getAddDayOfMonth()`	Returns whether to add the day of month indicator.
`boolean`	`getAddDayOfWeek()`	Returns whether to add the day of week indicator.
`boolean`	`getAddMonthOfYear()`	Returns whether to add the month of year indicator.
`boolean`	`getAddNumDaysInMonth()`	Returns whether to add the number of days in month indicator.
`boolean`	`getAddQuarterOfYear()`	Returns whether to add the quarter of year indicator.
`boolean`	`getAddWeekendIndicator()`	Returns whether to add the weekend indicator.
`boolean`	`getAdjustForTrends()`	Returns whether to adjust for trends.
`boolean`	`getAdjustForVariance()`	Returns whether to adjust for variance.
`boolean`	`getAverageConsecutiveLongLags()`	Returns whether to average consecutive long lags.
`int`	`getAverageLagsAfter()`	Returns the number of lags after which to average.
`protected String`	`getGroupName()`	Returns the group name.
`String`	`getLagFineTune()`	Returns the lag fine tune.
`int`	`getMaxLag()`	Returns the maximum lag.
`int`	`getMinLag()`	Returns the maximum lag.
`int`	`getNumConsecutiveLongLagsToAverage()`	Returns the number of consecutive long lags to average.
`String`	`getSkipEntries()`	Returns the entries to skip.
`String`	`getTimeStampField()`	Returns the timestamp field.
`String`	`lagFineTuneTipText()`	Returns the tip text for this property.
`String`	`maxLagTipText()`	Returns the tip text for this property.
`String`	`minLagTipText()`	Returns the tip text for this property.
`String`	`numConsecutiveLongLagsToAverageTipText()`	Returns the tip text for this property.
`void`	`setAddAMIndicator(boolean value)`	Sets whether to add the AM indicator.
`void`	`setAddDayOfMonth(boolean value)`	Sets whether to add the day of month indicator.
`void`	`setAddDayOfWeek(boolean value)`	Sets whether to add the day of week indicator.
`void`	`setAddMonthOfYear(boolean value)`	Sets whether to add the month of year indicator.
`void`	`setAddNumDaysInMonth(boolean value)`	Sets whether to add the number of days in month indicator.
`void`	`setAddQuarterOfYear(boolean value)`	Sets whether to add the quarter of year indicator.
`void`	`setAddWeekendIndicator(boolean value)`	Sets whether to add the weekend indicator.
`void`	`setAdjustForTrends(boolean value)`	Sets whether to adjust for trends.
`void`	`setAdjustForVariance(boolean value)`	Sets whether to adjust for variance.
`void`	`setAverageConsecutiveLongLags(boolean value)`	Sets whether to average consecutive long lags.
`void`	`setAverageLagsAfter(int value)`	Sets the number of lags after which to average.
`void`	`setLagFineTune(String value)`	Sets the lag fine tune.
`void`	`setMaxLag(int value)`	Sets the maximum lag.
`void`	`setMinLag(int value)`	Sets the minimum lag.
`void`	`setNumConsecutiveLongLagsToAverage(int value)`	Sets the number of consecutive long lags to average.
`void`	`setSkipEntries(String value)`	Sets the entries to skip.
`void`	`setTimeStampField(String value)`	Sets the timestamp field.
`String`	`skipEntriesTipText()`	Returns the tip text for this property.
`String`	`timeStampFieldTipText()`	Returns the tip text for this property.

Methods inherited from class adams.core.option.AbstractOptionGroup
globalInfo

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

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

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

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

- Field Detail
  - m_MinLag
```
protected int m_MinLag
```
    the minimum lag.
  - m_MaxLag
```
protected int m_MaxLag
```
    the maximum lag.
  - m_LagFineTune
```
protected String m_LagFineTune
```
    lag fine tune.
  - m_AverageConsecutiveLongLags
```
protected boolean m_AverageConsecutiveLongLags
```
    average consecutive long lags.
  - m_AverageLagsAfter
```
protected int m_AverageLagsAfter
```
    average lags after.
  - m_NumConsecutiveLongLagsToAverage
```
protected int m_NumConsecutiveLongLagsToAverage
```
    number of consecutive long lags to average.
  - m_AdjustForTrends
```
protected boolean m_AdjustForTrends
```
    whether to adjust for trends.
  - m_AdjustForVariance
```
protected boolean m_AdjustForVariance
```
    whether to adjust for variance.
  - m_TimeStampField
```
protected String m_TimeStampField
```
    the timestamp field.
  - m_AddAMIndicator
```
protected boolean m_AddAMIndicator
```
    the am-pm indicator.
  - m_AddDayOfWeek
```
protected boolean m_AddDayOfWeek
```
    the day of week indicator.
  - m_AddDayOfMonth
```
protected boolean m_AddDayOfMonth
```
    the day of month indicator.
  - m_AddNumDaysInMonth
```
protected boolean m_AddNumDaysInMonth
```
    the number of days in month indicator.
  - m_AddWeekendIndicator
```
protected boolean m_AddWeekendIndicator
```
    the weekend indicator.
  - m_AddMonthOfYear
```
protected boolean m_AddMonthOfYear
```
    the month indicator.
  - m_AddQuarterOfYear
```
protected boolean m_AddQuarterOfYear
```
    the quarted indicator.
  - m_SkipEntries
```
protected String m_SkipEntries
```
    the entries to skip.
- Constructor Detail
  - LagMakerOptions
```
public LagMakerOptions()
```
- Method Detail
  - getGroupName
```
protected String getGroupName()
```
    Returns the group name.
    
    Specified by:
    
    getGroupName in class AbstractOptionGroup
    
    Returns:
    
    the name
  - defineOptions
```
public void defineOptions()
```
    Adds options to the internal list of options.
    
    Specified by:
    
    defineOptions in interface OptionHandler
    
    Overrides:
    
    defineOptions in class AbstractOptionHandler
  - setMinLag
```
public void setMinLag(int value)
```
    Sets the minimum lag.
    
    Parameters:
    
    value - the min lag
  - getMinLag
```
public int getMinLag()
```
    Returns the maximum lag.
    
    Returns:
    
    the max lag
  - minLagTipText
```
public String minLagTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setMaxLag
```
public void setMaxLag(int value)
```
    Sets the maximum lag.
    
    Parameters:
    
    value - the max lag
  - getMaxLag
```
public int getMaxLag()
```
    Returns the maximum lag.
    
    Returns:
    
    the max lag
  - maxLagTipText
```
public String maxLagTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setLagFineTune
```
public void setLagFineTune(String value)
```
    Sets the lag fine tune.
    
    Parameters:
    
    value - the fine tune
  - getLagFineTune
```
public String getLagFineTune()
```
    Returns the lag fine tune.
    
    Returns:
    
    the fine tune
  - lagFineTuneTipText
```
public String lagFineTuneTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setAverageConsecutiveLongLags
```
public void setAverageConsecutiveLongLags(boolean value)
```
    Sets whether to average consecutive long lags.
    
    Parameters:
    
    value - true if to average
  - getAverageConsecutiveLongLags
```
public boolean getAverageConsecutiveLongLags()
```
    Returns whether to average consecutive long lags.
    
    Returns:
    
    true if to average
  - averageConsecutiveLongLagsTipText
```
public String averageConsecutiveLongLagsTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setAverageLagsAfter
```
public void setAverageLagsAfter(int value)
```
    Sets the number of lags after which to average.
    
    Parameters:
    
    value - the number
  - getAverageLagsAfter
```
public int getAverageLagsAfter()
```
    Returns the number of lags after which to average.
    
    Returns:
    
    the number of lags
  - averageLagsAfterTipText
```
public String averageLagsAfterTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setNumConsecutiveLongLagsToAverage
```
public void setNumConsecutiveLongLagsToAverage(int value)
```
    Sets the number of consecutive long lags to average.
    
    Parameters:
    
    value - the number
  - getNumConsecutiveLongLagsToAverage
```
public int getNumConsecutiveLongLagsToAverage()
```
    Returns the number of consecutive long lags to average.
    
    Returns:
    
    the number
  - numConsecutiveLongLagsToAverageTipText
```
public String numConsecutiveLongLagsToAverageTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setAdjustForTrends
```
public void setAdjustForTrends(boolean value)
```
    Sets whether to adjust for trends.
    
    Parameters:
    
    value - true if to adjust
  - getAdjustForTrends
```
public boolean getAdjustForTrends()
```
    Returns whether to adjust for trends.
    
    Returns:
    
    true if to adjust
  - adjustForTrendsTipText
```
public String adjustForTrendsTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setAdjustForVariance
```
public void setAdjustForVariance(boolean value)
```
    Sets whether to adjust for variance.
    
    Parameters:
    
    value - true if to adjust
  - getAdjustForVariance
```
public boolean getAdjustForVariance()
```
    Returns whether to adjust for variance.
    
    Returns:
    
    true if to adjust
  - adjustForVarianceTipText
```
public String adjustForVarianceTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setTimeStampField
```
public void setTimeStampField(String value)
```
    Sets the timestamp field.
    
    Parameters:
    
    value - the field
  - getTimeStampField
```
public String getTimeStampField()
```
    Returns the timestamp field.
    
    Returns:
    
    the field
  - timeStampFieldTipText
```
public String timeStampFieldTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setAddAMIndicator
```
public void setAddAMIndicator(boolean value)
```
    Sets whether to add the AM indicator.
    
    Parameters:
    
    value - true if to add indicator
  - getAddAMIndicator
```
public boolean getAddAMIndicator()
```
    Returns whether to add the AM indicator.
    
    Returns:
    
    true if added
  - addAMIndicatorTipText
```
public String addAMIndicatorTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setAddDayOfWeek
```
public void setAddDayOfWeek(boolean value)
```
    Sets whether to add the day of week indicator.
    
    Parameters:
    
    value - true if to add indicator
  - getAddDayOfWeek
```
public boolean getAddDayOfWeek()
```
    Returns whether to add the day of week indicator.
    
    Returns:
    
    true if added
  - addDayOfWeekTipText
```
public String addDayOfWeekTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setAddDayOfMonth
```
public void setAddDayOfMonth(boolean value)
```
    Sets whether to add the day of month indicator.
    
    Parameters:
    
    value - true if to add indicator
  - getAddDayOfMonth
```
public boolean getAddDayOfMonth()
```
    Returns whether to add the day of month indicator.
    
    Returns:
    
    true if added
  - addDayOfMonthTipText
```
public String addDayOfMonthTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setAddNumDaysInMonth
```
public void setAddNumDaysInMonth(boolean value)
```
    Sets whether to add the number of days in month indicator.
    
    Parameters:
    
    value - true if to add indicator
  - getAddNumDaysInMonth
```
public boolean getAddNumDaysInMonth()
```
    Returns whether to add the number of days in month indicator.
    
    Returns:
    
    true if added
  - addNumDaysInMonthTipText
```
public String addNumDaysInMonthTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setAddWeekendIndicator
```
public void setAddWeekendIndicator(boolean value)
```
    Sets whether to add the weekend indicator.
    
    Parameters:
    
    value - true if to add indicator
  - getAddWeekendIndicator
```
public boolean getAddWeekendIndicator()
```
    Returns whether to add the weekend indicator.
    
    Returns:
    
    true if added
  - addWeekendIndicatorTipText
```
public String addWeekendIndicatorTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setAddMonthOfYear
```
public void setAddMonthOfYear(boolean value)
```
    Sets whether to add the month of year indicator.
    
    Parameters:
    
    value - true if to add indicator
  - getAddMonthOfYear
```
public boolean getAddMonthOfYear()
```
    Returns whether to add the month of year indicator.
    
    Returns:
    
    true if added
  - addMonthOfYearTipText
```
public String addMonthOfYearTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setAddQuarterOfYear
```
public void setAddQuarterOfYear(boolean value)
```
    Sets whether to add the quarter of year indicator.
    
    Parameters:
    
    value - true if to add indicator
  - getAddQuarterOfYear
```
public boolean getAddQuarterOfYear()
```
    Returns whether to add the quarter of year indicator.
    
    Returns:
    
    true if added
  - addQuarterOfYearTipText
```
public String addQuarterOfYearTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setSkipEntries
```
public void setSkipEntries(String value)
```
    Sets the entries to skip.
    
    Parameters:
    
    value - the entries
  - getSkipEntries
```
public String getSkipEntries()
```
    Returns the entries to skip.
    
    Returns:
    
    the entries
  - skipEntriesTipText
```
public String skipEntriesTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.

Class LagMakerOptions

Field Summary

Fields inherited from class adams.core.option.AbstractOptionHandler

Fields inherited from class adams.core.logging.LoggingObject

Constructor Summary

Method Summary

Methods inherited from class adams.core.option.AbstractOptionGroup

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.core.logging.LoggingLevelHandler

Field Detail

m_MinLag

m_MaxLag

m_LagFineTune

m_AverageConsecutiveLongLags

m_AverageLagsAfter

m_NumConsecutiveLongLagsToAverage

m_AdjustForTrends

m_AdjustForVariance

m_TimeStampField

m_AddAMIndicator

m_AddDayOfWeek

m_AddDayOfMonth

m_AddNumDaysInMonth

m_AddWeekendIndicator

m_AddMonthOfYear

m_AddQuarterOfYear

m_SkipEntries

Constructor Detail

LagMakerOptions

Method Detail

getGroupName

defineOptions

setMinLag

getMinLag

minLagTipText

setMaxLag

getMaxLag

maxLagTipText

setLagFineTune

getLagFineTune

lagFineTuneTipText

setAverageConsecutiveLongLags

getAverageConsecutiveLongLags

averageConsecutiveLongLagsTipText

setAverageLagsAfter

getAverageLagsAfter

averageLagsAfterTipText

setNumConsecutiveLongLagsToAverage

getNumConsecutiveLongLagsToAverage

numConsecutiveLongLagsToAverageTipText

setAdjustForTrends

getAdjustForTrends

adjustForTrendsTipText

setAdjustForVariance

getAdjustForVariance

adjustForVarianceTipText

setTimeStampField

getTimeStampField

timeStampFieldTipText

setAddAMIndicator

getAddAMIndicator

addAMIndicatorTipText

setAddDayOfWeek

getAddDayOfWeek

addDayOfWeekTipText

setAddDayOfMonth

getAddDayOfMonth

addDayOfMonthTipText

setAddNumDaysInMonth

getAddNumDaysInMonth

addNumDaysInMonthTipText

setAddWeekendIndicator

getAddWeekendIndicator

addWeekendIndicatorTipText

setAddMonthOfYear

getAddMonthOfYear

addMonthOfYearTipText

setAddQuarterOfYear