net.sf.farrago.jdbc
Interface FarragoMedDataWrapperInfo

All Known Subinterfaces:

FarragoMedDataWrapper

All Known Implementing Classes:

FarragoJdbcEngineConnection.FleetingMedDataWrapperInfo, FarragoRJMedDataWrapper, FlatFileDataWrapper, FlatFileDataWrapper, FtrsDataWrapper, LcsDataWrapper, MedAbstractDataWrapper, MedJdbcForeignDataWrapper, MedMdrForeignDataWrapper, MedMockForeignDataWrapper, MedMockLocalDataWrapper, MedMqlForeignDataWrapper

public interface FarragoMedDataWrapperInfo

Description of a SQL/MED data wrapper.

Version:

$Id: //open/dev/farrago/src/net/sf/farrago/jdbc/FarragoMedDataWrapperInfo.java#11 $

Author:

Julian Hyde

Method Summary

DriverPropertyInfo[]	getColumnPropertyInfo(Locale locale, Properties wrapperProps, Properties serverProps, Properties tableProps, Properties columnProps) Obtains information about the properties applicable to individual column initialization (the columnPropMap parameter to the FarragoMedDataServer.newColumnSet(java.lang.String[], java.util.Properties, net.sf.farrago.type.FarragoTypeFactory, org.eigenbase.reltype.RelDataType, java.util.Map) method).
DriverPropertyInfo[]	getColumnSetPropertyInfo(Locale locale, Properties wrapperProps, Properties serverProps, Properties tableProps) Obtains information about the properties applicable to column set initialization (the tableProps parameter to the newColumnSet method).
DriverPropertyInfo[]	getPluginPropertyInfo(Locale locale, Properties wrapperProps) Obtains information about the properties applicable to plugin initialization.
DriverPropertyInfo[]	getServerPropertyInfo(Locale locale, Properties wrapperProps, Properties serverProps) Obtains information about the properties applicable to server initialization (the props parameter to the newServer method).
boolean	isForeign() Determines whether this data wrapper accesses foreign data, or manages local data.

Method Detail

getPluginPropertyInfo

DriverPropertyInfo[] getPluginPropertyInfo(Locale locale,
                                           Properties wrapperProps)

Obtains information about the properties applicable to plugin initialization.

Parameters:

locale - Locale for formatting property info

wrapperProps - proposed list of property name/value pairs which will be sent to FarragoPlugin.initialize(net.sf.farrago.catalog.FarragoRepos, java.util.Properties)

Returns:

0 or more property info descriptors

getServerPropertyInfo

DriverPropertyInfo[] getServerPropertyInfo(Locale locale,
                                           Properties wrapperProps,
                                           Properties serverProps)

Obtains information about the properties applicable to server initialization (the props parameter to the newServer method).

Parameters:

locale - Locale for formatting property info

wrapperProps - proposed list of property name/value pairs which will be sent to FarragoPlugin.initialize(net.sf.farrago.catalog.FarragoRepos, java.util.Properties)

serverProps - proposed list of property name/value pairs which will be sent to FarragoMedDataWrapper.newServer(java.lang.String, java.util.Properties)

Returns:

0 or more property info descriptors

getColumnSetPropertyInfo

DriverPropertyInfo[] getColumnSetPropertyInfo(Locale locale,
                                              Properties wrapperProps,
                                              Properties serverProps,
                                              Properties tableProps)

Obtains information about the properties applicable to column set initialization (the tableProps parameter to the newColumnSet method).

Parameters:

locale - Locale for formatting property info

wrapperProps - proposed list of property name/value pairs which will be sent to FarragoPlugin.initialize(net.sf.farrago.catalog.FarragoRepos, java.util.Properties)

serverProps - proposed list of property name/value pairs which will be sent to FarragoMedDataWrapper.newServer(java.lang.String, java.util.Properties)

tableProps - proposed list of property name/value pairs which will be sent to the tableProps parameter of FarragoMedDataServer.newColumnSet(java.lang.String[], java.util.Properties, net.sf.farrago.type.FarragoTypeFactory, org.eigenbase.reltype.RelDataType, java.util.Map)

Returns:

0 or more property info descriptors

getColumnPropertyInfo

DriverPropertyInfo[] getColumnPropertyInfo(Locale locale,
                                           Properties wrapperProps,
                                           Properties serverProps,
                                           Properties tableProps,
                                           Properties columnProps)

Obtains information about the properties applicable to individual column initialization (the columnPropMap parameter to the FarragoMedDataServer.newColumnSet(java.lang.String[], java.util.Properties, net.sf.farrago.type.FarragoTypeFactory, org.eigenbase.reltype.RelDataType, java.util.Map) method).

Parameters:

locale - Locale for formatting property info

wrapperProps - proposed list of property name/value pairs which will be sent to FarragoPlugin.initialize(net.sf.farrago.catalog.FarragoRepos, java.util.Properties)

serverProps - proposed list of property name/value pairs which will be sent to FarragoMedDataWrapper.newServer() FarragoMedDataWrapper.newServer(java.lang.String, java.util.Properties)

tableProps - proposed list of property name/value pairs which will be sent as the tableProps parameter of FarragoMedDataServer.newColumnSet(java.lang.String[], java.util.Properties, net.sf.farrago.type.FarragoTypeFactory, org.eigenbase.reltype.RelDataType, java.util.Map)

columnProps - proposed list of property name/value pairs which will be sent as an entry in the columnPropMap parameter of FarragoMedDataServer.newColumnSet(java.lang.String[], java.util.Properties, net.sf.farrago.type.FarragoTypeFactory, org.eigenbase.reltype.RelDataType, java.util.Map)

Returns:

0 or more property info descriptors

isForeign

boolean isForeign()

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

Returns:

true for foreign data; false for local data