public class DatabaseLoader extends AbstractLoader implements BatchConverter, IncrementalConverter, DatabaseConverter, OptionHandler, EnvironmentHandler
-url <JDBC URL> The JDBC URL to connect to. (default: from DatabaseUtils.props file)
-user <name> The user to connect with to the database. (default: none)
-password <password> The password to connect with to the database. (default: none)
-Q <query> SQL query of the form SELECT <list of columns>|* FROM <table> [WHERE] to execute. (default: Select * From Results0)
-P <list of column names> List of column names uniquely defining a DB row (separated by ', '). Used for incremental loading. If not specified, the key will be determined automatically, if possible with the used JDBC driver. The auto ID column created by the DatabaseSaver won't be loaded.
-I Sets incremental loading
Loader
,
Serialized FormLoader.StructureNotReadyException
BATCH, INCREMENTAL, NONE
Constructor and Description |
---|
DatabaseLoader()
Constructor
|
Modifier and Type | Method and Description |
---|---|
void |
connectToDatabase()
Opens a connection to the database
|
java.lang.String |
customPropsFileTipText()
The tip text for this property.
|
java.io.File |
getCustomPropsFile()
Returns the custom properties file in use, if any.
|
Instances |
getDataSet()
Return the full data set in batch mode (header and all intances at once).
|
java.lang.String |
getKeys()
Gets the key columns' name
|
Instance |
getNextInstance(Instances structure)
Read the data set incrementally---get the next instance in the data set or
returns null if there are no more instances to get.
|
java.lang.String[] |
getOptions()
Gets the setting
|
java.lang.String |
getPassword()
Returns the database password
|
java.lang.String |
getQuery()
Gets the query to execute against the database
|
java.lang.String |
getRevision()
Returns the revision string.
|
boolean |
getSparseData()
Gets whether data is to be returned as a set of sparse instances
|
Instances |
getStructure()
Determines and returns (if possible) the structure (internally the header)
of the data set as an empty set of instances.
|
java.lang.String |
getUrl()
Gets the URL
|
java.lang.String |
getUser()
Gets the user name
|
java.lang.String |
globalInfo()
Returns a string describing this Loader
|
java.lang.String |
keysTipText()
the tip text for this property
|
java.util.Enumeration<Option> |
listOptions()
Lists the available options
|
static void |
main(java.lang.String[] options)
Main method.
|
java.lang.String |
passwordTipText()
the tip text for this property
|
java.lang.String |
queryTipText()
the tip text for this property
|
void |
reset()
Resets the Loader ready to read a new data set using set options
|
void |
resetOptions()
Resets the Loader to the settings in either the default DatabaseUtils.props
or any property file that the user has specified via setCustomPropsFile().
|
void |
resetStructure()
Resets the structure of instances
|
void |
setCustomPropsFile(java.io.File value)
Sets the custom properties file to use.
|
void |
setEnvironment(Environment env)
Set the environment variables to use.
|
void |
setKeys(java.lang.String keys)
Sets the key columns of a database table
|
void |
setOptions(java.lang.String[] options)
Sets the options.
|
void |
setPassword(java.lang.String password)
Sets user password for the database
|
void |
setQuery(java.lang.String q)
Sets the query to execute against the database
|
void |
setSource()
Sets the database url using the DatabaseUtils file
|
void |
setSource(java.lang.String url)
Sets the database url
|
void |
setSource(java.lang.String url,
java.lang.String userName,
java.lang.String password)
Sets the database url, user and pw
|
void |
setSparseData(boolean s)
Sets whether data should be encoded as sparse instances
|
void |
setUrl(java.lang.String url)
Sets the database URL
|
void |
setUser(java.lang.String user)
Sets the database user
|
java.lang.String |
sparseDataTipText()
Returns the tip text for this property
|
java.lang.String |
urlTipText()
the tip text for this property
|
java.lang.String |
userTipText()
the tip text for this property
|
setRetrieval, setSource, setSource
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
makeCopy
public DatabaseLoader() throws java.lang.Exception
java.lang.Exception
- if initialization failspublic java.lang.String globalInfo()
public void setEnvironment(Environment env)
setEnvironment
in interface EnvironmentHandler
env
- the environment variables to usepublic void resetOptions()
public void reset()
reset
in interface Loader
reset
in class AbstractLoader
java.lang.Exception
- if an error occurs while disconnecting from the databasepublic void resetStructure()
public void setQuery(java.lang.String q)
q
- the query to execute@OptionMetadata(displayName="Query", description="The query to execute", displayOrder=4) public java.lang.String getQuery()
public java.lang.String queryTipText()
public void setKeys(java.lang.String keys)
keys
- a String containing the key columns in a comma separated list.@OptionMetadata(displayName="Key columns", description="Specific key columns to use if a primary key cannot be automatically detected. Used in incremental loading.", displayOrder=5) public java.lang.String getKeys()
public java.lang.String keysTipText()
public void setCustomPropsFile(java.io.File value)
value
- the custom props file to load database parameters from, use
null or directory to disable custom properties.@OptionMetadata(displayName="DB config file", description="The custom properties that the user can use to override the default ones.", displayOrder=8) @FilePropertyMetadata(fileChooserDialogType=0, directoriesOnly=false) public java.io.File getCustomPropsFile()
public java.lang.String customPropsFileTipText()
public void setUrl(java.lang.String url)
setUrl
in interface DatabaseConverter
url
- string with the database URL@OptionMetadata(displayName="Database URL", description="The URL of the database", displayOrder=1) public java.lang.String getUrl()
getUrl
in interface DatabaseConverter
public java.lang.String urlTipText()
public void setUser(java.lang.String user)
setUser
in interface DatabaseConverter
user
- the database user name@OptionMetadata(displayName="Username", description="The user name for the database", displayOrder=2) public java.lang.String getUser()
getUser
in interface DatabaseConverter
public java.lang.String userTipText()
public void setPassword(java.lang.String password)
setPassword
in interface DatabaseConverter
password
- the password@OptionMetadata(displayName="Password", description="The database password", displayOrder=3) @PasswordProperty public java.lang.String getPassword()
public java.lang.String passwordTipText()
public java.lang.String sparseDataTipText()
public void setSparseData(boolean s)
s
- true if data should be encoded as a set of sparse instances@OptionMetadata(displayName="Create sparse instances", description="Return sparse rather than normal instances", displayOrder=6) public boolean getSparseData()
public void setSource(java.lang.String url, java.lang.String userName, java.lang.String password)
url
- the database urluserName
- the user namepassword
- the passwordpublic void setSource(java.lang.String url)
url
- the database urlpublic void setSource() throws java.lang.Exception
java.lang.Exception
- if something goes wrongpublic void connectToDatabase()
public Instances getStructure() throws java.io.IOException
getStructure
in interface Loader
getStructure
in class AbstractLoader
java.io.IOException
- if an error occurspublic Instances getDataSet() throws java.io.IOException
getDataSet
in interface Loader
getDataSet
in class AbstractLoader
java.io.IOException
- if there is no source or parsing failspublic Instance getNextInstance(Instances structure) throws java.io.IOException
getNextInstance
in interface Loader
getNextInstance
in class AbstractLoader
structure
- the dataset header information, will get updated in case
of string or relational attributesjava.io.IOException
- if there is an error during parsingpublic java.lang.String[] getOptions()
getOptions
in interface OptionHandler
public java.util.Enumeration<Option> listOptions()
listOptions
in interface OptionHandler
public void setOptions(java.lang.String[] options) throws java.lang.Exception
-url <JDBC URL> The JDBC URL to connect to. (default: from DatabaseUtils.props file)
-user <name> The user to connect with to the database. (default: none)
-password <password> The password to connect with to the database. (default: none)
-Q <query> SQL query of the form SELECT <list of columns>|* FROM <table> [WHERE] to execute. (default: Select * From Results0)
-P <list of column names> List of column names uniquely defining a DB row (separated by ', '). Used for incremental loading. If not specified, the key will be determined automatically, if possible with the used JDBC driver. The auto ID column created by the DatabaseSaver won't be loaded.
-I Sets incremental loading
setOptions
in interface OptionHandler
options
- the optionsjava.lang.Exception
- if options cannot be setpublic java.lang.String getRevision()
getRevision
in interface RevisionHandler
public static void main(java.lang.String[] options)
options
- the options