Endeca Presentation API
Statement Class
NamespacesEndeca.Navigation.AnalyticsStatement
A Statement represents a pass over a set of input records (those of the FROM table) to generate a set of output records.
Declaration Syntax
C#Visual BasicVisual C++
public class Statement : IQueryNode
Public Class Statement _
	Implements IQueryNode
public ref class Statement : IQueryNode
Members
All MembersConstructorsMethodsProperties



IconMemberDescription
StatementStatementNew()()
Constructs a new, empty Statement.

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.)
FirstPage
Gets the first row-number requested.

FromStatementName
Gets and sets the name of the FROM Statement.

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.)
GroupByList
Gets and sets the GroupByList for this Statement.

HavingFilter
Gets and sets the HAVING clause for this Statement.

MemberwiseClone()()
Creates a shallow copy of the current Object.
(Inherited from Object.)
Name
Gets and sets the name of the current Statement.

OrderByList
Gets and sets the OrderByList for this Statement.

Paged
Tests whether this Statement is paged.

PagesRequested
Gets the number of pages requested.

SelectList
Gets and sets the list of Select expressions for this Statement.

SetReturnRows(Int32, Int32)
Sets the rows to return for this Statement.

Shown
Gets and sets whether the Statement is a Return or DefineStatement.

ToString()()
Returns the string form of this Statement.
(Overrides Object.ToString()().)
ToWire()()
Returns the wire form of this Statement.

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

WhereFilter
Gets and sets the WHERE clause for this Statement.

Remarks
Input records and output records may be filtered; output records are populated with derived values, and with values by which the records are GROUPed. The output record set may be sorted and paged.

A Statement has the form:

  • RETURN {table-name} AS // required: RETURN or DEFINE: see Shown
  • SELECT // required
  • {expr1} AS {field1}, // required: at least one assignment.
  • {expr2} AS {field2},
  • ...
  • WHERE {filter} // optional
  • FROM {table-name} // optional
  • GROUP // optional: or GROUP BY {field}, {field},...
  • HAVING {filter} // optional
  • ORDER BY {field},{field}... // optional
  • PAGE({start}, {end}) // optional

NavStateRecords and AllBaseRecords are reserved table names. NavStateRecords is the default if the FROM clause is omitted.

Inheritance Hierarchy
Object
Statement

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