HDMWrapper
Keywords: uk.ac.ic.doc.automed.wrappers.HDMWrapper class

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## uk.ac.ic.doc.automed.wrappers
Class HDMWrapper

    java.lang.Object
      uk.ac.ic.doc.automed.wrappers.AutoMedWrapper
          uk.ac.ic.doc.automed.wrappers.HDMWrapper

    public class HDMWrapper

extends AutoMedWrapper

A Wrapper for the HDM data store.

Author:
  Dean Williams (dean@dcs.bbk.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
`HDMWrapper(AccessMethod am, java.lang.String password)`

Method Summary
`protected void` | `connect()` Use the connection details held with this wrapper to connect to the data source.
`ASG` | `executeIQL(ASG queryASG)` Takes `ASG` query and passes it to a `LowLevelWrapperHdm` for processing.
`AutoMedResult` | `executeLocalQuery(AutoMedQuery arg0)` This is a stub required as the AutoMedWrapper requires it
`protected AutoMedWrapperFactory` | `getDefaultWrapperFactory()` Returns a new instance of the default wrapper factory for this wrapper
`java.lang.String` | `getProtocolName()` The name of the `Protocol` in the repository used to represent the HDM store.
`void` | `getSODefinition(QuerySubGoal qsg)` Implement AutoMedWrapper abstract method
`void` | `setSchema(java.lang.String schemaName)` Set the value of the schema that this wrapper is for

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

### HDMWrapper

    public HDMWrapper(AccessMethod am,
                      java.lang.String password)
               throws DataSourceException

Throws:
  `DataSourceException`

Method Detail

### connect

    protected void connect()

  Description copied from class: `AutoMedWrapper`
  Use the connection details held with this wrapper to connect to the data source.

  Specified by:
    `connect` in class `AutoMedWrapper`

### executeIQL

    public ASG executeIQL(ASG queryASG)
                   throws DataSourceException

  Takes `ASG` query and passes it to a `LowLevelWrapperHdm` for processing.

  Specified by:
    `executeIQL` in class `AutoMedWrapper`
  Parameters:
    `queryASG` - 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`

### executeLocalQuery

    public AutoMedResult executeLocalQuery(AutoMedQuery arg0)
                                    throws DataSourceException

  This is a stub required as the AutoMedWrapper requires it

  Overrides:
    `executeLocalQuery` in class `AutoMedWrapper`
  Throws:
    `DataSourceException`

### setSchema

    public void setSchema(java.lang.String schemaName)

  Set the value of the schema that this wrapper is for

### 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 the HDM store.

  Specified by:
    `getProtocolName` in class `AutoMedWrapper`

### getSODefinition

    public void getSODefinition(QuerySubGoal qsg)
                         throws DataSourceException

  Implement AutoMedWrapper abstract method

  Specified by:
    `getSODefinition` in class `AutoMedWrapper`
  Throws:
    `DataSourceException`

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD