wxSQLite3  4.4.6
Public Member Functions | Friends | List of all members
wxSQLite3WindowFunction Class Referenceabstract

Interface for user defined aggregate window functions. More...

#include <wxsqlite3.h>

Public Member Functions

 wxSQLite3WindowFunction ()
 Constructor. More...
 
virtual ~wxSQLite3WindowFunction ()
 Virtual destructor. More...
 
virtual void Aggregate (wxSQLite3FunctionContext &ctx)=0
 Execute the aggregate of the window function. More...
 
virtual void Finalize (wxSQLite3FunctionContext &ctx)=0
 Prepare the result of the aggregate window function. More...
 
virtual void CurrentValue (wxSQLite3FunctionContext &ctx)=0
 Get current value of the aggregate window function. More...
 
virtual void Reverse (wxSQLite3FunctionContext &ctx)=0
 Reverse an aggregate step of the window function. More...
 

Friends

class wxSQLite3FunctionContext
 

Detailed Description

Interface for user defined aggregate window functions.

Constructor & Destructor Documentation

◆ wxSQLite3WindowFunction()

wxSQLite3WindowFunction::wxSQLite3WindowFunction ( )
inline

Constructor.

◆ ~wxSQLite3WindowFunction()

virtual wxSQLite3WindowFunction::~wxSQLite3WindowFunction ( )
inlinevirtual

Virtual destructor.

Member Function Documentation

◆ Aggregate()

virtual void wxSQLite3WindowFunction::Aggregate ( wxSQLite3FunctionContext ctx)
pure virtual

Execute the aggregate of the window function.

This method is invoked for each row of the result set of the query using the aggregate window function.

Parameters
ctxfunction context which can be used to access arguments and result value

◆ CurrentValue()

virtual void wxSQLite3WindowFunction::CurrentValue ( wxSQLite3FunctionContext ctx)
pure virtual

Get current value of the aggregate window function.

This method is invoked to return the current value of the aggregate. Unlike Finalize, the implementation should not delete any context.

Parameters
ctxfunction context which can be used to access arguments and result value

◆ Finalize()

virtual void wxSQLite3WindowFunction::Finalize ( wxSQLite3FunctionContext ctx)
pure virtual

Prepare the result of the aggregate window function.

This method is invoked after all rows of the result set of the query using the aggregate window function have been processed. Usually the final result is calculated and returned in this method.

Parameters
ctxfunction context which can be used to access arguments and result value

◆ Reverse()

virtual void wxSQLite3WindowFunction::Reverse ( wxSQLite3FunctionContext ctx)
pure virtual

Reverse an aggregate step of the window function.

This method is invoked to remove a row from the current window. The function arguments, if any, correspond to the row being removed.

Parameters
ctxfunction context which can be used to access arguments and result value

Friends And Related Function Documentation

◆ wxSQLite3FunctionContext

friend class wxSQLite3FunctionContext
friend

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