com.endeca.mobile.abstraction
Class AggRecordsAbstraction

java.lang.Object
  com.endeca.mobile.abstraction.AggRecordsAbstraction

public final class AggRecordsAbstraction
extends java.lang.Object

The AggRecordsAbstractionPlugin retrieves aggregated record result set information; it adds its data to the AbstractedResults object, under the key "AggrRecords". If no records are returned with the current query, this key will not exist. If the current query is a record detail query rather than a navigation/search query, the record(s) will still be found and abstracted in the same way by this plugin.

All information added to the AbstractedResult object by the AggRecordsAbstractionPlugin is contained within one master array. This array contains record information in the order in which it was returned by the engine. Each record is represented in a hash. This hash is created by the "abstractifyERec()" method contained in the AbstractionPlugin superclass.

Each record hash contains the following information:

Record Spec	the value of the record's record specifier
Properties	a hash containing property information for the record. Each value in the hash is keyed by property name. For single-assigned properties, the value will be a string containing the property value; for multi- assigned properties, the value will be an array containing the property values.

Constructor Summary

AggRecordsAbstraction()

Method Summary

static java.util.HashMap	abstractifyAggrERec(com.endeca.navigation.AggrERec aggRec, AbstractionContext context) Method to turn an AggrERec into a generic HashMap.
static java.util.ArrayList	abstractifyAggrERecList(com.endeca.navigation.AggrERecList recList, AbstractionContext context) Converts a list of aggregate records to a form suitable for serialization.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AggRecordsAbstraction

public AggRecordsAbstraction()

Method Detail

abstractifyAggrERecList

public static java.util.ArrayList abstractifyAggrERecList(com.endeca.navigation.AggrERecList recList,
                                                          AbstractionContext context)

Converts a list of aggregate records to a form suitable for serialization.

Parameters:

pRecList - The aggregate record list

context - The context for the current request

Returns:

The converted list

abstractifyAggrERec

public static java.util.HashMap abstractifyAggrERec(com.endeca.navigation.AggrERec aggRec,
                                                    AbstractionContext context)

Method to turn an AggrERec into a generic HashMap.

Parameters:

aggRec - AggrERec that should be turned into a HashMap