Package adams.data.conversion

Class StringToValidFileName

java.lang.Object

adams.core.logging.LoggingObject

adams.core.logging.CustomLoggingLevelObject

adams.core.option.AbstractOptionHandler

adams.data.conversion.AbstractConversion

adams.data.conversion.AbstractStringConversion

adams.data.conversion.AbstractValidateString

adams.data.conversion.StringToValidFileName

All Implemented Interfaces:

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

public class StringToValidFileName
extends AbstractValidateString
implements ForwardSlashSupporter

Turns any string into a valid file name.

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

-replace <java.lang.String> (property: replace)
    The replacement string for invalid characters in strings; use empty string 
    for removing the invalid characters instead of replacing them.
    default: 
 

-use-forward-slashes <boolean> (property: useForwardSlashes)
    If enabled, forward slashes are used in the output (but the '\\' prefix 
    of UNC paths is not converted).
    default: false
 

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_UseForwardSlashes	whether to output forward slashes.

Fields inherited from class adams.data.conversion.AbstractValidateString

m_Replace

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
boolean	getUseForwardSlashes()	Returns whether to use forward slashes in the output.
String	globalInfo()	Returns a string describing the object.
protected String	process(String input, String replace)	Performs the actual validation.
void	setUseForwardSlashes(boolean value)	Sets whether to use forward slashes in the output.
String	useForwardSlashesTipText()	Returns the tip text for this property.

Methods inherited from class adams.data.conversion.AbstractValidateString

doConvert, getDefaultReplace, getQuickInfo, getReplace, replaceTipText, setReplace

Methods inherited from class adams.data.conversion.AbstractStringConversion

accepts, generates

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_UseForwardSlashes

protected boolean m_UseForwardSlashes

whether to output forward slashes.

Constructor Detail

StringToValidFileName

public StringToValidFileName()

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 AbstractValidateString

setUseForwardSlashes

public void setUseForwardSlashes(boolean value)

Sets whether to use forward slashes in the output.

Specified by:

setUseForwardSlashes in interface ForwardSlashSupporter

Parameters:

value - if true then use forward slashes

getUseForwardSlashes

public boolean getUseForwardSlashes()

Returns whether to use forward slashes in the output.

Specified by:

getUseForwardSlashes in interface ForwardSlashSupporter

Returns:

true if forward slashes are used

useForwardSlashesTipText

public String useForwardSlashesTipText()

Returns the tip text for this property.

Specified by:

useForwardSlashesTipText in interface ForwardSlashSupporter

Returns:

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

process

protected String process(String input,
                         String replace)
                  throws Exception

Performs the actual validation.

Specified by:

process in class AbstractValidateString

Parameters:

input - the input string

replace - the replacement string for invalide characters

Throws:

Exception