java.lang.Object
- adams.core.logging.LoggingObject
- - adams.core.logging.CustomLoggingLevelObject
  - - adams.core.option.AbstractOptionHandler
    - - adams.data.conversion.AbstractConversion
      - adams.data.conversion.SpreadSheetToDataset

All Implemented Interfaces:: AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<AbstractConversion>, SizeOfHandler, Stoppable, Conversion, Serializable

public class SpreadSheetToDataset
extends AbstractConversion

Turns a spreadsheet object into a dataset object.

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

-class-attribute <adams.data.spreadsheet.SpreadSheetColumnRange> (property: classAttribute)
    The columns to use as class attributes.
    default: last
    example: A range is a comma-separated list of single 1-based indices or sub-ranges of indices ('start-end'); 'inv(...)' inverts the range '...'; apart from column names (case-sensitive), the following placeholders can be used as well: first, second, third, last_2, last_1, last

Version:: $Revision$
Author:: fracpete (fracpete at waikato dot ac dot nz)
See Also:: Serialized Form

Field Summary

Fields
Modifier and Type Field Description

protected SpreadSheetColumnRange m_ClassAttribute
the attribute(s) to use as class attribute(s).
- 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

SpreadSheetToDataset()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Class`	`accepts()`	Returns the class that is accepted as input.
`String`	`classAttributeTipText()`	Returns the tip text for this property.
`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.
`SpreadSheetColumnRange`	`getClassAttribute()`	Returns the colums that identify a rowx
`String`	`getQuickInfo()`	Returns a quick info about the object, which can be displayed in the GUI.
`String`	`globalInfo()`	Returns a string describing the object.
`void`	`setClassAttribute(SpreadSheetColumnRange value)`	Sets the columns to use as class attributes.

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.logging.LoggingLevelHandler
getLoggingLevel

- Field Detail
  - m_ClassAttribute
```
protected SpreadSheetColumnRange m_ClassAttribute
```
    the attribute(s) to use as class attribute(s).
- Constructor Detail
  - SpreadSheetToDataset
```
public SpreadSheetToDataset()
```
- 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
  - setClassAttribute
```
public void setClassAttribute(SpreadSheetColumnRange value)
```
    Sets the columns to use as class attributes.
    
    Parameters:
    
    value - the range
  - getClassAttribute
```
public SpreadSheetColumnRange getClassAttribute()
```
    Returns the colums that identify a rowx
    
    Returns:
    
    the range
  - classAttributeTipText
```
public String classAttributeTipText()
```
    Returns the tip text for this property.
    
    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
  - accepts
```
public Class accepts()
```
    Returns the class that is accepted as input.
    
    Specified by:
    
    accepts in interface Conversion
    
    Specified by:
    
    accepts in class AbstractConversion
    
    Returns:
    
    the class
  - generates
```
public Class generates()
```
    Returns the class that is generated as output.
    
    Specified by:
    
    generates in interface Conversion
    
    Specified by:
    
    generates in class AbstractConversion
    
    Returns:
    
    the class
  - 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

Class SpreadSheetToDataset

Field Summary

Fields inherited from class adams.data.conversion.AbstractConversion

Fields inherited from class adams.core.option.AbstractOptionHandler

Fields inherited from class adams.core.logging.LoggingObject

Constructor Summary

Method Summary

Methods inherited from class adams.data.conversion.AbstractConversion

Methods inherited from class adams.core.option.AbstractOptionHandler

Methods inherited from class adams.core.logging.LoggingObject

Methods inherited from class java.lang.Object

Methods inherited from interface adams.core.logging.LoggingLevelHandler

Field Detail

m_ClassAttribute

Constructor Detail

SpreadSheetToDataset

Method Detail

globalInfo

defineOptions

setClassAttribute

getClassAttribute

classAttributeTipText

getQuickInfo

accepts

generates

doConvert