Package adams.data.conversion

Class Mat5ArrayToString

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.conversion.AbstractConversion

adams.data.conversion.AbstractConversionToString

adams.data.conversion.Mat5ArrayToString

All Implemented Interfaces:

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

public class Mat5ArrayToString
extends AbstractConversionToString

Converts matrices into a textual representation, otherwise just outputs the dimensions.

-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
 

-compact <boolean> (property: compact)
    If enabled, the output omits spaces.
    default: false
 

-num-decimals <int> (property: numDecimals)
    The number of decimals after the decimal point to use; -1 means automatic.
    default: -1
    minimum: -1
 

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	m_Compact	whether to output compact string (ie no blanks).
protected ArrayElementType	m_ElementType	the element type.
protected int	m_NumDecimals	the number of decimals.

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

Method Summary

Modifier and Type	Method	Description
Class	accepts()	Returns the class that is accepted as input.
protected String	checkData()	Checks whether the data can be processed.
String	compactTipText()	Returns the tip text for this property.
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.
boolean	getCompact()	Returns whether to output compact format (ie no spaces).
ArrayElementType	getElementType()	Returns the type of the element in the array.
int	getNumDecimals()	Returns the number of decimals after the decimal point to use.
String	getQuickInfo()	Returns a quick info about the actor, which will be displayed in the GUI.
String	globalInfo()	Returns a string describing the object.
String	numDecimalsTipText()	Returns the tip text for this property.
void	setCompact(boolean value)	Sets whether to output compact format (ie no spaces).
void	setElementType(ArrayElementType value)	Sets the type of the element in the array.
void	setNumDecimals(int value)	Sets the number of decimals after the decimal point to use.

Methods inherited from class adams.data.conversion.AbstractConversionToString

generates

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.

m_Compact

protected boolean m_Compact

whether to output compact string (ie no blanks).

m_NumDecimals

protected int m_NumDecimals

the number of decimals.

Constructor Detail

Mat5ArrayToString

public Mat5ArrayToString()

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.

setCompact

public void setCompact(boolean value)

Sets whether to output compact format (ie no spaces).

Parameters:

value - true if compact

getCompact

public boolean getCompact()

Returns whether to output compact format (ie no spaces).

Returns:

true if compact

compactTipText

public String compactTipText()

Returns the tip text for this property.

Returns:

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

setNumDecimals

public void setNumDecimals(int value)

Sets the number of decimals after the decimal point to use.

Parameters:

value - the number of decimals, -1 is automatic

getNumDecimals

public int getNumDecimals()

Returns the number of decimals after the decimal point to use.

Returns:

the number of decimals, -1 is automatic

numDecimalsTipText

public String numDecimalsTipText()

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

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

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