AECustomAggregateFn Class Reference

A class that models custom Set Functions in SQL-92 (aka Aggregate Functions). More...

Inherits Simba::SQLEngine::AEUnaryValueExpr.

List of all members.

Public Member Functions

virtual void AcceptVisitor (AENodeVisitor &in_visitor)
 Calls the correct method on the visitor.
 AECustomAggregateFn (const AECustomAggregateFn &in_other)
 Copy constructor.
 AECustomAggregateFn (SharedPtr< DSIExtAggregateFunction > in_aggrFn, SharedPtr< AEValueExpr > in_expr)
 Constructor.
virtual AECustomAggregateFnClone () const
 Creates a clone of this node object.
const simba_wstringGetAggrFnName () const
 Returns the name which identifies the aggregate Function.
virtual const AECustomAggregateFnGetAsCustomAggregateFn () const
 Retrieves the object as an AECustomAggregateFn object.
virtual AECustomAggregateFnGetAsCustomAggregateFn ()
 Retrieves the object as an AECustomAggregateFn object.
virtual simba_wstring GetLogString () const
 Returns a string name for this node for the purpose of logging.
virtual SqlTypeMetadataGetMetadata () const
 Returns the SqlTypeMetadata associated with this aggregate function.
virtual AENodeType GetNodeType () const
 Returns an integer that uniquely identifies the node class.
SESetQuantifier GetSetQuantifier () const
 This method returns the set quantifier id.
virtual bool UpdateMetadata (Simba::SQLEngine::DSIExtDataEngineContext *in_deContext)
 Updates the SqlTypeMetadata* describing the column, if needed.
virtual ~AECustomAggregateFn ()
 Destructor.

Protected Member Functions

virtual bool IsEqual (const AENode *in_another) const
 Tell whether two nodes are "equal".

Detailed Description

A class that models custom Set Functions in SQL-92 (aka Aggregate Functions).

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


Constructor & Destructor Documentation

Constructor.

Parameters:
in_aggrFn The DSI custom aggregate function.
in_expr The expression for this function.
AECustomAggregateFn ( const AECustomAggregateFn in_other  ) 

Copy constructor.

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

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

Creates a clone of this node object.

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

Implements AEUnaryValueExpr.

const simba_wstring& GetAggrFnName (  )  const

Returns the name which identifies the aggregate Function.

Returns:
The name which identifies the aggregate Function.
virtual const AECustomAggregateFn* GetAsCustomAggregateFn (  )  const [virtual]

Retrieves the object as an AECustomAggregateFn object.

Overrides the method defined in AEValueExpr.

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

Reimplemented from AEValueExpr.

virtual AECustomAggregateFn* GetAsCustomAggregateFn (  )  [virtual]

Retrieves the object as an AECustomAggregateFn object.

Overrides the method defined in AEValueExpr.

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

Reimplemented from AEValueExpr.

virtual simba_wstring GetLogString (  )  const [virtual]

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

Exceptions:
SEInvalidArgumentException when m_functionID is an invalid function ID.
Returns:
A string representation of this node for logging purposes.

Implements AENode.

virtual SqlTypeMetadata* GetMetadata (  )  const [virtual]

Returns the SqlTypeMetadata associated with this aggregate function.

Returns:
The SqlTypeMetadata associated with this aggregate function. (NOT OWN)

Reimplemented from AEUnaryValueExpr.

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.

SESetQuantifier GetSetQuantifier (  )  const

This method returns the set quantifier id.

Returns:
The set quantifier id.
virtual bool IsEqual ( const AENode in_another  )  const [protected, virtual]

Tell whether two nodes are "equal".

Two AECustomAggregateFn'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 bool UpdateMetadata ( Simba::SQLEngine::DSIExtDataEngineContext in_deContext  )  [virtual]

Updates the SqlTypeMetadata* describing the column, if needed.

Parameters:
in_deContext The current DataEngine context. (NOT OWN)
Returns:
True if the metadata was updated; false otherwise.

Reimplemented from AEValueExpr.


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