javax.xml.xquery
Interface XQDatasource

All Superinterfaces:
XQDataFactory
All Known Implementing Classes:
IPSIXQDataSource, XQAbstractDataSource

public interface XQDatasource
extends XQDataFactory

Author:
Michael Stark

Method Summary
 XQConnection getConnection()
          Attempts to create a connection to an XML datasource.
 XQConnection getConnection(java.sql.Connection con)
          Attempts to create a connection to the XML datasource using an existing JDBC connection.
 XQConnection getConnection(java.lang.String username, java.lang.String passwd)
          Attempts to establish a connection to an XML datasource.
 int getLoginTimeout()
          Gets the maximum time in seconds that this datasource can wait while attempting to connect to a database.
 java.io.PrintWriter getLogWriter()
          Retrieves the log writer for this XQDataSource object.
 java.lang.String getProperty(java.lang.String name)
          Returns the current value of the named property if set, else null.
 java.lang.String[] getSupportedPropertyNames()
          Returns an array containing the property names supported by this XQDataSource.
 void setCommonHandler(XQCommonHandler hdlr)
          Sets the default common handler to be used for converting items to and from Java objects in the setObject and getObject methods on an item.
 void setLoginTimeout(int seconds)
          Sets the maximum time in seconds that this datasource will wait while attempting to connect to a database.
 void setLogWriter(java.io.PrintWriter out)
          Sets the log writer for this XQDataSource object to the given java.io.PrintWriter object.
 void setProperties(java.util.Properties props)
          Sets the data source properties from the specified Properties instance.
 void setProperty(java.lang.String name, java.lang.String value)
          Sets the named property to the specified value.
 
Methods inherited from interface javax.xml.xquery.XQDataFactory
createCachedSequence, createCachedSequence, createItem, createItemFromByte, createItemFromDate, createItemFromInt, createItemFromLong, createItemFromString, createItemType, createItemType, createSequenceType, createSequenceType
 

Method Detail

getConnection

XQConnection getConnection()
                           throws XQException
Attempts to create a connection to an XML datasource.

Throws:
XQException

getConnection

XQConnection getConnection(java.sql.Connection con)
                           throws XQException
Attempts to create a connection to the XML datasource using an existing JDBC connection.

Throws:
XQException

getConnection

XQConnection getConnection(java.lang.String username,
                           java.lang.String passwd)
                           throws XQException
Attempts to establish a connection to an XML datasource.

Throws:
XQException

getLoginTimeout

int getLoginTimeout()
                    throws XQException
Gets the maximum time in seconds that this datasource can wait while attempting to connect to a database.

Throws:
XQException

getLogWriter

java.io.PrintWriter getLogWriter()
                                 throws XQException
Retrieves the log writer for this XQDataSource object.

Throws:
XQException

getProperty

java.lang.String getProperty(java.lang.String name)
                             throws XQException
Returns the current value of the named property if set, else null.

Throws:
XQException

getSupportedPropertyNames

java.lang.String[] getSupportedPropertyNames()
Returns an array containing the property names supported by this XQDataSource.


setCommonHandler

void setCommonHandler(XQCommonHandler hdlr)
                      throws XQException
Sets the default common handler to be used for converting items to and from Java objects in the setObject and getObject methods on an item.

Throws:
XQException

setLoginTimeout

void setLoginTimeout(int seconds)
                     throws XQException
Sets the maximum time in seconds that this datasource will wait while attempting to connect to a database.

Throws:
XQException

setLogWriter

void setLogWriter(java.io.PrintWriter out)
                  throws XQException
Sets the log writer for this XQDataSource object to the given java.io.PrintWriter object.

Throws:
XQException

setProperties

void setProperties(java.util.Properties props)
                   throws XQException
Sets the data source properties from the specified Properties instance.

Throws:
XQException

setProperty

void setProperty(java.lang.String name,
                 java.lang.String value)
                 throws XQException
Sets the named property to the specified value.

Throws:
XQException