Package adams.data.conversion
Class NotesSubset
-
- All Implemented Interfaces:
AdditionalInformationHandler
,CleanUpHandler
,Destroyable
,GlobalInfoSupporter
,LoggingLevelHandler
,LoggingSupporter
,OptionHandler
,QuickInfoSupporter
,ShallowCopySupporter<AbstractConversion>
,SizeOfHandler
,Stoppable
,Conversion
,Serializable
public class NotesSubset extends AbstractConversion
Generates a subset of a adams.data.Notes object.
-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel) The logging level for outputting errors and debugging output. default: WARNING
-output-errors <boolean> (property: outputErrors) If set to true, then the errors will be output. default: false
-output-warnings <boolean> (property: outputWarnings) If set to true, then the warnings will be output. default: false
-output-process-info <boolean> (property: outputProcessInformation) If set to true, then the process information will be output. default: false
-output-other <boolean> (property: outputOther) If set to true, then the other notes will be output. default: false
-output-all <boolean> (property: outputAll) If set to true, then everything will be output. 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_OutputAll
whether to output everything.protected boolean
m_OutputErrors
whether to output the errors.protected boolean
m_OutputOther
whether to output all other notes.protected boolean
m_OutputProcessInformation
whether to output the process information.protected boolean
m_OutputWarnings
whether to output the warnings.-
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 NotesSubset()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Class
accepts()
Returns the class that is accepted as input.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
getOutputAll()
Returns whether to output everything.boolean
getOutputErrors()
Returns whether to output the errors.boolean
getOutputOther()
Returns whether to output the other notes.boolean
getOutputProcessInformation()
Returns whether to output the process information.boolean
getOutputWarnings()
Returns whether to output the warnings.String
globalInfo()
Returns a string describing the object.String
outputAllTipText()
Returns the tip text for this property.String
outputErrorsTipText()
Returns the tip text for this property.String
outputOtherTipText()
Returns the tip text for this property.String
outputProcessInformationTipText()
Returns the tip text for this property.String
outputWarningsTipText()
Returns the tip text for this property.void
setOutputAll(boolean value)
Sets whether to output everything.void
setOutputErrors(boolean value)
Sets whether to output the errors.void
setOutputOther(boolean value)
Sets whether to output the other notes.void
setOutputProcessInformation(boolean value)
Sets whether to output the process information.void
setOutputWarnings(boolean value)
Sets whether to output the warnings.-
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.logging.LoggingLevelHandler
getLoggingLevel
-
-
-
-
Field Detail
-
m_OutputErrors
protected boolean m_OutputErrors
whether to output the errors.
-
m_OutputWarnings
protected boolean m_OutputWarnings
whether to output the warnings.
-
m_OutputProcessInformation
protected boolean m_OutputProcessInformation
whether to output the process information.
-
m_OutputOther
protected boolean m_OutputOther
whether to output all other notes.
-
m_OutputAll
protected boolean m_OutputAll
whether to output everything.
-
-
Method Detail
-
globalInfo
public String globalInfo()
Returns a string describing the object.- Specified by:
globalInfo
in interfaceGlobalInfoSupporter
- Specified by:
globalInfo
in classAbstractOptionHandler
- 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 interfaceOptionHandler
- Overrides:
defineOptions
in classAbstractOptionHandler
-
setOutputErrors
public void setOutputErrors(boolean value)
Sets whether to output the errors.- Parameters:
value
- if true then the errors will be output
-
getOutputErrors
public boolean getOutputErrors()
Returns whether to output the errors.- Returns:
- true if the errors will be output
-
outputErrorsTipText
public String outputErrorsTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setOutputWarnings
public void setOutputWarnings(boolean value)
Sets whether to output the warnings.- Parameters:
value
- if true then the warnings will be output
-
getOutputWarnings
public boolean getOutputWarnings()
Returns whether to output the warnings.- Returns:
- true if the warnings will be output
-
outputWarningsTipText
public String outputWarningsTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setOutputProcessInformation
public void setOutputProcessInformation(boolean value)
Sets whether to output the process information.- Parameters:
value
- if true then the process information will be output
-
getOutputProcessInformation
public boolean getOutputProcessInformation()
Returns whether to output the process information.- Returns:
- true if the process information will be output
-
outputProcessInformationTipText
public String outputProcessInformationTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setOutputOther
public void setOutputOther(boolean value)
Sets whether to output the other notes.- Parameters:
value
- if true then the other notes will be output
-
getOutputOther
public boolean getOutputOther()
Returns whether to output the other notes.- Returns:
- true if the other notes will be output
-
outputOtherTipText
public String outputOtherTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setOutputAll
public void setOutputAll(boolean value)
Sets whether to output everything.- Parameters:
value
- if true then everything will be output
-
getOutputAll
public boolean getOutputAll()
Returns whether to output everything.- Returns:
- true if everything will be output
-
outputAllTipText
public String outputAllTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
accepts
public Class accepts()
Returns the class that is accepted as input.- Specified by:
accepts
in interfaceConversion
- Specified by:
accepts
in classAbstractConversion
- Returns:
- the class
-
generates
public Class generates()
Returns the class that is generated as output.- Specified by:
generates
in interfaceConversion
- Specified by:
generates
in classAbstractConversion
- Returns:
- the class
-
doConvert
protected Object doConvert() throws Exception
Performs the actual conversion.- Specified by:
doConvert
in classAbstractConversion
- Returns:
- the converted data
- Throws:
Exception
- if something goes wrong with the conversion
-
-