Package adams.data.conversion
Class SpreadSheetColumnsToReport
- java.lang.Object
-
- adams.core.logging.LoggingObject
-
- adams.core.logging.CustomLoggingLevelObject
-
- adams.core.option.AbstractOptionHandler
-
- adams.data.conversion.AbstractConversion
-
- adams.data.conversion.SpreadSheetColumnsToReport
-
- All Implemented Interfaces:
AdditionalInformationHandler
,CleanUpHandler
,Destroyable
,GlobalInfoSupporter
,LenientModeSupporter
,LoggingLevelHandler
,LoggingSupporter
,OptionHandler
,QuickInfoSupporter
,ShallowCopySupporter<AbstractConversion>
,SizeOfHandler
,Stoppable
,Conversion
,Serializable
public class SpreadSheetColumnsToReport extends AbstractConversion implements LenientModeSupporter
Turns spreadsheet columns into reports.
-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel) The logging level for outputting errors and debugging output. default: WARNING
-col-report-names <adams.data.spreadsheet.SpreadSheetColumnIndex> (property: colReportNames) The (optional) column that contains the report names. default: example: An index is a number starting with 1; column names (case-sensitive) as well as the following placeholders can be used: first, second, third, last_2, last_1, last; numeric indices can be enforced by preceding them with '#' (eg '#12'); column names can be surrounded by double quotes.
-cols-report-values <adams.data.spreadsheet.SpreadSheetColumnRange> (property: colsReportValues) The columns to get the report values from. default: example: A range is a comma-separated list of single 1-based indices or sub-ranges of indices ('start-end'); 'inv(...)' inverts the range '...'; column names (case-sensitive) as well as the following placeholders can be used: first, second, third, last_2, last_1, last; numeric indices can be enforced by preceding them with '#' (eg '#12'); column names can be surrounded by double quotes.
-rows-report <adams.data.spreadsheet.SpreadSheetRowRange> (property: rowsReport) The rows that contain report. default: example: A range is a comma-separated list of single 1-based indices or sub-ranges of indices ('start-end'); 'inv(...)' inverts the range '...'; the following placeholders can be used as well: first, second, third, last_2, last_1, last
-lenient <boolean> (property: lenient) If enabled, then errors (e.g., due to corrupt data) will not cause exceptions. default: false
- Author:
- fracpete (fracpete at waikato dot ac dot nz)
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected SpreadSheetColumnIndex
m_ColReportNames
the column with the report names.protected SpreadSheetColumnRange
m_ColsReportValues
the columns with the report values.protected boolean
m_Lenient
whether to skip over errors.protected SpreadSheetRowRange
m_RowsReport
the rows to get the report from.-
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 SpreadSheetColumnsToReport()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Class
accepts()
Returns the class that is accepted as input.String
colReportNamesTipText()
Returns the tip text for this property.String
colsReportValuesTipText()
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.SpreadSheetColumnIndex
getColReportNames()
Returns the column that contains the report names.SpreadSheetColumnRange
getColsReportValues()
Returns the columns to get the report values from.boolean
getLenient()
Returns whether whether to skip over errors.String
getQuickInfo()
Returns a quick info about the object, which can be displayed in the GUI.SpreadSheetRowRange
getRowsReport()
Returns the rows with report.String
globalInfo()
Returns a string describing the object.String
lenientTipText()
Returns the tip text for this property.String
rowsReportTipText()
Returns the tip text for this property.void
setColReportNames(SpreadSheetColumnIndex value)
Sets the column that contains the report names.void
setColsReportValues(SpreadSheetColumnRange value)
Sets the columns to get the report values from.void
setLenient(boolean value)
Sets whether to skip over errors.void
setRowsReport(SpreadSheetRowRange value)
Sets the rows with report.-
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_ColReportNames
protected SpreadSheetColumnIndex m_ColReportNames
the column with the report names.
-
m_ColsReportValues
protected SpreadSheetColumnRange m_ColsReportValues
the columns with the report values.
-
m_RowsReport
protected SpreadSheetRowRange m_RowsReport
the rows to get the report from.
-
m_Lenient
protected boolean m_Lenient
whether to skip over errors.
-
-
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
-
setColReportNames
public void setColReportNames(SpreadSheetColumnIndex value)
Sets the column that contains the report names.- Parameters:
value
- the column
-
getColReportNames
public SpreadSheetColumnIndex getColReportNames()
Returns the column that contains the report names.- Returns:
- the column
-
colReportNamesTipText
public String colReportNamesTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setRowsReport
public void setRowsReport(SpreadSheetRowRange value)
Sets the rows with report.- Parameters:
value
- the rows
-
getRowsReport
public SpreadSheetRowRange getRowsReport()
Returns the rows with report.- Returns:
- the rows
-
rowsReportTipText
public String rowsReportTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setColsReportValues
public void setColsReportValues(SpreadSheetColumnRange value)
Sets the columns to get the report values from.- Parameters:
value
- the columns
-
getColsReportValues
public SpreadSheetColumnRange getColsReportValues()
Returns the columns to get the report values from.- Returns:
- the columns
-
colsReportValuesTipText
public String colsReportValuesTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setLenient
public void setLenient(boolean value)
Sets whether to skip over errors.- Specified by:
setLenient
in interfaceLenientModeSupporter
- Parameters:
value
- true if to skip
-
getLenient
public boolean getLenient()
Returns whether whether to skip over errors.- Specified by:
getLenient
in interfaceLenientModeSupporter
- Returns:
- true if to skip
-
lenientTipText
public String lenientTipText()
Returns the tip text for this property.- Specified by:
lenientTipText
in interfaceLenientModeSupporter
- 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
-
getQuickInfo
public String getQuickInfo()
Returns a quick info about the object, which can be displayed in the GUI.- Specified by:
getQuickInfo
in interfaceQuickInfoSupporter
- Overrides:
getQuickInfo
in classAbstractConversion
- Returns:
- null if no info available, otherwise short string
-
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
-
-