SimpleSuggestion (adams-pom 24.4.0-SNAPSHOT API)

java.lang.Object
- adams.core.logging.LoggingObject
- - adams.core.logging.CustomLoggingLevelObject
  - - adams.core.option.AbstractOptionHandler
    - - adams.gui.flow.tree.actorswap.AbstractActorSwapSuggestion
      - adams.gui.flow.tree.actorswap.SimpleSuggestion

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, Serializable
```
public class SimpleSuggestion
extends AbstractActorSwapSuggestion
```
Suggests actors based on the PROPERTIES_FILENAME rules.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

protected static Properties m_Properties
the properties.

static String PROPERTIES_FILENAME
the properties file to load.
- Fields inherited from class adams.gui.flow.tree.actorswap.AbstractActorSwapSuggestion
  LOGGER, m_Cache
- 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

SimpleSuggestion()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected List<Actor>`	`doSuggest(Actor current)`	Performs the actual search for candidates.
`protected static Properties`	`getProperties()`	Returns the properties with the suggestions.
`String`	`globalInfo()`	Returns a string describing the object.

Methods inherited from class adams.gui.flow.tree.actorswap.AbstractActorSwapSuggestion
suggest, suggestAll

Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, defineOptions, 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
  - PROPERTIES_FILENAME
```
public static final String PROPERTIES_FILENAME
```
    the properties file to load.
    
    See Also:
    
    Constant Field Values
  - m_Properties
```
protected static Properties m_Properties
```
    the properties.
- Constructor Detail
  - SimpleSuggestion
```
public SimpleSuggestion()
```
- 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
  - doSuggest
```
protected List<Actor> doSuggest(Actor current)
```
    Performs the actual search for candidates.
    
    Specified by:
    
    doSuggest in class AbstractActorSwapSuggestion
    
    Parameters:
    
    current - the actor to find potential swaps for
    
    Returns:
    
    the list of potential swaps
  - getProperties
```
protected static Properties getProperties()
```
    Returns the properties with the suggestions.
    
    Returns:
    
    the suggestions