Package adams.data.conversion

Class ReplaceFileExtension

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

All Implemented Interfaces:

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

public class ReplaceFileExtension
extends AbstractStringConversion
implements ForwardSlashSupporter

Interprets the string as file name and replaces its extension with the provided one. If no extension is given, it simply removes it.

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

-extension <java.lang.String> (property: extension)
    The new extension to replace the old one with (incl dot); use empty string 
    to remove the extension; variables get expanded automatically.
    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
 

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	m_Extension	the new file extension to use.
protected boolean	m_UseForwardSlashes	whether to output forward slashes.

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

Method Summary

Modifier and Type	Method	Description
void	defineOptions()	Adds options to the internal list of options.
protected Object	doConvert()	Performs the actual conversion.
String	extensionTipText()	Returns the tip text for this property.
String	getExtension()	Returns the extension to use.
String	getQuickInfo()	Returns a quick info about the object, which can be displayed in the GUI.
boolean	getUseForwardSlashes()	Returns whether to use forward slashes in the output.
String	globalInfo()	Returns a string describing the object.
void	setExtension(String value)	Sets the extension to use.
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.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_Extension

protected String m_Extension

the new file extension to use.

m_UseForwardSlashes

protected boolean m_UseForwardSlashes

whether to output forward slashes.

Constructor Detail

ReplaceFileExtension

public ReplaceFileExtension()

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

setExtension

public void setExtension(String value)

Sets the extension to use.

Parameters:

value - the extension (incl dot!), empty string for removing the extension

getExtension

public String getExtension()

Returns the extension to use.

Returns:

the extension

extensionTipText

public String extensionTipText()

Returns the tip text for this property.

Returns:

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

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.

getQuickInfo

public String getQuickInfo()

Returns a quick info about the object, which can 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

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