Package adams.data.conversion

Class StringToFile

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

All Implemented Interfaces:

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

public class StringToFile
extends AbstractConversionFromString

Turns a String into a File object. Optionally, the file name part (excluding the parent path) can be fixed to make it file-system compliant. E.g., ':' is not allowed on MS Windows systems.

Valid options are:

-D <int> (property: debugLevel)
    The greater the number the more additional info the scheme may output to
    the console (0 = off).
    default: 0
    minimum: 0
 

-placeholderfile (property: createPlaceholderFileObjects)
    If enabled, PlaceholderFile objects instead of simple File objects are created.
 

-make-compliant (property: makeCompliant)
    If enabled, the file name part of the file (excluding the parent path) is
    made file-system compliant; compliant characters: abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789
    _-.,()
 

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	m_CreatePlaceholderFileObjects	whether to generate PlaceholderFile objects instead.
protected boolean	m_MakeCompliant	whether to fix the name part of the filename, in order to make it file-system compliant.

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

Method Summary

Modifier and Type	Method	Description
String	createPlaceholderFileObjectsTipText()	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.
boolean	getCreatePlaceholderFileObjects()	Returns whether to create PlaceholderFile objects instead.
boolean	getMakeCompliant()	Returns whether to make the file name part file-system compliant.
String	globalInfo()	Returns a string describing the object.
String	makeCompliantTipText()	Returns the tip text for this property.
void	setCreatePlaceholderFileObjects(boolean value)	Sets whether to create PlaceholderFile objects instead.
void	setMakeCompliant(boolean value)	Sets whether to make the file name part file-system compliant.

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, 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.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.QuickInfoSupporter

getQuickInfo

Methods inherited from interface adams.core.Stoppable

stopExecution

Field Detail

m_CreatePlaceholderFileObjects

protected boolean m_CreatePlaceholderFileObjects

whether to generate PlaceholderFile objects instead.

m_MakeCompliant

protected boolean m_MakeCompliant

whether to fix the name part of the filename, in order to make it file-system compliant.

Constructor Detail

StringToFile

public StringToFile()

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

setCreatePlaceholderFileObjects

public void setCreatePlaceholderFileObjects(boolean value)

Sets whether to create PlaceholderFile objects instead.

Parameters:

value - if true then PlaceholderFile objects are created

getCreatePlaceholderFileObjects

public boolean getCreatePlaceholderFileObjects()

Returns whether to create PlaceholderFile objects instead.

Returns:

true if PlaceholderFile objects are created

createPlaceholderFileObjectsTipText

public String createPlaceholderFileObjectsTipText()

Returns the tip text for this property.

Returns:

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

setMakeCompliant

public void setMakeCompliant(boolean value)

Sets whether to make the file name part file-system compliant.

Parameters:

value - if true then file name part is made file-system compliant

getMakeCompliant

public boolean getMakeCompliant()

Returns whether to make the file name part file-system compliant.

Returns:

true if the file name part is made file-system compliant

makeCompliantTipText

public String makeCompliantTipText()

Returns the tip text for this property.

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