class MAGES::Analytics::Query

Overview

Class that represents a query. More…

class Query: public MAGES::Analytics::MAGESAnalyticsObject
{
public:
    // properties

    object Payload;
    bool GeneratedResult;

    // methods

    bool Unwrap();
    Query SetIterator(IQueryIterator iterator);
    Query SetIfFiltering(bool filtering);
    Query SetFilter(string pattern, List scope, string field = "");
    Query SetProcessor(Processor processor);
    Query SetArguments(List arguments);
    Query Process();
    virtual override JProperty Export();
};

Inherited Members


public:
    // properties

    JProperty SerializedObject;

    // methods

    virtual T SetName(string name);
    virtual T SetTag(string tag);
    virtual string GetTag();
    virtual T SetTarget(object target);
    virtual T SetMessage(string message);
    virtual abstract JProperty Export() = 0;


Detailed Documentation


Class that represents a query.


Properties


object Payload


Gets query’s resulting payload.


bool GeneratedResult


Gets a value indicating whether the processing result of the processor succeeds the comparison with the target.


Methods


bool Unwrap()


Unwraps the query to indicate whether or not it was successfull.


Returns:


True or false depending on whether or not the query was successfull.


Query SetIterator(IQueryIterator iterator)


Sets the iterator for how the query will iterate over the data.


Parameters:









iterator


The iterator.







Returns:


The instance of this Query.


Query SetIfFiltering(bool filtering)


Sets if the query will filter data form the data container.


Parameters:









filtering


Defines if the query will do filtering from the data container or not.







Returns:


The instance of this Query.


Query SetFilter(string pattern, List scope, string field = "")


Sets the filtering context.


Parameters:









pattern


The pattern to filter from.




scope


Specific keys from the filtered data to apply processing to.




field


Retireve a specific field from the filtered data.







Returns:


The instance of this Query.


Query SetProcessor(Processor processor)


Sets the processor that will be applied to the querys’ filtered data.


Parameters:









processor


The processor that will be applied to the querys’ filtered data.







Returns:


The instance of this Query.


Query SetArguments(List arguments)

Sets the arguments of the query for added context in the processing.


Parameters:









arguments


The arguments of the query.







Returns:


The instance of this Query.


Query Process()


Filters the data from the given context and applies the processor to the filtered data.


Returns:


The instance of this Query.


virtual override JProperty Export()


Exports the analytics object.


Returns:


The JObject containg the event data.