AENativeSyntax Class Reference

A class that models a native syntax. 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.
 AENativeSyntax (const AENativeSyntax &in_other)
 Copy constructor.
 AENativeSyntax (SharedPtr< DSIExtNativeSyntax > in_nativeSyntax, AutoPtr< AEValueList > in_parameterValueList, AutoVector< SqlTypeMetadata > &in_parameterMetadata, std::vector< simba_wstring > &in_parameterNamesVector, AutoPtr< Simba::DSI::DSIResultSetColumns > in_columns, bool in_isReturning)
 Constructor.
virtual AENativeSyntaxClone () const
 Creates a clone of this node object.
virtual const AENativeSyntaxGetAsNativeSyntax () const
 Retrieves the object as an AENativeSyntax object.
virtual AENativeSyntaxGetAsNativeSyntax ()
 Retrieves the object as an AENativeSyntax 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)
 Retrieves the column metadata for the given column.
virtual simba_uint16 GetColumnCount ()
 Returns the number of columns in this query operation.
bool GetIsReturning () const
 Returns true if this native syntax returns a single value, false otherwise.
virtual simba_wstring GetLogString () const
 Returns a string name for this node for the purpose of logging.
SharedPtr
< Simba::SQLEngine::DSIExtNativeSyntax
GetNativeSyntax ()
 Retrieves the SharedPtr wrapping the DSIExtNativeSyntax object.
virtual AENodeType GetNodeType () const
 Returns an integer that uniquely identifies the node class. See the definition of AENodeType for values defined.
AEValueListGetParamList () const
 Retrieves the pointer to the parameters list.
const AutoVector
< SqlTypeMetadata > & 
GetParamMetadata () const
 Retrieves autovector that holds the metadata about the type of each parameter of the native syntax.
const std::vector
< simba_wstring > & 
GetParamNames () const
 Retrieves a reference to the simba_wstring vector of parameter names.
Simba::DSI::DSIResultSetColumnsGetResultColumns () const
 Retrieves pointer to the result set columns.
bool HasParamsList () const
 Returns true if NativeSyntax nodes has parameters, False otherwise.
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 void Validate ()
 Validates the node.
virtual ~AENativeSyntax ()
 Destructor.

Detailed Description

A class that models a native syntax.


Constructor & Destructor Documentation

AENativeSyntax ( SharedPtr< DSIExtNativeSyntax in_nativeSyntax,
AutoPtr< AEValueList in_parameterValueList,
AutoVector< SqlTypeMetadata > &  in_parameterMetadata,
std::vector< simba_wstring > &  in_parameterNamesVector,
AutoPtr< Simba::DSI::DSIResultSetColumns in_columns,
bool  in_isReturning 
)

Constructor.

Parameters:
in_nativeSyntax The Native Syntax from the DSI.
in_parameterValueList The parameters list for Native Syntax.
in_parameterMetadata The parameters metadata.
in_parameterNamesVector Vector of parameter names.
in_columns The metadata of columns for the result of native syntax.
in_isReturning True if the native syntax returns a value.
AENativeSyntax ( const AENativeSyntax in_other  ) 

Copy constructor.

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

Parameters:
in_other The other node to create copy from.
virtual ~AENativeSyntax (  )  [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 AENativeSyntax* Clone (  )  const [virtual]

Creates a clone of this node object.

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

Implements AERelationalExpr.

virtual const AENativeSyntax* GetAsNativeSyntax (  )  const [inline, virtual]

Retrieves the object as an AENativeSyntax object.

Overrides the method defined in AERelationalExpr.

Returns:
this object always. (NOT OWN)
virtual AENativeSyntax* GetAsNativeSyntax (  )  [inline, virtual]

Retrieves the object as an AENativeSyntax object.

Overrides the method defined in AERelationalExpr.

Returns:
this object always. (NOT OWN)
virtual const AENode* GetChild ( simba_size_t  in_index  )  const [virtual]

Gets a pointer reference to the specified child node.

Parameters:
in_index The zero-based index for the child.
Exceptions:
SEInvalidOperationException if the index is invalid.
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.

Parameters:
in_index The zero-based index for the child.
Exceptions:
SEInvalidOperationException if the index is invalid.
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.

Returns:
The number of child nodes.

Implements AENode.

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

Retrieves the column metadata for the given column.

Parameters:
in_columnNum The zero-base column index.
Exceptions:
SEInvalidArgumentException 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.

bool GetIsReturning (  )  const

Returns true if this native syntax returns a single value, false otherwise.

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.

Retrieves the SharedPtr wrapping the DSIExtNativeSyntax object.

Returns:
SharedPtr to the DSIExtNativeSyntax object.
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.

AEValueList* GetParamList (  )  const

Retrieves the pointer to the parameters list.

const AutoVector<SqlTypeMetadata>& GetParamMetadata (  )  const

Retrieves autovector that holds the metadata about the type of each parameter of the native syntax.

const std::vector<simba_wstring>& GetParamNames (  )  const

Retrieves a reference to the simba_wstring vector of parameter names.

Simba::DSI::DSIResultSetColumns* GetResultColumns (  )  const

Retrieves pointer to the result set columns.

bool HasParamsList (  )  const

Returns true if NativeSyntax nodes has parameters, False otherwise.

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.

virtual void Validate (  )  [virtual]

Validates the node.

Exceptions:
AEInvalidAetException if the node is not valid.

Reimplemented from AENode.


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