Package adams.data.conversion
Class SpreadSheetToCreateTableStatement
- java.lang.Object
-
- adams.core.logging.LoggingObject
-
- adams.core.logging.CustomLoggingLevelObject
-
- adams.core.option.AbstractOptionHandler
-
- adams.data.conversion.AbstractConversion
-
- adams.data.conversion.SpreadSheetToCreateTableStatement
-
- All Implemented Interfaces:
AdditionalInformationHandler,CleanUpHandler,Destroyable,GlobalInfoSupporter,LoggingLevelHandler,LoggingSupporter,OptionHandler,QuickInfoSupporter,ShallowCopySupporter<AbstractConversion>,SizeOfHandler,Stoppable,Conversion,Serializable
public class SpreadSheetToCreateTableStatement extends AbstractConversion
Turns a spreadsheet into a SQL 'CREATE TABLE' statement.
Requires two columns: column names, SQL column types.
An optional 3rd column can be used to indicate whether a column is to be used as an index (boolean).
-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel) The logging level for outputting errors and debugging output. default: WARNING
-table-name <java.lang.String> (property: tableName) The name of the table. default: newtable
-name-column <adams.data.spreadsheet.SpreadSheetColumnIndex> (property: nameColumn) The column in the spreadsheet that holds the name of the table columns. default: 1 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.
-type-column <adams.data.spreadsheet.SpreadSheetColumnIndex> (property: typeColumn) The column in the spreadsheet that holds the SQL types for the table columns. default: 2 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.
-index-column <adams.data.spreadsheet.SpreadSheetColumnIndex> (property: indexColumn) The column in the spreadsheet that indicates whether a column should be an index. default: 3 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.
- Version:
- $Revision$
- Author:
- fracpete (fracpete at waikato dot ac dot nz)
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected SpreadSheetColumnIndexm_IndexColumnthe colum with the indicator for index (optional).protected SpreadSheetColumnIndexm_NameColumnthe name colum.protected Stringm_TableNamethe name of the table to create.protected SpreadSheetColumnIndexm_TypeColumnthe type colum.-
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 SpreadSheetToCreateTableStatement()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Classaccepts()Returns the class that is accepted as input.voiddefineOptions()Adds options to the internal list of options.protected ObjectdoConvert()Performs the actual conversion.Classgenerates()Returns the class that is generated as output.SpreadSheetColumnIndexgetIndexColumn()Returns the index column.SpreadSheetColumnIndexgetNameColumn()Returns the name column.StringgetTableName()Returns the name of the table.SpreadSheetColumnIndexgetTypeColumn()Returns the type column.StringglobalInfo()Returns a string describing the object.StringindexColumnTipText()Returns the tip text for this property.StringnameColumnTipText()Returns the tip text for this property.voidsetIndexColumn(SpreadSheetColumnIndex index)Sets the index column.voidsetNameColumn(SpreadSheetColumnIndex value)Sets the name column.voidsetTableName(String value)Sets the name of the table.voidsetTypeColumn(SpreadSheetColumnIndex type)Sets the type column.StringtableNameTipText()Returns the tip text for this property.StringtypeColumnTipText()Returns the tip text for this property.-
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_TableName
protected String m_TableName
the name of the table to create.
-
m_NameColumn
protected SpreadSheetColumnIndex m_NameColumn
the name colum.
-
m_TypeColumn
protected SpreadSheetColumnIndex m_TypeColumn
the type colum.
-
m_IndexColumn
protected SpreadSheetColumnIndex m_IndexColumn
the colum with the indicator for index (optional).
-
-
Method Detail
-
globalInfo
public String globalInfo()
Returns a string describing the object.- Specified by:
globalInfoin interfaceGlobalInfoSupporter- Specified by:
globalInfoin classAbstractOptionHandler- Returns:
- a description suitable for displaying in the gui
-
defineOptions
public void defineOptions()
Adds options to the internal list of options.- Specified by:
defineOptionsin interfaceOptionHandler- Overrides:
defineOptionsin classAbstractOptionHandler
-
setTableName
public void setTableName(String value)
Sets the name of the table.- Parameters:
value- the name
-
getTableName
public String getTableName()
Returns the name of the table.- Returns:
- the name
-
tableNameTipText
public String tableNameTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setNameColumn
public void setNameColumn(SpreadSheetColumnIndex value)
Sets the name column.- Parameters:
value- the column
-
getNameColumn
public SpreadSheetColumnIndex getNameColumn()
Returns the name column.- Returns:
- the column
-
nameColumnTipText
public String nameColumnTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setTypeColumn
public void setTypeColumn(SpreadSheetColumnIndex type)
Sets the type column.- Parameters:
type- the column
-
getTypeColumn
public SpreadSheetColumnIndex getTypeColumn()
Returns the type column.- Returns:
- the column
-
typeColumnTipText
public String typeColumnTipText()
Returns the tip text for this property.- Returns:
- tip text for this property suitable for displaying in the GUI or for listing the options.
-
setIndexColumn
public void setIndexColumn(SpreadSheetColumnIndex index)
Sets the index column.- Parameters:
index- the column
-
getIndexColumn
public SpreadSheetColumnIndex getIndexColumn()
Returns the index column.- Returns:
- the column
-
indexColumnTipText
public String indexColumnTipText()
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:
acceptsin interfaceConversion- Specified by:
acceptsin classAbstractConversion- Returns:
- the class
-
generates
public Class generates()
Returns the class that is generated as output.- Specified by:
generatesin interfaceConversion- Specified by:
generatesin classAbstractConversion- Returns:
- the class
-
doConvert
protected Object doConvert() throws Exception
Performs the actual conversion.- Specified by:
doConvertin classAbstractConversion- Returns:
- the converted data
- Throws:
Exception- if something goes wrong with the conversion
-
-