Package adams.data.conversion

Class ArrayToReport

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.conversion.AbstractConversion

adams.data.conversion.ArrayToReport

All Implemented Interfaces:

AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<AbstractConversion>, SizeOfHandler, Stoppable, Conversion, Serializable

public class ArrayToReport
extends AbstractConversion

Turns an array into a report.

-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 prefix to use in front of the index.
    default: Object.
 

-suffix <java.lang.String> (property: suffix)
    The suffix to use after the index.
    default: .value
 

-start-index <int> (property: startIndex)
    The start index to use.
    default: 1
 

-data-type <STRING|NUMERIC|BOOLEAN|UNKNOWN> (property: dataType)
    The data type to use.
    default: STRING
 

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected DataType	m_DataType	the data type to use.
protected String	m_Prefix	the prefix to use.
protected int	m_StartIndex	the start for the index.
protected String	m_Suffix	the suffix to use.

Fields inherited from class adams.data.conversion.AbstractConversion

m_Input, m_Output, m_Owner, m_Stopped

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

Method Summary

Modifier and Type	Method	Description
Class	accepts()	Returns the class that is accepted as input.
String	dataTypeTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
protected Object	doConvert()	Performs the actual conversion.
Class	generates()	Returns the class that is generated as output.
DataType	getDataType()	Returns the data type in use.
String	getPrefix()	Returns the field prefix used in the report.
int	getStartIndex()	Returns the start index.
String	getSuffix()	Returns the field suffix used in the report.
String	globalInfo()	Returns a string describing the object.
String	prefixTipText()	Returns the tip text for this property.
void	setDataType(DataType value)	Sets the data type to use.
void	setPrefix(String value)	Sets the field prefix used in the report.
void	setStartIndex(int value)	Sets the start index.
void	setSuffix(String value)	Sets the field suffix used in the report.
String	startIndexTipText()	Returns the tip text for this property.
String	suffixTipText()	Returns the tip text for this property.

Methods inherited from class adams.data.conversion.AbstractConversion

checkData, cleanUp, convert, getAdditionalInformation, getInput, getInput, getOutput, getOutput, getOwner, getQuickInfo, reset, setInput, setOwner, shallowCopy, shallowCopy, stopExecution

Methods inherited from class adams.core.option.AbstractOptionHandler

cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, 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

m_Prefix

protected String m_Prefix

the prefix to use.

m_Suffix

protected String m_Suffix

the suffix to use.

m_StartIndex

protected int m_StartIndex

the start for the index.

m_DataType

protected DataType m_DataType

the data type to use.

Constructor Detail

ArrayToReport

public ArrayToReport()

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 AbstractOptionHandler

setPrefix

public void setPrefix(String value)

Sets the field prefix used in the report.

Parameters:

value - the field prefix

getPrefix

public String getPrefix()

Returns the field prefix used in the report.

Returns:

the field prefix

prefixTipText

public String prefixTipText()

Returns the tip text for this property.

Returns:

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

setSuffix

public void setSuffix(String value)

Sets the field suffix used in the report.

Parameters:

value - the field suffix

getSuffix

public String getSuffix()

Returns the field suffix used in the report.

Returns:

the field suffix

suffixTipText

public String suffixTipText()

Returns the tip text for this property.

Returns:

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

setStartIndex

public void setStartIndex(int value)

Sets the start index.

Parameters:

value - the start index

getStartIndex

public int getStartIndex()

Returns the start index.

Returns:

the start index

startIndexTipText

public String startIndexTipText()

Returns the tip text for this property.

Returns:

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

setDataType

public void setDataType(DataType value)

Sets the data type to use.

Parameters:

value - the data type

getDataType

public DataType getDataType()

Returns the data type in use.

Returns:

the data type

dataTypeTipText

public String dataTypeTipText()

Returns the tip text for this property.

Returns:

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

accepts

public Class accepts()

Returns the class that is accepted as input.

Specified by:

accepts in interface Conversion

Specified by:

accepts in class AbstractConversion

Returns:

the class

generates

public Class generates()

Returns the class that is generated as output.

Specified by:

generates in interface Conversion

Specified by:

generates in class AbstractConversion

Returns:

the class

doConvert

protected Object doConvert()
                    throws Exception

Performs the actual conversion.

Specified by:

doConvert in class AbstractConversion

Returns:

the converted data

Throws:

Exception - if something goes wrong with the conversion