Endeca Presentation API
AnalyticsQuery Class
NamespacesEndeca.Navigation.AnalyticsAnalyticsQuery
An AnalyticsQuery is an ordered list of Statement objects.
Declaration Syntax
C#Visual BasicVisual C++
public class AnalyticsQuery : IObjectList, 
	IQueryNode
Public Class AnalyticsQuery _
	Implements IObjectList, IQueryNode
public ref class AnalyticsQuery : IObjectList, 
	IQueryNode
Members
All MembersConstructorsMethods



IconMemberDescription
AnalyticsQueryAnalyticsQueryNew()()
Constructs a new, empty AnalyticsQuery.

Add(Object)
Appends a Statement object to the end of the collection.

Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Finalize()()
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Get(Int32)
Gets a Statement from the AnalyticsQuery.

GetHashCode()()
Serves as a hash function for a particular type. GetHashCode()() is suitable for use in hashing algorithms and data structures like a hash table.
(Inherited from Object.)
GetType()()
Gets the Type of the current instance.
(Inherited from Object.)
MemberwiseClone()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
static memberparseQuery(String)
Parses a String form of a Statement query and returns an instance of an AnalyticsQuery if the query is well-formed.

Remove(Int32)
Removes a Statement object from the AnalyticsQuery.

Size()()
Returns the number of Statement objects in this AnalyticsQuery.

ToString()()
Returns the string form of the syntax tree rooted at this AnalyticsQuery.
(Overrides Object.ToString()().)
ToWire()()
Returns the wire form of this AnalyticsQuery.

ValidateSyntax()()
Validates the syntax of this AnalyticsQuery.

Remarks
After creation, the AnalyticsQuery object is set in an ENEQuery object via the AnalyticsQuery setter property.

When the query is executed on the MDEX Engine, each Statement transforms an input set of records into a resulting stream of aggregated records. Each Statement operates on the record set produced by some previous Statement, or on the records in the Navigation State, or on all the records in the MDEX Engine. Note that each Statement in the AnalyticsQuery must have a unique name.

Users can construct an AnalyticsQuery with either the programmatic interface or a text-based syntax. Much of the text-based syntax is based on a subset of the SQL language. Use the parseQuery(String) parser method to create an AnalyticsQuery from the String representation of the query. For example, if str is a String that has been initialized to a valid query, then the statement:

CopyC#
AnalyticsQuery analytics = AnalyticsQuery.parseQuery(str);
creates an AnalyticsQuery when the str query is parsed.

Inheritance Hierarchy
Object
AnalyticsQuery

Assembly: Endeca.Navigation (Module: Endeca.Navigation) Version: 0.0.0.0