Provided QueryFunction classes

This topic defines the QueryFunction classes included in the Discovery Framework.

Filters

Function Class ENEQuery Equivalent Configuration Properties Notes
EQLFilter setNavRecord¬ StructureExpr() eqlFilter: String Applying an EQL filter always overwrites a previous EQLFilter
NegativeRefinement¬ Filter setNavRecordFilter()

dimValName: String

dimValId: String

dimensionName: String

dimensionId: String

ancestors: String[]

RangeFilter setNavRangeFilters()

property: String

rangeOperator:

(LT|LTEQ|GT|GTEQ¬

|BTWN|GCLT|GCGT|GCBTWN)

value1: numeric

value2: numeric (optional)

value3: numeric (optional)

RecordAggregator setNavRollupKey()

rollupKey: String

aggCount:

({{ONE_EREC_PER_AGGR|

ALL_ERECS_PER_AGGR|

ZERO_ERECS_PER_AGGR)}}

RecordFilter setNavRecordFilter() recordFilter: String
RecordSpecListFilter

setERecs()

recSpecs: String[]

Applying a RecordSpecListFilter

always overwrites a previous RecordSpecListFilter

RefinementFilter setNavDescriptors()

dimValId: long

dimensionId: long

multiSelect:

(AND|OR|NONE) (optional)

navigable:

(true|false) (optional)

SearchFilter setNavERecSearches()

searchInterface: String

terms: String

matchMode:

(ALL|PARTIAL|ANY|

ALLANY|ALLPARTIAL|

PARTIALMAX|BOOLEAN)

Configuration functions

Function Class ENEQuery Equivalent Configuration Properties Notes
AnalyticsQueryConfig setAnalyticsQuery() analyticsQuery: String
AttributeValueSearch¬ Config

setDimSearchTerms()

setDimSearch¬ NavDescriptors()

setDimSearch¬ NavRangeFilters()

setDimSearch¬ NavRecordFilters()

setDimSearch¬ NumDimValues()

setDimSearch¬ NavRecordStructure Expr()

searchTerm: String

maxValuesToReturn: int (optional)

attribute: String (optional)

searchWithIn: List<String> (optional - list of attributes)

matchMode:

(ALL|PARTIAL|ANY|

ALLANY|ALLPARTIAL|

PARTIALMAX|BOOLEAN) (optional)

relevanceRanking¬ Strategy: String (optional)

searchWithIn is a list of attributes against which to search; attribute property is automatically included in this list.
ExposeRefinement setNavExposed¬ Refinements()

dimValId: String

dimensionId: String

ownerId: String (optional)

dimExposed: boolean (optional)

exposeAll: boolean (optional)

maxRefinements: int (optional; ignored for ENEQueries)

groupKey: String (optional; ignored for ENEQueries)

groupExposed: boolean (optional; ignored for ENEQueries)

At least one of dimValId or dimensionId is required. ownerId can be the ID of a NavConfig instance.

dimExposed indicates whether the dimension is exposed. exposeAll indicates whether the dimension is fully exposed (that is, the "More..." link is selected).

NavConfig setNavAllRefinements

exposeAllRefinements: boolean

ResultsConfig

setNavNumERecs()

setNavERecsOffset()

setSelection

recordsPerPage: long

offset: long (optional)

columns: String[] (optional)

numBulkRecords: int (optional)

ResultsSummaryConfig N/A Sets the number of returned ERecs and AggrERecs to 0
SortConfig setNavActiveSortKeys()

property: String

ascending: boolean