AEDummyTable Class Reference

A class representing a relational table with a single row. More...

Inherits AETerminalExprT< AENamedRelationalExpr >.

List of all members.

Public Member Functions

virtual void AcceptVisitor (AENodeVisitor &in_visitor)
 Calls the correct method on the visitor.
 AEDummyTable (const AEDummyTable &in_other)
 Copy constructor.
 AEDummyTable ()
 Constructor.
virtual AEDummyTableClone () const
 Creates a clone of this node object.
virtual const AEDummyTableGetAsDummyTable () const
 Retrieves the object as an AEDummyTable object.
virtual AEDummyTableGetAsDummyTable ()
 Retrieves the object as an AEDummyTable object.
virtual void GetCatalogName (simba_wstring &out_catalogName)
 Retrieves the table catalog.
virtual simba_uint16 GetColumnCount ()
 Returns the number of columns in this query operation.
virtual const IIndexMetadataListGetIndexes () const
 Get the indexes for this relational expression.
virtual simba_wstring GetLogString () const
 Returns a string name for this node for the purpose of logging.
virtual AENodeType GetNodeType () const
 Returns an integer that uniquely identifies the node class.
virtual void GetSchemaName (simba_wstring &out_schemaName)
 Retrieves the table schema.
virtual void GetTableName (simba_wstring &out_tableName)
 Retrieves the table name.
virtual bool IsEqual (const AENode *in_another) const
 Tells whether the two nodes are equal.
virtual void SetDataNeeded (simba_uint16 in_column, bool in_isNeeded)
 Indicates whether RetrieveData(...) might be called on the given column. This applies to any subsequent Move(...) calls.
virtual ~AEDummyTable ()
 Destructor.

Protected Member Functions

virtual Simba::DSI::IColumnGetBaseColumn (simba_uint16 in_columnNum)
 Gets the column for the given column number.

Detailed Description

A class representing a relational table with a single row.

Will always have no children (GetChildCount() returns 0).


Constructor & Destructor Documentation

AEDummyTable (  ) 

Constructor.

AEDummyTable ( const AEDummyTable in_other  ) 

Copy constructor.

To support "cloning". See Clone() method.

Parameters:
in_other The other node to create a copy from.
virtual ~AEDummyTable (  )  [virtual]

Destructor.


Member Function Documentation

virtual void AcceptVisitor ( AENodeVisitor in_visitor  )  [virtual]

Calls the correct method on the visitor.

Parameters:
in_visitor The visiting object.

Implements AENode.

virtual AEDummyTable* Clone (  )  const [virtual]

Creates a clone of this node object.

Returns:
A clone of this node object. (OWN)

Implements AENamedRelationalExpr.

virtual const AEDummyTable* GetAsDummyTable (  )  const [virtual]

Retrieves the object as an AEDummyTable object.

Overrides the method defined in AERelationalExpr.

Returns:
this object always. (NOT OWN)

Reimplemented from AERelationalExpr.

virtual AEDummyTable* GetAsDummyTable (  )  [virtual]

Retrieves the object as an AEDummyTable object.

Overrides the method defined in AERelationalExpr.

Returns:
this object always. (NOT OWN)

Reimplemented from AERelationalExpr.

virtual Simba::DSI::IColumn* GetBaseColumn ( simba_uint16  in_columnNum  )  [protected, virtual]

Gets the column for the given column number.

This method should be overridden by AETable and AESubquery, and will be called from GetColumn() to retrieve column metadata before possibly wrapping it in an AERenamedColumn to change the name if column names were overridden in the correlation spec.

Parameters:
in_columnNum The zero-base column index.
Exceptions:
SEInvalidArgumentException when the given column number is invalid
Returns:
the column at the given column index (NOT OWN)

Implements AENamedRelationalExpr.

virtual void GetCatalogName ( simba_wstring out_catalogName  )  [virtual]

Retrieves the table catalog.

Parameters:
out_catalogName The output table catalog.

Implements AENamedRelationalExpr.

virtual simba_uint16 GetColumnCount (  )  [virtual]

Returns the number of columns in this query operation.

Returns:
The number of columns in this query operation.

Implements AEQueryOperation.

virtual const IIndexMetadataList& GetIndexes (  )  const [virtual]

Get the indexes for this relational expression.

Return an empty collection of indexes if indexes are not supported.

Returns:
The indexes for this result set.

Reimplemented from AERelationalExpr.

virtual simba_wstring GetLogString (  )  const [virtual]

Returns a string name for this node for the purpose of logging.

Returns:
A string representation of this node for logging purposes.

Implements AENode.

virtual AENodeType GetNodeType (  )  const [virtual]

Returns an integer that uniquely identifies the node class.

See the definition of AENodeType for values defined.

Returns:
The ID that uniquely identifies this type of nodes.

Implements AENode.

virtual void GetSchemaName ( simba_wstring out_schemaName  )  [virtual]

Retrieves the table schema.

Parameters:
out_schemaName The output table schema.

Implements AENamedRelationalExpr.

virtual void GetTableName ( simba_wstring out_tableName  )  [virtual]

Retrieves the table name.

Parameters:
out_tableName The output table name for the value expression.

Implements AENamedRelationalExpr.

virtual bool IsEqual ( const AENode in_another  )  const [virtual]

Tells whether the two nodes are equal.

Two AEDummyTable's are equal if IsEqualComprehensive() returns true.

Parameters:
in_another Another node to compare to. (NOT OWN)
Returns:
true if two nodes are equal, false otherwise.

Reimplemented from AENode.

virtual void SetDataNeeded ( simba_uint16  in_column,
bool  in_isNeeded 
) [virtual]

Indicates whether RetrieveData(...) might be called on the given column. This applies to any subsequent Move(...) calls.

Parameters:
in_column A zero-based column index.
in_isNeeded Indicates whether data may be retrieved from the given column by the ODBC layer or not.
Exceptions:
SEInvalidArgumentException if in_column is invalid.

Implements AERelationalExpr.


The documentation for this class was generated from the following file:

Generated on Wed May 17 14:21:16 2017 for SimbaEngine 10.1.3.1011 by simba