Abstract Class Reference

Abstract class providing interface for Foreign Data Wrappers. More...

Inheritance diagram for Abstract:

Collaboration diagram for Abstract:

Public Member Functions
_.Library.Status	CleanUp (_.Library.Boolean StopLanguageServer)
	Disconnect Gateway, optionally stop External Language Server (costly to start it again).
_.Library.Status	Close ()
	Corresponds to *Close of TVF.
_.Library.Status	Execute (_.Library.String Server, _.Library.String FTClassName, _.Library.String Query, _.Library.List Parameters)
	Corresponds to *Execute of a TVF.
_.Library.Status	Fetch (_.Library.List Row, _.Library.Integer AtEnd)
	Corresponds to *Fetch of a TVF.
_.Library.DynamicObject	GetRequestObject (_.Library.String Server, _.Library.String FTClassName)
	Create the request string sent to Java.
_.Library.Status	Reset ()
	Reset the result set back to the first row. More...
Public Member Functions inherited from RegisteredObject
_.Library.Status	OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
	This callback method is invoked when the current object is added to the SaveSet,. More...
_.Library.Status	OnClose ()
	This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
_.Library.Status	OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
	This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...
_.Library.Status	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...

Static Public Member Functions
_.Library.String	QuoteIdentifier (_.Library.String identifier, _.Library.Boolean supportsDelimitedIdentifiers)
	Quote identifiers appropriately for the data source type that this foreign data wrapper wraps based. More...

Public Attributes
	Buffer
	The current buffer (batch of rows - a $lb of $lb's) More...
	BufferLength
	The size of the buffer (number of characters) More...
	BufferPointer
	Maintains the pointer output by $listnext. More...
	RemainingBuffers
	Whether there are more buffers (batches of rows) that the source can return. More...

Static Public Attributes
	PREDICATEPUSHDOWN = None
	Specifies whether this foreign data wrapper supports pushing logical predicates to its source. More...
Static Public Attributes inherited from RegisteredObject
	CAPTION = None
	Optional name used by the Form Wizard for a class when generating forms. More...
	JAVATYPE = None
	The Java type to be used when exported.
	PROPERTYVALIDATION = None
	This parameter controls the default validation behavior for the object. More...

Private Member Functions
_.Library.Integer	Next (_.Library.Status sc)
	Advance the result set cursor to the next row. More...

Detailed Description

Abstract class providing interface for Foreign Data Wrappers.

Foreign Data Wrappers provide the API for interacting with data stored in foreign sources such as CSV files, external databases, distributed file servers etc.

Member Function Documentation

Next()

_.Library.Integer Next ( _.Library.Status  sc )

private

Advance the result set cursor to the next row.

Returns 0 if the cursor is at the end of the

result set.. An optional argument contains a <class>Library.Status</class> value on return. This Status value indicates success or failure of the Next call. <property>SQLCODE</property> is also set by Next.

Reimplemented from StatementResult.

Reimplemented in Java.

QuoteIdentifier()

_.Library.String QuoteIdentifier ( _.Library.String  identifier, _.Library.Boolean  supportsDelimitedIdentifiers  )

static

Quote identifiers appropriately for the data source type that this foreign data wrapper wraps based.

on whether delimited identifiers should be supported.

Default implementation returns the identifier as is. It is up to the subclass to implement the behavior appropriate for the data source type.

Reset()

_.Library.Status Reset

(

)

Reset the result set back to the first row.

Note this may entail a full re-execution depending on the specific

implmentation of the foreign data wrapper.

Reimplemented in Java.

Member Data Documentation

PREDICATEPUSHDOWN

PREDICATEPUSHDOWN = None

static

Specifies whether this foreign data wrapper supports pushing logical predicates to its source.

0 by default, overridden to be 1 by the XDBC FDW

Buffer

Buffer

The current buffer (batch of rows - a $lb of $lb's)

 

BufferLength

BufferLength

The size of the buffer (number of characters)

 

BufferPointer

BufferPointer

Maintains the pointer output by $listnext.

 

RemainingBuffers

RemainingBuffers

Whether there are more buffers (batches of rows) that the source can return.