Package adams.data.io.input

Interface ReportReader<T extends Report>

All Known Subinterfaces:

StringReportReader<T>

All Known Implementing Classes:

AbstractReportReader, AbstractSimpleCSVReportReader, AbstractSimpleJsonReportReader, AbstractSimpleReportReader, CocoAnnotationsReportReader, DeepLabCutCSVReader, DefaultSimpleCSVReportReader, DefaultSimpleJsonReportReader, DefaultSimpleReportReader, DetectronAnnotationsReportReader, ImageClassificationGridSpreadSheetReader, ImageClassificationJsonReportReader, ImageClassificationSpreadSheetReportReader, ObjectLocationsSpreadSheetReader, OpexObjectLocationsReader, PascalVOCObjectLocationsReader, VggXmlAnnotationReportReader, ViaAnnotationsReportReader, YoloAnnotationsReportReader

public interface ReportReader<T extends Report>

Interface for report readers.

Author:

FracPete (fracpete at waikato dot ac dot nz)

Method Summary

Modifier and Type	Method	Description
PlaceholderFile	getInput()	The file/directory to read.
String	inputTipText()	Returns the tip text for this property.
List<T>	read()	Performs checks and (always) reads the data.
void	setInput(PlaceholderFile value)	Sets the file/directory to read.

Method Detail

setInput

void setInput(PlaceholderFile value)

Sets the file/directory to read.

Parameters:

value - the file/directory to read

getInput

PlaceholderFile getInput()

The file/directory to read.

Returns:

the file/directory to read

inputTipText

String inputTipText()

Returns the tip text for this property.

Returns:

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

read

List<T> read()

Performs checks and (always) reads the data.

Returns:

the report loaded from the file