com.yahoo.bard.webservice.data

Class PreResponseDeserializer

java.lang.Object

com.yahoo.bard.webservice.data.PreResponseDeserializer

public class PreResponseDeserializer
extends Object

Class to de-serialize and prepare the PreResponse object from JSON. The advantages of custom deserialization are: a. We can reconstruct the dimension rows for each result with the help of dimension dictionary. b. Schema object de-serialization is more efficient then the default one. c. Provides the flexibility of optimizing serialization

Sample serialized PreResponse string

 
  {
         "responseContext": "[
                 "com.yahoo.bard.webservice.web.responseprocessors.ResponseContext",
                 {
                     "randomHeader": "someHeader",
                     "missingIntervals": ["java.util.ArrayList",
                         ["a","b", "c",
                             ["java.util.ArrayList",
                                 [
                                    [
                                     "org.joda.time.Interval",
                                     "2011-02-02T07:00:00.000Z/2011-02-03T10:15:00.000Z"
                                    ]
                                 ]
                             ],
                             [
                                 "java.math.BigDecimal",100
                             ]
                         ]
                     ]
                 }
         ]",
         "resultSet": {
             "results": [
                 {
                 "dimensionRows": {
                     "ageBracket": "1",
                     "country": "US",
                     "gender": "m"
                 },
                     "metricsRows": {
                     "lookbackPageViews": 112,
                     "retentionPageViews": 113,
                     "simplePageViews": 111
                 },
                 "timeStamp": "2016-01-12T00:00:00.000Z"
                 },
                 {
                     "dimensionRows": {
                     "ageBracket": "4",
                     "country": "IN",
                     "gender": "f"
                 },
                     "metricsRows": {
                     "lookbackPageViews": 212,
                     "retentionPageViews": 213,
                     "simplePageViews": 211
                 },
                 "timeStamp": "2016-01-12T00:00:00.000Z"
                 }
             ],
             "schema": {
                 "dimensionColumns": [
                     "ageBracket",
                     "country",
                     "gender"
                 ],
                     "granularity": "day",
                     "metricColumns": [
                     "lookbackPageViews",
                     "simplePageViews",
                     "retentionPageViews"
                 ],
                     "metricColumnsType": {
                     "lookbackPageViews": "java.math.BigDecimal",
                     "retentionPageViews": "java.math.BigDecimal",
                     "simplePageViews": "java.math.BigDecimal"
                 },
                 "timeZone": "UTC"
             }
         }
   }
 
 

Field Summary

Fields

Modifier and Type	Field and Description
static SystemConfig	SYSTEM_CONFIG

Constructor Summary

Constructors

Constructor and Description
PreResponseDeserializer(DimensionDictionary dimensionDictionary, com.fasterxml.jackson.databind.ObjectMapper nonResponseContextMapper, com.fasterxml.jackson.databind.ObjectMapper responseContextMapper, GranularityParser granularityParser) Class constructor.

Method Summary

Modifier and Type	Method and Description
PreResponse	deserialize(String preResponse) Deserialize the custom serialized PreResponse.
DimensionDictionary	getDimensionDictionary()
GranularityParser	getGranularityParser()
com.fasterxml.jackson.databind.ObjectMapper	getNonResponseContextMapper()
com.fasterxml.jackson.databind.ObjectMapper	getResponseContextMapper()

Methods inherited from class java.lang.Object

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

Field Detail

SYSTEM_CONFIG

public static final SystemConfig SYSTEM_CONFIG

Constructor Detail

PreResponseDeserializer

public PreResponseDeserializer(DimensionDictionary dimensionDictionary,
                               com.fasterxml.jackson.databind.ObjectMapper nonResponseContextMapper,
                               com.fasterxml.jackson.databind.ObjectMapper responseContextMapper,
                               GranularityParser granularityParser)

Class constructor.

Parameters:

dimensionDictionary - DimensionDictionary which contains all the details about dimensions

nonResponseContextMapper - Handles the deserialization of everything except the response context

responseContextMapper - Handles the deserialization of the response context of the PreResponse

granularityParser - Time grain provider

Method Detail

deserialize

public PreResponse deserialize(String preResponse)
                        throws IOException

Deserialize the custom serialized PreResponse.

Parameters:

preResponse - Custom serialized PreResponse

Returns:

De-serialized PreResponse object

Throws:

IOException - in case of deserialization of ResponseContext fails

getDimensionDictionary

public DimensionDictionary getDimensionDictionary()

getNonResponseContextMapper

public com.fasterxml.jackson.databind.ObjectMapper getNonResponseContextMapper()

getResponseContextMapper

public com.fasterxml.jackson.databind.ObjectMapper getResponseContextMapper()

getGranularityParser

public GranularityParser getGranularityParser()