edu.uky.rch.ept.data
Interface IDataSourceDriver

All Superinterfaces:

ICollectionAccessMethods, IConcurrentXMLAccessMethods, IDataAccessMethods, IDTDAccessMethods, IGenericResourceAccessMethods, IImageAccessMethods, ITextAccessMethods, IXMLAccessMethods

All Known Implementing Classes:

DataSourceDriver

public interface IDataSourceDriver

extends IDataAccessMethods

A datasource driver is used to interact with the various datasources which support a known protocol. Interaction includes reading from, writing to and querying the datasource.

Only one instance of a particular datasource driver may exist within a workbench page. But it is possible to interact with any number of datasources with the same instance of the driver. This policy is designed to simplify data access for a user.

This interface may be implemented directly. For convenience, a base implementation is defined in DataSourceDriver.

A datasource driver is ??(added to/used in) the workbench in two steps:

1. A datasource driver extension is contributed to the workbench registry. This extension defines the extension id and extension class.
2. The datasource driver is utilized in the code to read from and write to a supported datasource.

Author:

Sandeep Bodapati

Field Summary

Fields inherited from interface edu.uky.rch.ept.data.IDataAccessMethods

EOF, RT_DOCUMENT, RT_NODELIST, RT_STRINGS

Method Summary

IAddressSelector	getAddressSelector() Returns a new address selector for this data source.
String	getName() Returns the descriptive name of the driver
String	getProtocolIdentifier() Returns the protocol identifier string that this driver is associated with.
String	getWizardPageClass() Returns the name of the class which implements the wizard page for this driver.
void	setName(String name) Sets the name of the datasource driver
void	setProtocolIdentifier(String protocol) Sets the protocol identifier string for this driver.
void	setWizardPageClass(String wizardPageClass) Sets the wizard page associated with this driver.
String	toString() Returns a description of the datasource driver

Methods inherited from interface edu.uky.rch.ept.data.ITextAccessMethods

getText, insertText, replaceText, storeText

Methods inherited from interface edu.uky.rch.ept.data.IDTDAccessMethods

getDTD, storeDTD

Methods inherited from interface edu.uky.rch.ept.data.IImageAccessMethods

getImage, storeImage

Methods inherited from interface edu.uky.rch.ept.data.ICollectionAccessMethods

createCollection, deleteCollection, getCollectionContents, isCollection, scanCollection

Methods inherited from interface edu.uky.rch.ept.data.IXMLAccessMethods

deleteXML, getXML, getXMLDocument, insertXML, queryXML, replaceXML, replaceXMLContent, storeXML, storeXML

Methods inherited from interface edu.uky.rch.ept.data.IConcurrentXMLAccessMethods

deleteCXML, getCXML, insertCXML, queryCXML, replaceCXML, replaceCXMLContent, storeCXML

Methods inherited from interface edu.uky.rch.ept.data.IGenericResourceAccessMethods

canRead, canWrite, deleteResource, getInputStream, getOutputStream, getOutputStream, renameResource, storeResource

Method Detail

getProtocolIdentifier

public String getProtocolIdentifier()

Returns the protocol identifier string that this driver is associated with.

Returns:

the protocol identifier string

setProtocolIdentifier

public void setProtocolIdentifier(String protocol)

Sets the protocol identifier string for this driver.

Parameters:

protocol - a string which identifies the protocol implemented by this driver. eg: http, db, etc.

getName

public String getName()

Returns the descriptive name of the driver

Returns:

name of the driver

setName

public void setName(String name)

Sets the name of the datasource driver

Parameters:

name - descriptive name for the driver

setWizardPageClass

public void setWizardPageClass(String wizardPageClass)

Sets the wizard page associated with this driver.

Parameters:

wizardPageClass - name of a class which extends NewRepositoryWizardPage

getWizardPageClass

public String getWizardPageClass()

Returns the name of the class which implements the wizard page for this driver.

Returns:

name of a subclass of NewRepositoryWizardPage or null if none is associated

toString

public String toString()

Returns a description of the datasource driver

Returns:

a description of the driver

getAddressSelector

public IAddressSelector getAddressSelector()

Returns a new address selector for this data source.

Returns: