net.sf.farrago.namespace.ftrs
Class FtrsDataWrapper

java.lang.Object
  net.sf.farrago.plugin.FarragoAbstractPluginBase
      net.sf.farrago.namespace.impl.MedAbstractBase
          net.sf.farrago.namespace.impl.MedAbstractDataWrapper
              net.sf.farrago.namespace.ftrs.FtrsDataWrapper

All Implemented Interfaces:

FarragoMedDataWrapperInfo, FarragoMedDataWrapper, FarragoPlugin, FarragoAllocation, ClosableAllocation

public class FtrsDataWrapper
extends MedAbstractDataWrapper

FtrsDataWrapper implements the FarragoMedDataWrapper interface for FTRS data.

Version:

$Id: //open/dev/farrago/src/net/sf/farrago/namespace/ftrs/FtrsDataWrapper.java#12 $

Author:

John V. Sichi

Field Summary

Fields inherited from class net.sf.farrago.plugin.FarragoAbstractPluginBase

BOOLEAN_CHOICES_DEFAULT_FALSE, BOOLEAN_CHOICES_DEFAULT_TRUE, EMPTY_DRIVER_PROPERTIES

Constructor Summary

FtrsDataWrapper()
Creates a new data wrapper instance.

Method Summary

String	getDescription(Locale locale) Obtains a description of this plugin.
String	getSuggestedName() Obtains a suggested name for this plugin in the SQL catalog.
boolean	isForeign() Determines whether this data wrapper accesses foreign data, or manages local data.
FarragoMedDataServer	newServer(String serverMofId, Properties props) Creates an instance of this wrapper for a particular server.

Methods inherited from class net.sf.farrago.namespace.impl.MedAbstractDataWrapper

closeAllocation, getColumnPropertyInfo, getColumnSetPropertyInfo, getLibraryName, getPluginPropertyInfo, getProperties, getRepos, getServerPropertyInfo, initialize, setLibraryName, supportsServerSharing

Methods inherited from class net.sf.farrago.plugin.FarragoAbstractPluginBase

getBooleanProperty, getByteProperty, getDoubleProperty, getFloatProperty, getIntProperty, getLongProperty, getShortProperty, requireProperty

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FtrsDataWrapper

public FtrsDataWrapper()

Creates a new data wrapper instance.

Method Detail

getSuggestedName

public String getSuggestedName()

Description copied from interface: FarragoPlugin

Obtains a suggested name for this plugin in the SQL catalog.

Returns:

suggested name

getDescription

public String getDescription(Locale locale)

Description copied from interface: FarragoPlugin

Obtains a description of this plugin.

Parameters:

locale - Locale for formatting description

Returns:

localized description

newServer

public FarragoMedDataServer newServer(String serverMofId,
                                      Properties props)
                               throws SQLException

Description copied from interface: FarragoMedDataWrapper

Creates an instance of this wrapper for a particular server. This supports the SQL/MED CREATE SERVER statement. The TYPE and VERSION attributes are rolled in with the other properties. As much validation as possible should be performed, including establishing connections if appropriate.

If this wrapper returns false from the isForeign method, then returned server instances must implement the FarragoMedLocalDataServer interface.

Parameters:

serverMofId - MOFID of server definition in repository; this can be used for accessing the server definition from generated code

props - server properties

Returns:

new server instance

Throws:

SQLException - if server connection is unsuccessful

isForeign

public boolean isForeign()

Description copied from interface: FarragoMedDataWrapperInfo

Determines whether this data wrapper accesses foreign data, or manages local data.

Specified by:

isForeign in interface FarragoMedDataWrapperInfo

Overrides:

isForeign in class MedAbstractDataWrapper

Returns:

true for foreign data; false for local data