Package adams.data.conversion

Class EscapeLatexCharacters

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

All Implemented Interfaces:

adams.core.AdditionalInformationHandler, adams.core.CleanUpHandler, adams.core.Destroyable, adams.core.GlobalInfoSupporter, adams.core.logging.LoggingLevelHandler, adams.core.logging.LoggingSupporter, adams.core.option.OptionHandler, adams.core.QuickInfoSupporter, adams.core.ShallowCopySupporter<adams.data.conversion.AbstractConversion>, adams.core.SizeOfHandler, adams.core.Stoppable, adams.data.conversion.Conversion, adams.data.conversion.ConversionFromString, adams.data.conversion.ConversionToString, Serializable

public class EscapeLatexCharacters
extends adams.data.conversion.AbstractStringConversion

Turns the selected characters into their LaTeX representation.

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

-character <PERCENTAGE|UNDERSCORE|DOLLAR|AMPERSAND|CARET|BACKSLASH> [-character ...] (property: characters)
    The characters to escape.
    default: 
 

Version:

$Revision$

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EscapeLatexCharacters.Characters	The characters to escape.

Field Summary

Fields

Modifier and Type	Field	Description
protected EscapeLatexCharacters.Characters[]	m_Characters	the characters to escaped.

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

Method Summary

Modifier and Type	Method	Description
String	charactersTipText()	Returns the tip text for this property.
void	defineOptions()	Adds options to the internal list of options.
protected Object	doConvert()	Performs the actual conversion.
EscapeLatexCharacters.Characters[]	getCharacters()	Returns the characters to escape.
String	globalInfo()	Returns a string describing the object.
void	setCharacters(EscapeLatexCharacters.Characters[] value)	Sets the characters to escape.

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, 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_Characters

protected EscapeLatexCharacters.Characters[] m_Characters

the characters to escaped.

Constructor Detail

EscapeLatexCharacters

public EscapeLatexCharacters()

Method Detail

globalInfo

public String globalInfo()

Returns a string describing the object.

Specified by:

globalInfo in interface adams.core.GlobalInfoSupporter

Specified by:

globalInfo in class adams.core.option.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 adams.core.option.OptionHandler

Overrides:

defineOptions in class adams.core.option.AbstractOptionHandler

setCharacters

public void setCharacters(EscapeLatexCharacters.Characters[] value)

Sets the characters to escape.

Parameters:

value - the characters

getCharacters

public EscapeLatexCharacters.Characters[] getCharacters()

Returns the characters to escape.

Returns:

the characters

charactersTipText

public String charactersTipText()

Returns the tip text for this property.

Returns:

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

doConvert

protected Object doConvert()
                    throws Exception

Performs the actual conversion.

Specified by:

doConvert in class adams.data.conversion.AbstractConversion

Returns:

the converted data

Throws:

Exception - if something goes wrong with the conversion