org.knime.core.node.port.database
Class DatabaseQueryConnectionSettings

java.lang.Object
  org.knime.core.node.port.database.DatabaseConnectionSettings
      org.knime.core.node.port.database.DatabaseQueryConnectionSettings

public final class DatabaseQueryConnectionSettings
extends DatabaseConnectionSettings

Author:

Thomas Gabriel, University of Konstanz

Field Summary

static String

TABLE_PLACEHOLDER Table place holder #table#.

Fields inherited from class org.knime.core.node.port.database.DatabaseConnectionSettings

CFG_STATEMENT, DATABASE_URLS, DRIVER_ORDER, FETCH_SIZE

Constructor Summary

DatabaseQueryConnectionSettings(ConfigRO settings, CredentialsProvider cp)
Create a new connection with an empty query object.

DatabaseQueryConnectionSettings(DatabaseConnectionSettings conn, String query)
Creates a new connection based in the given connection and the query string.

Method Summary

ModelContentRO	createConnectionModel() Create connection model with all settings used to create a database connection.
String	getQuery()
void	saveConnection(ConfigWO settings) Save settings.
void	validateConnection(ConfigRO settings, CredentialsProvider cp) Validate settings.

Methods inherited from class org.knime.core.node.port.database.DatabaseConnectionSettings

createConnection, createConnection, execute, getDBName, getDriver, getPassword, getPassword, getUserName, getUserName, loadValidatedConnection, setDBName, setDriver, setPassword, setUserName, syncConnection

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TABLE_PLACEHOLDER

public static final String TABLE_PLACEHOLDER

Table place holder #table#.

See Also:

Constant Field Values

Constructor Detail

DatabaseQueryConnectionSettings

public DatabaseQueryConnectionSettings(ConfigRO settings,
                                       CredentialsProvider cp)
                                throws InvalidSettingsException

Create a new connection with an empty query object.

Parameters:

settings - settings to load from

cp - credentials provider used to get user name and password

Throws:

InvalidSettingsException - if settings could not be loaded

DatabaseQueryConnectionSettings

public DatabaseQueryConnectionSettings(DatabaseConnectionSettings conn,
                                       String query)

Creates a new connection based in the given connection and the query string.

Parameters:

conn - connection to copy

query - the SQL query

Method Detail

validateConnection

public void validateConnection(ConfigRO settings,
                               CredentialsProvider cp)
                        throws InvalidSettingsException

Validate settings.

Overrides:

validateConnection in class DatabaseConnectionSettings

Parameters:

settings - to validate

cp - CredentialProvider used to get user name/password

Throws:

InvalidSettingsException - if the settings are not valid

saveConnection

public void saveConnection(ConfigWO settings)

Save settings.

Overrides:

saveConnection in class DatabaseConnectionSettings

Parameters:

settings - connection settings

getQuery

public String getQuery()

Returns:

SQL statement

createConnectionModel

public ModelContentRO createConnectionModel()

Create connection model with all settings used to create a database connection.

Overrides:

createConnectionModel in class DatabaseConnectionSettings

Returns:

database connection model