AESearchedCase Class Reference

This node class represents the Searched Case value expression. More...

Inherits Simba::SQLEngine::AEValueExpr.

List of all members.

Public Member Functions

virtual void AcceptVisitor (AENodeVisitor &in_visitor)
 Calls the correct method on the visitor.
 AESearchedCase (const AESearchedCase &in_other)
 Copy constructor.
 AESearchedCase (AutoPtr< AEValueList > in_whenClauseList, SharedPtr< AEValueExpr > in_elseClause, ICoercionHandler *in_coercionHandler)
 Constructor.
virtual AESearchedCaseClone () const
 Creates a clone of this node object.
virtual const AESearchedCaseGetAsSearchedCase () const
 Retrieves the object as an AESearchedCase object.
virtual AESearchedCaseGetAsSearchedCase ()
 Retrieves the object as an AESearchedCase 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 const
Simba::DSI::DSIColumnMetadata
GetColumnMetadata () const
 Gets a reference to the DSIColumnMetadata describing the column.
const AEValueExprGetElseClause () const
 Gets a reference to the else clause node.
AEValueExprGetElseClause ()
 Gets a reference to the else clause node.
virtual simba_wstring GetLogString () const
 Returns a string name for this node for the purpose of logging.
virtual SqlTypeMetadataGetMetadata () const
 Returns a SqlTypeMetadata* describing the column.
virtual AENodeType GetNodeType () const
 Returns an integer that uniquely identifies the node class.
const AEValueListGetWhenClauseList () const
 Gets a reference to the when clause list.
AEValueListGetWhenClauseList ()
 Gets a reference to the when clause list.
bool HasElseClause () const
void SetElseClause (SharedPtr< AEValueExpr > in_elseClause)
 Grants the ownership of the else clause to this object.
void SetWhenClauseList (AutoPtr< AEValueList > in_whenClauseList)
 Grants the ownership of the when clause list to this object.
SharedPtr< AEValueExprTakeElseClause ()
 Takes the ownership of the else clause away from this object.
AutoPtr< AEValueListTakeWhenClauseList ()
 Takes the ownership of the when clause list away from this object.
virtual ~AESearchedCase ()
 Destructor.

Detailed Description

This node class represents the Searched Case value expression.

Will have one or two children (GetChildCount() returns 1 or 2). Will have two children only if an else clause is present:


Constructor & Destructor Documentation

AESearchedCase ( AutoPtr< AEValueList in_whenClauseList,
SharedPtr< AEValueExpr in_elseClause,
ICoercionHandler in_coercionHandler 
)

Constructor.

Parameters:
in_whenClauseList The Searched When Clause List.
in_elseClause The Else Clause for this this Searched Case.
in_coercionHandler The ICoercionHandler for handling custom coercions. (NOT OWN)
AESearchedCase ( const AESearchedCase in_other  ) 

Copy constructor.

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

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

Creates a clone of this node object.

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

Implements AEValueExpr.

virtual const AESearchedCase* GetAsSearchedCase (  )  const [inline, virtual]

Retrieves the object as an AESearchedCase object.

Returns:
this object as an AESearchedCase object. (NOT OWN)

Reimplemented from AEValueExpr.

virtual AESearchedCase* GetAsSearchedCase (  )  [inline, virtual]

Retrieves the object as an AESearchedCase object.

Returns:
this object as an AESearchedCase object. (NOT OWN)

Reimplemented from AEValueExpr.

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 always since 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.

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

Returns:
The number of child nodes.

Implements AENode.

virtual const Simba::DSI::DSIColumnMetadata& GetColumnMetadata (  )  const [virtual]

Gets a reference to the DSIColumnMetadata describing the column.

Returns:
Reference to the DSIColumnMetadata describing the column.

Reimplemented from AEValueExpr.

const AEValueExpr* GetElseClause (  )  const

Gets a reference to the else clause node.

If the caller wishes to take control of the ownership of the else clause object, call TakeElseClause() instead.

Returns:
a pointer reference to the else clause node (NOT OWN)
AEValueExpr* GetElseClause (  ) 

Gets a reference to the else clause node.

If the caller wishes to take control of the ownership of the else clause object, call TakeElseClause() instead.

Returns:
a pointer reference to the else clause node (NOT OWN)
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 SqlTypeMetadata* GetMetadata (  )  const [virtual]

Returns a SqlTypeMetadata* describing the column.

Exceptions:
throws SEInvalidOperationException when SqlTypeMetadata is null
Returns:
The SqlTypeMetadata for the child 'then' node. (NOT OWN)

Reimplemented from AEValueExpr.

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.

const AEValueList* GetWhenClauseList (  )  const

Gets a reference to the when clause list.

If the caller wishes to take control of the ownership of the when clause list object, call TakeWhenClauseList() instead.

Returns:
a pointer reference to the when clause list (NOT OWN)
AEValueList* GetWhenClauseList (  ) 

Gets a reference to the when clause list.

If the caller wishes to take control of the ownership of the when clause list object, call TakeWhenClauseList() instead.

Returns:
a pointer reference to the when clause list (NOT OWN)
bool HasElseClause (  )  const

Returns true if this Searched Case has an Else Clause. Returns false otherwise.

Returns:
true if this Simple Case has an Else Clause; false otherwise
void SetElseClause ( SharedPtr< AEValueExpr in_elseClause  ) 

Grants the ownership of the else clause to this object.

Parameters:
in_elseClause The else clause
Exceptions:
SEInvalidArgumentException when in_elseClause.IsNull() returns true
SEInvalidOperationException when this object already has an else clause
void SetWhenClauseList ( AutoPtr< AEValueList in_whenClauseList  ) 

Grants the ownership of the when clause list to this object.

Parameters:
in_whenClauseList The when clause list.
Exceptions:
SEInvalidArgumentException when in_whenClauseList.IsNull() returns true
SEInvalidOperationException when this object already has a when clause list
SharedPtr<AEValueExpr> TakeElseClause (  ) 

Takes the ownership of the else clause away from this object.

If the caller only wants to access the else clause list, call GetElseClause() instead.

Exceptions:
SEInvalidOperationException when in_elseClause.IsNull() returns true
Returns:
The else clause. (OWN)
AutoPtr<AEValueList> TakeWhenClauseList (  ) 

Takes the ownership of the when clause list away from this object.

If the caller only wants to access the when clause list, call GetWhenClauseList() instead.

Exceptions:
SEInvalidOperationException when m_whenClauseList.IsNull() returns true
Returns:
The when clause list (OWN)

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

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