AbstractSpreadSheetWriterWithMissingValueSupport (adams-pom 24.5.0-SNAPSHOT API)

java.lang.Object
- adams.core.logging.LoggingObject
- - adams.core.logging.CustomLoggingLevelObject
  - - adams.core.option.AbstractOptionHandler
    - - adams.data.io.output.AbstractSpreadSheetWriter
      - adams.data.io.output.AbstractSpreadSheetWriterWithMissingValueSupport

All Implemented Interfaces:

AdditionalInformationHandler, Destroyable, GlobalInfoSupporter, EncodingSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, Stoppable, StoppableWithFeedback, SpreadSheetWriter, Serializable

Direct Known Subclasses:

AbstractFormattedSpreadSheetWriter
```
public abstract class AbstractSpreadSheetWriterWithMissingValueSupport
extends AbstractSpreadSheetWriter
```
Ancestor for spreadsheet writers that support a custom missing value string.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from class adams.data.io.output.AbstractSpreadSheetWriter
  AbstractSpreadSheetWriter.OutputType

Field Summary

Fields
Modifier and Type Field Description

protected String m_MissingValue
The placeholder for missing values.
- Fields inherited from class adams.data.io.output.AbstractSpreadSheetWriter
  m_Encoding, 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

AbstractSpreadSheetWriterWithMissingValueSupport()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`defineOptions()`	Adds options to the internal list of options.
`protected String`	`getDefaultMissingValue()`	Returns the default missing value.
`String`	`getMissingValue()`	Returns the current placeholder for missing values.
`String`	`missingValueTipText()`	Returns the tip text for this property.
`void`	`setMissingValue(String value)`	Sets the placeholder for missing values.

Methods inherited from class adams.data.io.output.AbstractSpreadSheetWriter
canCompress, doWrite, doWrite, doWrite, encodingTipText, getAdditionalInformation, getDefaultFormatExtension, getEncoding, getFormatDescription, getFormatExtensions, getOutputType, getWriters, initialize, isStopped, preWriteFile, reset, setEncoding, stopExecution, supportsCompressedOutput, write, write, write, write

Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, globalInfo, 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.Destroyable
destroy

Methods inherited from interface adams.core.logging.LoggingLevelHandler
getLoggingLevel

Methods inherited from interface adams.core.option.OptionHandler
cleanUpOptions, getOptionManager, toCommandLine

Methods inherited from interface adams.data.io.output.SpreadSheetWriter
getCorrespondingReader

- Field Detail
  - m_MissingValue
```
protected String m_MissingValue
```
    The placeholder for missing values.
- Constructor Detail
  - AbstractSpreadSheetWriterWithMissingValueSupport
```
public AbstractSpreadSheetWriterWithMissingValueSupport()
```
- Method Detail
  - defineOptions
```
public void defineOptions()
```
    Adds options to the internal list of options.
    
    Specified by:
    
    defineOptions in interface OptionHandler
    
    Overrides:
    
    defineOptions in class AbstractOptionHandler
  - getDefaultMissingValue
```
protected String getDefaultMissingValue()
```
    Returns the default missing value.
    
    Returns:
    
    the default for missing values
  - setMissingValue
```
public void setMissingValue(String value)
```
    Sets the placeholder for missing values.
    
    Parameters:
    
    value - the placeholder
  - getMissingValue
```
public String getMissingValue()
```
    Returns the current placeholder for missing values.
    
    Returns:
    
    the placeholder
  - missingValueTipText
```
public String missingValueTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the explorer/experimenter gui