AbstractLimitedConditions (adams-pom 24.4.0-SNAPSHOT API)

java.lang.Object
- adams.core.logging.LoggingObject
- - adams.core.logging.CustomLoggingLevelObject
  - - adams.core.option.AbstractOptionHandler
    - - adams.db.AbstractConditions
      - adams.db.AbstractLimitedConditions

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, PreGetOptionslistHook, SizeOfHandler, Serializable

Direct Known Subclasses:

LogEntryConditions
```
public abstract class AbstractLimitedConditions
extends AbstractConditions
```
Abstract ancestor for conditions that limit the number of records retrieved.

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

protected int m_Limit
the maximum number of records.
- 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

AbstractLimitedConditions()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`defineOptions()`	Adds options to the internal list of options.
`protected int`	`getDefaultLimit()`	Returns the default limit.
`int`	`getLimit()`	Returns the maximum number of records to retrieve.
`String`	`limitTipText()`	Returns the tip text for this property.
`void`	`setLimit(int value)`	Sets the maximum number of records to retrieve.

Methods inherited from class adams.db.AbstractConditions
check, compareTo, equals, forCommandLine, forName, getFilters, preGetOptionsList, shallowCopy, shallowCopy, update

Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, 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, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

- Field Detail
  - m_Limit
```
protected int m_Limit
```
    the maximum number of records.
- Constructor Detail
  - AbstractLimitedConditions
```
public AbstractLimitedConditions()
```
- Method Detail
  - defineOptions
```
public void defineOptions()
```
    Adds options to the internal list of options.
    
    Specified by:
    
    defineOptions in interface OptionHandler
    
    Overrides:
    
    defineOptions in class AbstractOptionHandler
  - getDefaultLimit
```
protected int getDefaultLimit()
```
    Returns the default limit.
    
    Returns:
    
    the default limit
  - setLimit
```
public void setLimit(int value)
```
    Sets the maximum number of records to retrieve.
    
    Parameters:
    
    value - the limit to use
  - getLimit
```
public int getLimit()
```
    Returns the maximum number of records to retrieve.
    
    Returns:
    
    the limit
  - limitTipText
```
public String limitTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.