|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.xquark.extractor.Extractor
Extractor XML/DBC DataSource implementation.
Field Summary | |
static java.lang.String |
JNDI_SCHEME
|
Fields inherited from interface org.xquark.extractor.common.Constants |
CASE_LOWER, CASE_LOWER_TOKEN, CASE_MIXED, CASE_MIXED_TOKEN, CASE_UPPER, CASE_UPPER_TOKEN, ELEMENT_FORM_DEFAULT, EXCLUDES, INCLUDES, LABEL_DATASOURCE, LABEL_SPEC_ALIAS, LABEL_SPEC_CASE, LABEL_SPEC_CATALOG, LABEL_SPEC_COLUMN, LABEL_SPEC_DATABASE_NAME, LABEL_SPEC_DATABASE_VERSION, LABEL_SPEC_DESCRIPTION, LABEL_SPEC_DRIVER, LABEL_SPEC_ELEMENTFORMDEFAULT, LABEL_SPEC_EXCLUDES, LABEL_SPEC_INCLUDES, LABEL_SPEC_JNDI, LABEL_SPEC_NAME, LABEL_SPEC_PASSWORD, LABEL_SPEC_PK_COLUMN, LABEL_SPEC_REGEX, LABEL_SPEC_SCHEMA, LABEL_SPEC_SITE, LABEL_SPEC_SUBST, LABEL_SPEC_SUBST_CHAR, LABEL_SPEC_SUBST_NAMECASE, LABEL_SPEC_SUBST_SUBST, LABEL_SPEC_SUBST_VALUE, LABEL_SPEC_TABLE, LABEL_SPEC_TARGETNAMESPACE, LABEL_SPEC_URL, LABEL_SPEC_USER, LABEL_SPEC_VIEW, LABEL_SPEC_VIEW_NAME, NONE, QUALIFIED, UNQUALIFIED |
Constructor Summary | |
Extractor(java.sql.Connection jdbcConnection)
Deprecated. prevents the use of an external or internal data source. |
|
Extractor(java.sql.Connection jdbcConnection,
java.lang.String configURL)
Deprecated. prevents the use of a full-featured internal data source. |
|
Extractor(java.sql.Connection jdbcConnection,
java.lang.String configURL,
java.lang.ClassLoader loader)
Deprecated. prevents the use of a full-featured internal data source. |
|
Extractor(javax.sql.DataSource ds)
Constructor to use with a JDBC data source. |
|
Extractor(javax.sql.DataSource ds,
java.io.File configFile)
Constructor to use with a JDBC data source and an extractor configuration file. |
|
Extractor(javax.sql.DataSource ds,
java.lang.String configURL)
Constructor to use with a JDBC data source and an extractor configuration file URL. |
|
Extractor(java.io.File configFile)
Constructor to use with an extractor configuration file. |
|
Extractor(java.io.File configFile,
java.lang.ClassLoader loader)
Constructor to use with an extractor configuration file. |
|
Extractor(java.lang.String configURI)
Constructor to use with a configuration file URL or a JNDI name referencing a JDBC datasource instance. |
|
Extractor(java.lang.String configURI,
java.lang.ClassLoader loader)
Constructor to use with a configuration file URL or a JNDI name referencing a JDBC datasource instance. |
|
Extractor(java.lang.String jdbcURL,
java.lang.String username,
java.lang.String password)
Construction to use when JDBC connection parameters are available. |
|
Extractor(java.lang.String jdbcURL,
java.lang.String username,
java.lang.String password,
java.lang.ClassLoader loader)
Construction to use when JDBC connection parameters are available. |
Method Summary | |
void |
close()
Closes the extractor and the underlying resources among which the internal JDBC data source except if it was passed at construction time. |
XMLConnection |
getConnection()
Creates a new XML/DBC connection instance. |
XMLConnection |
getConnection(java.lang.String user,
java.lang.String password)
Not implemented by Extractor. |
ExtractorConnection |
getExtractorConnection()
Creates a new XML/DBC connection instance for the extractor, avoiding a cast on getConnection() to access Extractor specific features. |
javax.sql.DataSource |
getJdbcDataSource()
Returns the internal JDBC data source. |
int |
getLoginTimeout()
Get the internal JDBC datasource login timeout. |
java.io.PrintWriter |
getLogWriter()
Get the internal JDBC datasource log writer. |
java.lang.String |
getURL()
Gets the XML/DBC URL of the Extractor (XML data source). |
java.lang.String |
getUserName()
Gets the user name used to log to the Extractor. |
void |
setLoginTimeout(int seconds)
Set the internal JDBC datasource login timeout. |
void |
setLogWriter(java.io.PrintWriter writer)
Sets the internal JDBC datasource log writer. |
void |
setUseScrollableResultSets(boolean use)
To indicate the Extractor that scrollable JDBC result sets must be used. |
boolean |
useScrollableResultSets()
Accessor to the "use scrollable result set" option. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String JNDI_SCHEME
Constructor Detail |
public Extractor(java.lang.String configURI) throws XMLDBCException
configURI
- either a file URL, or a JNDI reference that MUST be
prefixed with the "jndi:" string to be recognized as this.
XMLDBCException
public Extractor(java.lang.String configURI, java.lang.ClassLoader loader) throws XMLDBCException
configURI
- either a file URL, or a JNDI reference that MUST be
prefixed with the "jndi:" string to be recognized as this.loader
- an application-provided class loader that will be used to
load JDBC drivers.
XMLDBCException
public Extractor(java.io.File configFile) throws XMLDBCException
configFile
- a Java symbolic file
XMLDBCException
public Extractor(java.io.File configFile, java.lang.ClassLoader loader) throws XMLDBCException
configFile
- a Java symbolic fileloader
- an application-provided class loader that will be used to
load JDBC drivers.
XMLDBCException
public Extractor(javax.sql.DataSource ds) throws XMLDBCException
ds
- a JDBC data source.
XMLDBCException
public Extractor(javax.sql.DataSource ds, java.lang.String configURL) throws XMLDBCException
ds
- a JDBC data source.configURL
- the URL of the configuration file.
XMLDBCException
public Extractor(javax.sql.DataSource ds, java.io.File configFile) throws XMLDBCException
ds
- a JDBC data source.configFile
- a Java symbolic file
XMLDBCException
public Extractor(java.lang.String jdbcURL, java.lang.String username, java.lang.String password) throws XMLDBCException
jdbcURL
- the JDBC URL of the JDBC data source.username
- the login name for the JDBC data source.password
- the password for the login name.
XMLDBCException
public Extractor(java.lang.String jdbcURL, java.lang.String username, java.lang.String password, java.lang.ClassLoader loader) throws XMLDBCException
jdbcURL
- the JDBC URL of the JDBC data source.username
- the login name for the JDBC data source.password
- the password for the login name.loader
- an application-provided class loader that will be used to
load JDBC drivers.
XMLDBCException
public Extractor(java.sql.Connection jdbcConnection) throws XMLDBCException
jdbcConnection
- a jdbc connection.
XMLDBCException
public Extractor(java.sql.Connection jdbcConnection, java.lang.String configURL) throws XMLDBCException
jdbcConnection
- a jdbc connection.configURL
- the URL of the configuration file.
XMLDBCException
public Extractor(java.sql.Connection jdbcConnection, java.lang.String configURL, java.lang.ClassLoader loader) throws XMLDBCException
jdbcConnection
- a jdbc connection.configURL
- the URL of the configuration file.loader
- an application-provided class loader that will be used to
load JDBC drivers.
XMLDBCException
Method Detail |
public void setLogWriter(java.io.PrintWriter writer)
setLogWriter
in interface XMLDataSource
writer
- public java.io.PrintWriter getLogWriter()
getLogWriter
in interface XMLDataSource
public void setLoginTimeout(int seconds)
setLoginTimeout
in interface XMLDataSource
seconds
- the login timeout in seconds.public int getLoginTimeout()
getLoginTimeout
in interface XMLDataSource
public void close() throws XMLDBCException
XMLDBCException
public javax.sql.DataSource getJdbcDataSource()
public XMLConnection getConnection() throws XMLDBCException
getConnection
in interface XMLDataSource
XMLDBCException
public ExtractorConnection getExtractorConnection() throws XMLDBCException
getConnection()
to access Extractor specific features.
XMLDBCException
public XMLConnection getConnection(java.lang.String user, java.lang.String password) throws XMLDBCException
getConnection
in interface XMLDataSource
user
- the data source registered userpassword
- the user's password
XMLDBCException
- If a data source access error occursXMLDataSource.getConnection(java.lang.String, java.lang.String)
public boolean useScrollableResultSets()
public void setUseScrollableResultSets(boolean use)
public java.lang.String getUserName()
public java.lang.String getURL()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |