Class: TSQLProduct

Declaration: SQLDataAccess.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

MCollectible

Inherited By:

TSQLDBProtocol TSQLDataStore

Purpose:

Each instance of TSQLProduct describes an SQL product, such as a datastore or a database access protocol. SQL product information is required to instantiate a connection.

Instantiation:

Allocate on the heap or the stack. Although this is a concrete class, clients do not use it directly, but use member functions inherited via such derived classes as TSQLStandardDBProtocol and TSQLStandardDataStore.

Deriving Classes:

Providers need to derive a new class for every new protocol that they want to support.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TSQLProduct::TSQLProduct

TSQLProduct ()
TSQLProduct (const TText & vendor, const TText & identifier, const TText & version, const TText & name, const TText & platform =TStandardText :: GetEmptyText ())
TSQLProduct (const TSQLProduct & source)

Interface Category:

API.

Purpose:

Default constructor. Intended for connection providers; clients shouldn't need to use the default constructor.
Instantiates a derived class with the specified parameters.
Copy constructor.

Calling Context:

Called by the stream-in operators and any other function that needs to construct an uninitialized object.
Call this function directly.
Called to copy an object.

Parameters:

Takes no parameters.
const TText & vendor -The vendor name, for example, Oracle.
const TText & identifier -The unique product identifier, for example, SQL*NET.
const TText & version -The product version, for example, 1.5.
const TText & name -The product name, for example, Oracle SQL*Net version 2.0/AIX.
const TText & platform =TStandardText :: GetEmptyText () -The platform supporting the product, for example, AIX. The platform is normally not specified, because vendors try to ensure compatibility across platforms.
const TSQLProduct & source -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLProduct::~TSQLProduct

virtual ~ TSQLProduct ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLProduct::GetName

const TText & GetName (TText & target) const

Interface Category:

API.

Purpose:

Returns the localizable name of the product, for example, Oracle SQL*Net version 2.0/AIX.

Calling Context:

Call this function directly.

Parameters:

TText & target -On return, holds the product name.

Return Value:

A const reference to the localizable name of the product.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This name is intended for end-user display only. Do not use it to compare products for equality.

Member Function: TSQLProduct::GetIdentifier

const TText & GetIdentifier (TText & target) const

Interface Category:

API.

Purpose:

Returns the unique product identifier, for example, SQL*Net. This name is not localizable.

Calling Context:

Call this function directly.

Parameters:

TText & target -On return, holds the product identifier.

Return Value:

A const reference to the unique product identifier.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLProduct::GetVendor

const TText & GetVendor (TText & target) const

Interface Category:

API.

Purpose:

Returns the unique product vendor identifier, for example, Oracle. This name is not localizable.

Calling Context:

Call this function directly.

Parameters:

TText & target -On return, holds the vendor identifier.

Return Value:

A const reference to the unique product vendor identifier.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLProduct::GetVersion

const TText & GetVersion (TText & target) const

Interface Category:

API.

Purpose:

Returns the unique version of the product, for example, 1.5. This string is not localizable.

Calling Context:

Call this function directly.

Parameters:

TText & target -On return, holds the product version.

Return Value:

A const reference to the unique version of the product.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLProduct::GetPlatform

const TText & GetPlatform (TText & target) const

Interface Category:

API.

Purpose:

Returns the platform supporting the product, for example, AIX.

Calling Context:

Call this function directly.

Parameters:

TText & target -On return, holds the platform name.

Return Value:

A const reference to the platform supporting the product.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLProduct::SetName

virtual void SetName (const TText & name)

Interface Category:

API.

Purpose:

Sets the localizable name of the product.

Calling Context:

Call this function directly.

Parameters:

const TText & name -The new name for the product.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLProduct::Hash

virtual long Hash () const

Interface Category:

API.

Purpose:

Returns a hash value for collections.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

A hash value for collections.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLProduct::operator<<=

virtual TStream & operator <<= (TStream & fromWhere)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & fromWhere -The stream the object streams itself in from.

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLProduct::operator>>=

virtual TStream & operator >>=(TStream & toWhere) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & toWhere -The stream the object streams itself out to.

Return Value:

Returns a reference to the stream the object streams itself out to.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLProduct::operator=

TSQLProduct & operator =(const TSQLProduct & source)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TSQLProduct & source -The product to be copied.

Return Value:

A non-const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLProduct::IsEqual

virtual bool IsEqual (const MCollectible *) const

Interface Category:

API.

Purpose:

Determines if this object equals its argument.

Calling Context:

Call this function directly.

Parameters:

const MCollectible * -The object to compare with this object.

Return Value:

Returns true if all members are equal.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.