AEInsertionTable Class Reference

An node which holds data for insertion and converts it to the target metadata when necessary. More...

Inherits Simba::SQLEngine::AERelationalExpr.

List of all members.

Public Member Functions

virtual void AcceptVisitor (AENodeVisitor &in_visitor)
 Calls the correct method on the visitor.
 AEInsertionTable (const AEInsertionTable &in_other)
 Copy Constructor.
 AEInsertionTable (AutoPtr< Simba::DSI::IColumns > in_targetColumns, AutoVector< AEValueList > &in_insertionRows)
 Constructor.
virtual AEInsertionTableClone () const
 Creates a clone of this node object.
virtual const AEInsertionTableGetAsInsertionTable () const
 Get the object as an AEInsertionTable object.
virtual AEInsertionTableGetAsInsertionTable ()
 Get the object as an AEInsertionTable object.
virtual const AENodeGetChild (simba_size_t in_index) const
 Gets a pointer reference to the specified child node.
virtual AENodeGetChild (simba_size_t in_index)
 Gets a pointer reference to the specified child node.
virtual simba_size_t GetChildCount () const
 Gets the number of child nodes that this node has.
virtual Simba::DSI::IColumnGetColumn (simba_uint16 in_columnNum)
 Get the column metadata for the given column.
virtual simba_uint16 GetColumnCount ()
 Returns the number of columns in this query operation.
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. See the definition of AENodeType for values defined.
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.
 ~AEInsertionTable ()
 Destructor.

Detailed Description

An node which holds data for insertion and converts it to the target metadata when necessary.


Constructor & Destructor Documentation

AEInsertionTable ( AutoPtr< Simba::DSI::IColumns in_targetColumns,
AutoVector< AEValueList > &  in_insertionRows 
)

Constructor.

Parameters:
in_targetColumns The columns (in order) of the table to which data is being inserted.
in_insertionRows A list of the rows to insert into the table. Each list of AERelationalExpr represents one row to be inserted, with the the columns in the same order as the in_targetColumns
AEInsertionTable ( const AEInsertionTable in_other  ) 

Copy Constructor.

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

Parameters:
in_other The AEInsertion table to copy.
~AEInsertionTable (  ) 

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 AEInsertionTable* Clone (  )  const [virtual]

Creates a clone of this node object.

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

Implements AERelationalExpr.

virtual const AEInsertionTable* GetAsInsertionTable (  )  const [virtual]

Get the object as an AEInsertionTable object.

Overrides the method defined in AERelationalExpr.

Returns:
This object as an AEInsertionTable object. (NOT OWN)

Reimplemented from AERelationalExpr.

virtual AEInsertionTable* GetAsInsertionTable (  )  [virtual]

Get the object as an AEInsertionTable object.

Overrides the method defined in AERelationalExpr.

Returns:
This object as an AEInsertionTable object. (NOT OWN)

Reimplemented from AERelationalExpr.

virtual const AENode* GetChild ( simba_size_t  in_index  )  const [virtual]

Gets a pointer reference to the specified child node.

IMPLEMENTATION NOTE: This method should be overridden when GetChildCount() is overridden in a child class of this class. Otherwise, there is almost always a consistency issue.

Parameters:
in_index The zero-based index for the child.
Exceptions:
SEInvalidArgumentException when in_index is invalid
SEInvalidOperationException when this is a leaf node
Returns:
A pointer reference to the requested child node. (NOT OWN)

Implements AENode.

virtual AENode* GetChild ( simba_size_t  in_index  )  [virtual]

Gets a pointer reference to the specified child node.

IMPLEMENTATION NOTE: This method should be overridden when GetChildCount() is overridden in a child class of this class. Otherwise, there is almost always a consistency issue.

Parameters:
in_index The zero-based index for the child.
Exceptions:
SEInvalidArgumentException when in_index is invalid
SEInvalidOperationException when this is a leaf node
Returns:
A pointer reference to the requested child node. (NOT OWN)

Implements AENode.

virtual simba_size_t GetChildCount (  )  const [virtual]

Gets the number of child nodes that this node has.

IMPLEMENTATION NOTE: This method should be overridden when GetChild() is overridden in a child class of this class. Otherwise, there is almost always a consistency issue.

Returns:
The number of child nodes.

Implements AENode.

virtual Simba::DSI::IColumn* GetColumn ( simba_uint16  in_columnNum  )  [virtual]

Get the column metadata for the given column.

Parameters:
in_columnNum The zero-based column index.
Exceptions:
SEInvalidARguemtnException when the given column number is invalid.
Returns:
The column metadata for the given column. (NOT OWN)

Implements AEQueryOperation.

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

Implements 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