Package adams.data.objectfinder

Class MultiObjectFinder

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.objectfinder.AbstractObjectFinder

adams.data.objectfinder.MultiObjectFinder

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, LenientModeSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, SizeOfHandler, ObjectFinder, ObjectPrefixHandler, Serializable

public class MultiObjectFinder
extends AbstractObjectFinder

Applies multiple object finding algorithms to the data.
The indices can be either joined or intersected.

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

-prefix <java.lang.String> (property: prefix)
    The report field prefix used in the report.
    default: Object.
 

-finder <adams.data.objectfinder.ObjectFinder> [-finder ...] (property: finders)
    The row finders to use.
    default:
 

-combination <JOIN|INTERSECT> (property: combination)
    Defines how the indices are combined.
    default: JOIN
 

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	MultiObjectFinder.Combination	How combine the indices.

Field Summary

Fields

Modifier and Type	Field	Description
protected MultiObjectFinder.Combination	m_Combination	how the indices are combined.
protected ObjectFinder[]	m_Finders	the row finders to use.

Fields inherited from class adams.data.objectfinder.AbstractObjectFinder

m_Lenient, m_Prefix, m_ResetIndicesIfNecessary

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
MultiObjectFinder()

Method Summary

Modifier and Type	Method	Description
String	combinationTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
protected int[]	doFind(LocatedObjects objects)	Performs the actual finding of the objects in the list.
String	findersTipText()	Returns the tip text for this property.
MultiObjectFinder.Combination	getCombination()	Returns how the indices are combined.
ObjectFinder[]	getFinders()	Returns the row finders in use.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
String	globalInfo()	Returns a string describing the object.
void	setCombination(MultiObjectFinder.Combination value)	Sets how the indices are combined.
void	setFinders(ObjectFinder[] value)	Sets the row finders to use.

Methods inherited from class adams.data.objectfinder.AbstractObjectFinder

check, filter, find, find, findObjects, findObjects, getLenient, getPrefix, getResetIndicesIfNecessary, lenientTipText, prefixTipText, resetIndicesIfNecessaryTipText, setLenient, setPrefix, setResetIndicesIfNecessary

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

destroy

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, getOptionManager, toCommandLine

Field Detail

m_Finders

protected ObjectFinder[] m_Finders

the row finders to use.

m_Combination

protected MultiObjectFinder.Combination m_Combination

how the indices are combined.

Constructor Detail

MultiObjectFinder

public MultiObjectFinder()

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 AbstractObjectFinder

setFinders

public void setFinders(ObjectFinder[] value)

Sets the row finders to use.

Parameters:

value - the row finders

getFinders

public ObjectFinder[] getFinders()

Returns the row finders in use.

Returns:

the row finders

findersTipText

public String findersTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui

setCombination

public void setCombination(MultiObjectFinder.Combination value)

Sets how the indices are combined.

Parameters:

value - the combination type

getCombination

public MultiObjectFinder.Combination getCombination()

Returns how the indices are combined.

Returns:

the combination type

combinationTipText

public String combinationTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the gui

getQuickInfo

public String getQuickInfo()

Returns a quick info about the object, which can be displayed in the GUI.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractObjectFinder

Returns:

null if no info available, otherwise short string

doFind

protected int[] doFind(LocatedObjects objects)

Performs the actual finding of the objects in the list.

Specified by:

doFind in class AbstractObjectFinder

Parameters:

objects - the list of objects to process

Returns:

the indices