Package adams.data.conversion

Class StringToMat5Array

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.conversion.AbstractConversion

adams.data.conversion.AbstractConversionFromString

adams.data.conversion.StringToMat5Array

All Implemented Interfaces:

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

public class StringToMat5Array
extends AbstractConversionFromString

Converts a string like '[1, 2; 3, 4]' into a Matlab matrix.

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

-element-type <BOOLEAN|BYTE|SHORT|INTEGER|LONG|FLOAT|DOUBLE> (property: elementType)
    Specifies the type of the values in the array.
    default: DOUBLE
 

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected ArrayElementType	m_ElementType	the element type.

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

Method Summary

Modifier and Type	Method	Description
protected String	checkData()	Checks whether the data can be processed.
void	defineOptions()	Adds options to the internal list of options.
protected Object	doConvert()	Performs the actual conversion.
String	elementTypeTipText()	Returns the tip text for this property.
Class	generates()	Returns the class that is generated as output.
ArrayElementType	getElementType()	Returns the type of the element in the array.
String	getQuickInfo()	Returns a quick info about the actor, which will be displayed in the GUI.
String	globalInfo()	Returns a string describing the object.
void	setElementType(ArrayElementType value)	Sets the type of the element in the array.

Methods inherited from class adams.data.conversion.AbstractConversionFromString

accepts

Methods inherited from class adams.data.conversion.AbstractConversion

cleanUp, convert, getAdditionalInformation, getInput, getInput, getOutput, getOutput, getOwner, 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.CleanUpHandler

cleanUp

Methods inherited from interface adams.data.conversion.Conversion

convert, getInput, getInput, getOutput, getOutput, getOwner, setInput, setOwner

Methods inherited from interface adams.core.logging.LoggingLevelHandler

getLoggingLevel

Methods inherited from interface adams.core.Stoppable

stopExecution

Field Detail

m_ElementType

protected ArrayElementType m_ElementType

the element type.

Constructor Detail

StringToMat5Array

public StringToMat5Array()

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

setElementType

public void setElementType(ArrayElementType value)

Sets the type of the element in the array.

Parameters:

value - the type

getElementType

public ArrayElementType getElementType()

Returns the type of the element in the array.

Returns:

the type

elementTypeTipText

public String elementTypeTipText()

Returns the tip text for this property.

Returns:

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

getQuickInfo

public String getQuickInfo()

Returns a quick info about the actor, which will be displayed in the GUI.

Specified by:

getQuickInfo in interface QuickInfoSupporter

Overrides:

getQuickInfo in class AbstractConversion

Returns:

null if no info available, otherwise short string

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

checkData

protected String checkData()

Checks whether the data can be processed.

Overrides:

checkData in class AbstractConversion

Returns:

null if checks passed, otherwise error message

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