Package adams.data.conversion

Class StringToObject

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.StringToObject

All Implemented Interfaces:

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

public class StringToObject
extends AbstractConversionFromString
implements LenientModeSupporter

Converts the JSON string into an object of the specified class.

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

-classname <adams.core.base.BaseClassname> (property: classname)
    The classname to converting the incoming JSON string to.
    default: adams.flow.core.Unknown
 

-lenient <boolean> (property: lenient)
    If enabled, unknown properties won't cause an error.
    default: false
 

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected BaseClassname	m_Classname	the class to convert to.
protected boolean	m_Lenient	whether to use lenient mode.

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

Method Summary

Modifier and Type	Method	Description
String	classnameTipText()	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.
BaseClassname	getClassname()	Returns the classname.
boolean	getLenient()	Returns whether to parse JSON in lenient mode or not.
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	lenientTipText()	Returns the tip text for this property.
void	setClassname(BaseClassname value)	Sets the classname.
void	setLenient(boolean value)	Sets whether to parse JSON in lenient mode or not.

Methods inherited from class adams.data.conversion.AbstractConversionFromString

accepts

Methods inherited from class adams.data.conversion.AbstractConversion

checkData, 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_Classname

protected BaseClassname m_Classname

the class to convert to.

m_Lenient

protected boolean m_Lenient

whether to use lenient mode.

Constructor Detail

StringToObject

public StringToObject()

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

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

setClassname

public void setClassname(BaseClassname value)

Sets the classname.

Parameters:

value - the classname

getClassname

public BaseClassname getClassname()

Returns the classname.

Returns:

the classname

classnameTipText

public String classnameTipText()

Returns the tip text for this property.

Returns:

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

setLenient

public void setLenient(boolean value)

Sets whether to parse JSON in lenient mode or not. Latter will raise an exception if unknown properties are encountered.

Specified by:

setLenient in interface LenientModeSupporter

Parameters:

value - true if lenient

getLenient

public boolean getLenient()

Returns whether to parse JSON in lenient mode or not. Latter will raise an exception if unknown properties are encountered.

Specified by:

getLenient in interface LenientModeSupporter

Returns:

true if lenient

lenientTipText

public String lenientTipText()

Returns the tip text for this property.

Specified by:

lenientTipText in interface LenientModeSupporter

Returns:

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

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