AETop Class Reference

A class that models a TOP N operation. More...

Inherits Simba::SQLEngine::AEUnaryRelationalExpr.

List of all members.

Public Member Functions

virtual void AcceptVisitor (AENodeVisitor &in_visitor)
 Calls the correct method on the visitor.
 AETop (const AETop &in_other)
 Copy constructor.
 AETop (AutoPtr< AERelationalExpr > in_operand, SharedPtr< AEValueExpr > in_skipValueExpr, SharedPtr< AEValueExpr > in_topValueExpr)
 Constructor.
 AETop (AutoPtr< AERelationalExpr > in_operand, SharedPtr< AEValueExpr > in_valueExpr, bool in_isPercent)
 Constructor.
virtual AETopClone () const
 Creates a clone of this node object.
virtual const AETopGetAsTop () const
 Gets the object as an AETop object.
virtual AETopGetAsTop ()
 Gets the object as an AETop object.
virtual Simba::DSI::IColumnGetColumn (simba_uint16 in_columnNum)
 Gets the column for the given column number.
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.
AEValueExprGetSkipValueExpr ()
 Get a reference to the value expression for the skip count.
AEValueExprGetTopValueExpr ()
 Get a reference to the value expression for the top count.
bool IsPercent () const
 Returns true if this is a TOP n PERCENT.
SharedPtr< AEValueExprReplaceSkipValueExpr (SharedPtr< AEValueExpr > in_toReplaceWith)
 Replace the value expression for the skip count.
SharedPtr< AEValueExprReplaceTopValueExpr (SharedPtr< AEValueExpr > in_toReplaceWith)
 Replace the value expression for the top count.
virtual ~AETop ()
 Destructor.

Detailed Description

A class that models a TOP N operation.

An AETop node is built only when there is no ORDER BY clause in the current query scope.

See also:
AETopNSort.

Will always have one child (GetChildCount() returns 1):


Constructor & Destructor Documentation

AETop ( AutoPtr< AERelationalExpr in_operand,
SharedPtr< AEValueExpr in_valueExpr,
bool  in_isPercent 
)

Constructor.

Parameters:
in_operand The operand for this relational expression
in_valueExpr The value expression representing the row limit.
in_isPercent Boolean indicating if in_valueExpr represents a percentage. [0.0-100.0]
AETop ( AutoPtr< AERelationalExpr in_operand,
SharedPtr< AEValueExpr in_skipValueExpr,
SharedPtr< AEValueExpr in_topValueExpr 
)

Constructor.

Parameters:
in_operand The operand for this relational expression
in_skipValueExpr The value expression representing the skip count
in_topValueExpr The value expression representing the row limit.
AETop ( const AETop in_other  ) 

Copy constructor.

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

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

Creates a clone of this node object.

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

Implements AEUnaryRelationalExpr.

virtual const AETop* GetAsTop (  )  const [virtual]

Gets the object as an AETop object.

Overrides the method defined in AERelationalExpr.

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

Reimplemented from AERelationalExpr.

virtual AETop* GetAsTop (  )  [virtual]

Gets the object as an AETop object.

Overrides the method defined in AERelationalExpr.

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

Reimplemented from AERelationalExpr.

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

Gets the column for the given column number.

The caller of this method does not own the returned object.

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

Implements AENode.

AEValueExpr* GetSkipValueExpr (  ) 

Get a reference to the value expression for the skip count.

Returns:
a pointer reference to the value expression. (NOT OWN)
AEValueExpr* GetTopValueExpr (  ) 

Get a reference to the value expression for the top count.

Returns:
a pointer reference to the value expression. (NOT OWN)
bool IsPercent (  )  const

Returns true if this is a TOP n PERCENT.

Returns:
true if this is a TOP n PERCENT
SharedPtr<AEValueExpr> ReplaceSkipValueExpr ( SharedPtr< AEValueExpr in_toReplaceWith  )  [inline]

Replace the value expression for the skip count.

Parameters:
in_toReplaceWith The value expression to replace it with. Cannot be NULL.
Returns:
The current value expression for the skip count.
SharedPtr<AEValueExpr> ReplaceTopValueExpr ( SharedPtr< AEValueExpr in_toReplaceWith  )  [inline]

Replace the value expression for the top count.

Parameters:
in_toReplaceWith The value expression to replace it with. Cannot be NULL.
Returns:
The current value expression for the top count.

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