class DfcDbSelection : public CorBase

A database selection class.

Inheritance:


Public Fields

static const int KW_ANY
$Id: DfcDbSelection

Public Methods

virtual void addAndSelection ( const DfcDbSelection* aSelection )
virtual void addOrSelection ( const DfcDbSelection* aSelection )
DfcDbSelection ( const RWCString& aSelection )
DfcDbSelection ( const DfcDbSelection& aRef )
DfcDbSelection ( int aKeyword = KW_ANY, const RWCString& aValue = VAL_ANY, int anOperator = OP_LIKE )
virtual const RWCString& getKey ( int aKeyword )
virtual int getNextKey ()
virtual int getNextOperator ()
virtual const RWCString& getOperator ( int anOperator )
RWCString getQualifiers ()
RWCString getSelection ()
RWCString getTables ()
CorBool isSimpleSelection ()
DfcDbSelection& operator= ( const DfcDbSelection& aRef )
void select ( const RWCString& aSelection )
virtual void select ( int aKeyword = KW_ANY, const RWCString& aValue = VAL_ANY, int anOperator = OP_LIKE )
static RWTValVector <RWCString> setKeys ()
virtual ~DfcDbSelection ()

Public


Purpose
Query the table part of the current selection

Purpose
Query the next available keycode

Purpose
Query the select part of the current selection

Purpose
Check whether this selection is only made up of a selection string

Purpose
The d'tor

Purpose
Query the qualifier part of the current selection

Purpose
Query the next available operator

Protected Methods

void addTablesAndSelection ( const DfcDbSelection* aSelection )
void setQualifiers ( const RWCString& aValue )
void setSelection ( const RWCString& aValue )
void setTables ( const RWCString& aValue )

Private Fields

CorBool mSelectOnly
Purpose
Set the keywords defined by this class

Private Methods

static RWTValVector <RWCString> setOperators ()

Private


Purpose
Set the operators defined by this class

Documentation

A database selection class.
static const int KW_ANY
$Id: DfcDbSelection.h,v 1.5 1997/05/07 07:45:26 mwiedmer Exp $

SYNOPSIS

    #include <DfcDbSelection.h>
  
    DfcDbSelection myObject;
  

DESCRIPTION
Using this class you can create selections on keyword-vlue pairs.

CAUTIONS
<optional>

EXAMPLES
<optional>

SEE ALSO
<optional>
CorBase

DfcDbSelection( int aKeyword = KW_ANY, const RWCString& aValue = VAL_ANY, int anOperator = OP_LIKE )

DfcDbSelection( const RWCString& aSelection )

DfcDbSelection( const DfcDbSelection& aRef )

DfcDbSelection& operator=( const DfcDbSelection& aRef )

virtual ~DfcDbSelection()

Purpose
The d'tor.

Preconditions

  • Itemize this section if necessary. Remove itemization otherwise.

Exceptions

  • Itemize this section if necessary. Remove itemization otherwise.

virtual void select( int aKeyword = KW_ANY, const RWCString& aValue = VAL_ANY, int anOperator = OP_LIKE )

void select( const RWCString& aSelection )

virtual void addAndSelection( const DfcDbSelection* aSelection )

virtual void addOrSelection( const DfcDbSelection* aSelection )

RWCString getSelection()

Purpose
Query the select part of the current selection.

Preconditions

  • Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the string representation of the select part of this selection.

Exceptions

  • Itemize this section if necessary. Remove itemization otherwise.

CorBool isSimpleSelection()

Purpose
Check whether this selection is only made up of a selection string. (ie, no tables etc hvae been specified)

Preconditions

  • Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns corFALSE if this is a complex selection.

Exceptions

  • Itemize this section if necessary. Remove itemization otherwise.

RWCString getTables()

Purpose
Query the table part of the current selection.

Preconditions

  • Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the string representation of all the tables used by this selection.

Exceptions

  • Itemize this section if necessary. Remove itemization otherwise.

RWCString getQualifiers()

Purpose
Query the qualifier part of the current selection.

Preconditions

  • Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the string representation of the qualifiers of this selection.

Exceptions

  • Itemize this section if necessary. Remove itemization otherwise.

virtual int getNextOperator()

Purpose
Query the next available operator.

Preconditions

  • Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the next available operator.

Exceptions

  • Itemize this section if necessary. Remove itemization otherwise.

virtual int getNextKey()

Purpose
Query the next available keycode.

Preconditions

  • Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns the next available keycode.

Exceptions

  • Itemize this section if necessary. Remove itemization otherwise.

virtual const RWCString& getKey( int aKeyword )

virtual const RWCString& getOperator( int anOperator )

void setSelection( const RWCString& aValue )

void setTables( const RWCString& aValue )

void setQualifiers( const RWCString& aValue )

void addTablesAndSelection( const DfcDbSelection* aSelection )

static RWTValVector <RWCString> setOperators()

Purpose
Set the operators defined by this class.

Preconditions

  • Itemize this section if necessary. Remove itemization otherwise.

Returns
This function returns a vector with all the operators matching the operator codes.

Exceptions

  • Itemize this section if necessary. Remove itemization otherwise.

static RWTValVector <RWCString> setKeys()

CorBool mSelectOnly
Purpose
Set the keywords defined by this class.

Preconditions

Returns
This function returns a vector with all the keywords matching the keyword codes.

Exceptions


Direct child classes:
QucDbSelection

alphabetic index hierarchy of classes


this page has been generated automatically by doc++

(c)opyright by Malte Zöckler, Roland Wunderling
contact: doc++@zib.de