uk.ac.ic.doc.automed.wrappers
Class YattaWrapper

java.lang.Object
  extended by uk.ac.ic.doc.automed.wrappers.AutoMedWrapper
      extended by uk.ac.ic.doc.automed.wrappers.YattaWrapper

public class YattaWrapper
extends AutoMedWrapper

A YATTA wrapper for semistructured data source.

Author:
Sasivimol Kittivoravitkul (sk297@doc.ic.ac.uk)

Field Summary
 
Fields inherited from class uk.ac.ic.doc.automed.wrappers.AutoMedWrapper
am, awf, debug, driver, emptyKeyProtection, emptyKeys, optionKeyProtection, optionKeys, password, protocol, s, url, username
 
Constructor Summary
YattaWrapper()
           
YattaWrapper(AccessMethod am, java.lang.String password)
           
 
Method Summary
protected  void connect()
          Connect to a semistructured textfile --- i.e.
 ASG executeIQL(ASG q)
          Execute an IQL query on the datasource.
 AutoMedResult executeLocalQuery(AutoMedQuery q)
          Execute a query in the datasource's native query language, and obtain a result in an AutoMedResult class
 YattaQueryResult executeYattaQuery(YattaQuery q)
           
protected  java.util.Vector getDatafromYattaData(java.util.Vector orderedschemes)
           
protected  AutoMedWrapperFactory getDefaultWrapperFactory()
          Returns a new instance of the default wrapper factory for this wrapper
static java.lang.String getDriver()
          The name of the driver string that identifies this wrapper
 java.lang.String getProtocolName()
          The name of the Protocol in the repository used to represent flat files with a YATTA schema.
 void getSODefinition(QuerySubGoal qsg)
          Implement AutoMedWrapper abstract method
 SSDFormat getSSDFormat()
           
 java.lang.String getSSDSource()
           
 Schema getWrapperSchema()
           
 SchemaObject getYattaRootNode(Schema sc)
           
protected  void readMetaData()
           
 
Methods inherited from class uk.ac.ic.doc.automed.wrappers.AutoMedWrapper
atDebugLevel, cacheWrapper, deleteIQL, executeIQL, getAccessMethod, getAutoMedWrapper, getAutoMedWrapper, getAutoMedWrapperFactory, getDrivers, getOption, getOptionKeyProtection, getOptionKeys, getProtocol, getQueryCache, getQueryCache, getQueryParser, getSchema, getSchema, getSODefinition, insertIQL, newAutoMedSchema, newAutoMedWrapper, newAutoMedWrapper, newAutoMedWrapper, registerWrapper, selectNewAutoMedWrapper, selectNewAutoMedWrapper, setDebugLevel, setOption, updateCache
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

YattaWrapper

public YattaWrapper()

YattaWrapper

public YattaWrapper(AccessMethod am,
                    java.lang.String password)
             throws DataSourceException
Throws:
DataSourceException
Method Detail

getDriver

public static java.lang.String getDriver()
The name of the driver string that identifies this wrapper


connect

protected void connect()
                throws DataSourceException
Connect to a semistructured textfile --- i.e. file open!

Specified by:
connect in class AutoMedWrapper
Throws:
DataSourceException - if unable to connect to the data source

readMetaData

protected void readMetaData()
                     throws AutoMedException,
                            java.sql.SQLException,
                            java.io.IOException
Throws:
AutoMedException
java.sql.SQLException
java.io.IOException

getWrapperSchema

public Schema getWrapperSchema()

getSSDFormat

public SSDFormat getSSDFormat()

getSSDSource

public java.lang.String getSSDSource()

getYattaRootNode

public SchemaObject getYattaRootNode(Schema sc)

executeLocalQuery

public AutoMedResult executeLocalQuery(AutoMedQuery q)
                                throws DataSourceException
Description copied from class: AutoMedWrapper
Execute a query in the datasource's native query language, and obtain a result in an AutoMedResult class

Overrides:
executeLocalQuery in class AutoMedWrapper
Throws:
DataSourceException

executeYattaQuery

public YattaQueryResult executeYattaQuery(YattaQuery q)
                                   throws DataSourceException
Throws:
DataSourceException

getDatafromYattaData

protected java.util.Vector getDatafromYattaData(java.util.Vector orderedschemes)

executeIQL

public ASG executeIQL(ASG q)
               throws DataSourceException
Description copied from class: AutoMedWrapper
Execute an IQL query on the datasource.

Specified by:
executeIQL in class AutoMedWrapper
Parameters:
q - An IQL query held in an ASG which complies with the limitations of what this wrapper is able to process
Returns:
An ASG containing the results of the query
Throws:
DataSourceException

getSODefinition

public void getSODefinition(QuerySubGoal qsg)
                     throws DataSourceException
Implement AutoMedWrapper abstract method

Specified by:
getSODefinition in class AutoMedWrapper
Throws:
DataSourceException

getDefaultWrapperFactory

protected AutoMedWrapperFactory getDefaultWrapperFactory()
Returns a new instance of the default wrapper factory for this wrapper

Specified by:
getDefaultWrapperFactory in class AutoMedWrapper

getProtocolName

public java.lang.String getProtocolName()
The name of the Protocol in the repository used to represent flat files with a YATTA schema.

Specified by:
getProtocolName in class AutoMedWrapper