Package adams.data.objectfinder

Interface ObjectFinder

All Superinterfaces:

Destroyable, ObjectPrefixHandler, OptionHandler, QuickInfoSupporter

All Known Implementing Classes:

AbstractMetaObjectFinder, AbstractObjectFinder, AllFinder, ByMetaDataNumericValue, ByMetaDataStringValue, HasMetaDataValue, Invert, MultiObjectFinder, NullFinder, ObjectsInRegion, PolygonPoints, Size

public interface ObjectFinder
extends OptionHandler, QuickInfoSupporter, ObjectPrefixHandler

Interface for finders that locate objects in the report of an image.

Author:

fracpete (fracpete at waikato dot ac dot nz)

Method Summary

Modifier and Type	Method	Description
Report	filter(Report report)	Filters the objects in the report.
int[]	find(Report report)	Finds the objects in the report.
int[]	find(LocatedObjects objects)	Finds the objects in the list of objects.
LocatedObjects	findObjects(Report report)	Finds the objects in the report.
LocatedObjects	findObjects(LocatedObjects objects)	Finds the objects in the list of objects.
String	getPrefix()	Returns the field prefix used in the report.
boolean	getResetIndicesIfNecessary()	Returns whether to reset the indices of the objects if necessary, e.g., when missing or duplicates.
String	prefixTipText()	Returns the tip text for this property.
String	resetIndicesIfNecessaryTipText()	Returns the tip text for this property.
void	setPrefix(String value)	Sets the field prefix used in the report.
void	setResetIndicesIfNecessary(boolean value)	Sets whether to reset the indices of the objects if necessary, e.g., when missing or duplicates.

Methods inherited from interface adams.core.Destroyable

destroy

Methods inherited from interface adams.core.option.OptionHandler

cleanUpOptions, defineOptions, getOptionManager, toCommandLine

Methods inherited from interface adams.core.QuickInfoSupporter

getQuickInfo

Method Detail

setPrefix

void setPrefix(String value)

Sets the field prefix used in the report.

Specified by:

setPrefix in interface ObjectPrefixHandler

Parameters:

value - the field prefix

getPrefix

String getPrefix()

Returns the field prefix used in the report.

Specified by:

getPrefix in interface ObjectPrefixHandler

Returns:

the field prefix

prefixTipText

String prefixTipText()

Returns the tip text for this property.

Specified by:

prefixTipText in interface ObjectPrefixHandler

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

setResetIndicesIfNecessary

void setResetIndicesIfNecessary(boolean value)

Sets whether to reset the indices of the objects if necessary, e.g., when missing or duplicates.

Parameters:

value - true if to reset

getResetIndicesIfNecessary

boolean getResetIndicesIfNecessary()

Returns whether to reset the indices of the objects if necessary, e.g., when missing or duplicates.

Returns:

true if to reset

resetIndicesIfNecessaryTipText

String resetIndicesIfNecessaryTipText()

Returns the tip text for this property.

Returns:

tip text for this property suitable for displaying in the GUI or for listing the options.

find

int[] find(LocatedObjects objects)

Finds the objects in the list of objects.

Parameters:

objects - the list of objects to process

Returns:

the indices

find

int[] find(Report report)

Finds the objects in the report.

Parameters:

report - the report to process

Returns:

the indices

findObjects

LocatedObjects findObjects(LocatedObjects objects)

Finds the objects in the list of objects.

Parameters:

objects - the list of objects to process

Returns:

the indices

findObjects

LocatedObjects findObjects(Report report)

Finds the objects in the report.

Parameters:

report - the report to process

Returns:

the indices

filter

Report filter(Report report)

Filters the objects in the report.

Parameters:

report - the report to process

Returns:

the filtered report