Java Class Reference

Inheritance diagram for Java:

Collaboration diagram for Java:

Public Member Functions
_.Library.Status	CreateReaderObject (_.Library.String Server, _.Library.String FTClassName)
	Creates an object of the class containing the functionality needed to access an external source. More...
_.Library.Status	Execute (_.Library.String Server, _.Library.String FTClassName, _.Library.String Query, _.Library.List Parameters)
	Corresponds to the *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)
	Build and return request string used by Reader code for connecting to a database. More...
_.Library.Status	Reset ()
	Reset the result set back to the first row. More...
Public Member Functions inherited from Abstract
_.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.
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	OnValidateObject ()
	This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...

Public Attributes
	Gateway
	Object representing instance of a specific connection to the external language server. More...
	Ptr
	Left in for Fetch(), which isn't how we codegen FT TVFs anyway. More...
	ReaderObject
	More...
Public Attributes inherited from Abstract
	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
	JAVACLASS = None
	Class in the Foreign Table package.
Static Public Attributes inherited from Abstract
	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...
_.Library.Status	OnNew ()
	This callback method is invoked by the <METHOD>New</METHOD> method to. More...

Additional Inherited Members
Static Public Member Functions inherited from Abstract
_.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...

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 Abstract.

OnNew()

_.Library.Status OnNew ( )

private

This callback method is invoked by the <METHOD>New</METHOD> method to.

provide notification that a new instance of an object is being created.

If this method returns an error then the object will not be created.

It is passed the arguments provided in the New call. When customizing this method, override the arguments with whatever variables and types you expect to receive from New(). For example, if you're going to call New, passing 2 arguments, OnNew's signature could be:

Method OnNew(dob as Date = "", name as Name = "") as Status If instead of returning a Status code this returns an oref and this oref is a subclass of the current class then this oref will be the one returned to the caller of New method.

Reimplemented from RegisteredObject.

CreateReaderObject()

_.Library.Status CreateReaderObject	(	_.Library.String	Server,
		_.Library.String	FTClassName
	)

Creates an object of the class containing the functionality needed to access an external source.

For now,

these will be Java objects (to read CSV/external DBs through JDBC). 1) Create request string, which is used by the external code to connect to the relevant external source. 2) Instantiate the object, store it in ReaderObject property Called by SQL.FDW.Common:Execute()

GetRequestObject()

_.Library.DynamicObject GetRequestObject	(	_.Library.String	Server,
		_.Library.String	FTClassName
	)

Build and return request string used by Reader code for connecting to a database.

For a file, Server host = abs. path to directory, Table = filename+extension, port & user & pass are all N/A

Reimplemented from Abstract.

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 from Abstract.

Member Data Documentation

Gateway

Gateway

Object representing instance of a specific connection to the external language server.

 

Ptr

Ptr

Left in for Fetch(), which isn't how we codegen FT TVFs anyway.

 

ReaderObject

ReaderObject