com.yahoo.bard.webservice.web

Class ResponseData

java.lang.Object

com.yahoo.bard.webservice.web.ResponseData

public class ResponseData
extends Object

ResponseData class. A bag of metadata that may be needed by the `ResponseWriter` to serialize Fili's response, including the `ResultSet` itself, along with a collection of methods to help `ResponseWriters` perform serialization.

Field Summary

Fields

Modifier and Type	Field and Description
protected LinkedHashSet<MetricColumn>	apiMetricColumns
protected static Map<Dimension,Map<DimensionField,String>>	DIMENSION_FIELD_COLUMN_NAMES
protected static org.slf4j.Logger	LOG
protected SimplifiedIntervalList	missingIntervals
protected Pagination	pagination
protected Map<String,URI>	paginationLinks
protected LinkedHashMap<Dimension,LinkedHashSet<DimensionField>>	requestedApiDimensionFields
protected ResultSet	resultSet
protected SimplifiedIntervalList	volatileIntervals

Constructor Summary

Constructors

Constructor and Description
ResponseData(ResultSet resultSet, DataApiRequest apiRequest, SimplifiedIntervalList missingIntervals, SimplifiedIntervalList volatileIntervals, Pagination pagination, Map<String,URI> paginationLinks) Deprecated. All the values needed to build a Response should be passed explicitly instead of relying on the DataApiRequest
ResponseData(ResultSet resultSet, LinkedHashSet<String> apiMetricColumnNames, LinkedHashMap<Dimension,LinkedHashSet<DimensionField>> requestedApiDimensionFields, SimplifiedIntervalList missingIntervals, SimplifiedIntervalList volatileIntervals, Pagination pagination, Map<String,URI> paginationLinks) Constructor.

Method Summary

Modifier and Type	Method and Description
List<String>	buildIntervalStringList(Collection<org.joda.time.Interval> intervals) Build a list of interval strings.
Map<String,Object>	buildResultRow(Result result) Builds map of result row from a result.
Map<String,Object>	buildResultRowWithSidecars(Result result, Map<Dimension,Set<Map<DimensionField,String>>> sidecars) Builds map of result row from a result and loads the dimension rows into the sidecar map.
protected LinkedHashSet<MetricColumn>	generateApiMetricColumns(Set<String> apiMetricColumnNames) Builds a set of only those metric columns which correspond to the metrics requested in the API.
Stream<String>	generateDimensionColumnHeaders(Map.Entry<Dimension,LinkedHashSet<DimensionField>> entry) Build the headers for the dimension columns.
LinkedHashSet<MetricColumn>	getApiMetricColumns()
protected static String	getDimensionColumnName(Dimension dimension, DimensionField dimensionField) Retrieve dimension column name from cache, or build it and cache it.
SimplifiedIntervalList	getMissingIntervals()
Pagination	getPagination()
Map<String,URI>	getPaginationLinks()
LinkedHashMap<Dimension,LinkedHashSet<DimensionField>>	getRequestedApiDimensionFields()
ResultSet	getResultSet()
SimplifiedIntervalList	getVolatileIntervals()

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final org.slf4j.Logger LOG

DIMENSION_FIELD_COLUMN_NAMES

protected static final Map<Dimension,Map<DimensionField,String>> DIMENSION_FIELD_COLUMN_NAMES

resultSet

protected final ResultSet resultSet

apiMetricColumns

protected final LinkedHashSet<MetricColumn> apiMetricColumns

requestedApiDimensionFields

protected final LinkedHashMap<Dimension,LinkedHashSet<DimensionField>> requestedApiDimensionFields

missingIntervals

protected final SimplifiedIntervalList missingIntervals

volatileIntervals

protected final SimplifiedIntervalList volatileIntervals

pagination

protected final Pagination pagination

paginationLinks

protected final Map<String,URI> paginationLinks

Constructor Detail

ResponseData

public ResponseData(ResultSet resultSet,
                    LinkedHashSet<String> apiMetricColumnNames,
                    LinkedHashMap<Dimension,LinkedHashSet<DimensionField>> requestedApiDimensionFields,
                    SimplifiedIntervalList missingIntervals,
                    SimplifiedIntervalList volatileIntervals,
                    Pagination pagination,
                    Map<String,URI> paginationLinks)

Constructor.

Parameters:

resultSet - ResultSet to turn into response

apiMetricColumnNames - The names of the logical metrics requested

requestedApiDimensionFields - The fields for each dimension that should be shown in the response

missingIntervals - intervals over which partial data exists

volatileIntervals - intervals over which data is understood as 'best-to-date'

pagination - The object containing the pagination information. Null if we are not paginating.

paginationLinks - A mapping from link names to links to be added to the end of the JSON response.

ResponseData

@Deprecated
public ResponseData(ResultSet resultSet,
                                DataApiRequest apiRequest,
                                SimplifiedIntervalList missingIntervals,
                                SimplifiedIntervalList volatileIntervals,
                                Pagination pagination,
                                Map<String,URI> paginationLinks)

Deprecated. All the values needed to build a Response should be passed explicitly instead of relying on the DataApiRequest

Constructor.

Parameters:

resultSet - ResultSet to turn into response

apiRequest - API Request to get the metric columns from

missingIntervals - intervals over which partial data exists

volatileIntervals - intervals over which data is understood as 'best-to-date'

pagination - The object containing the pagination information. Null if we are not paginating.

paginationLinks - A mapping from link names to links to be added to the end of the JSON response.

Method Detail

getResultSet

public ResultSet getResultSet()

getMissingIntervals

public SimplifiedIntervalList getMissingIntervals()

getVolatileIntervals

public SimplifiedIntervalList getVolatileIntervals()

getPagination

public Pagination getPagination()

getPaginationLinks

public Map<String,URI> getPaginationLinks()

getRequestedApiDimensionFields

public LinkedHashMap<Dimension,LinkedHashSet<DimensionField>> getRequestedApiDimensionFields()

getApiMetricColumns

public LinkedHashSet<MetricColumn> getApiMetricColumns()

generateApiMetricColumns

protected LinkedHashSet<MetricColumn> generateApiMetricColumns(Set<String> apiMetricColumnNames)

Builds a set of only those metric columns which correspond to the metrics requested in the API.

Parameters:

apiMetricColumnNames - Set of Metric names extracted from the requested api metrics

Returns:

set of metric columns

generateDimensionColumnHeaders

public Stream<String> generateDimensionColumnHeaders(Map.Entry<Dimension,LinkedHashSet<DimensionField>> entry)

Build the headers for the dimension columns.

Parameters:

entry - Entry to base the columns on.

Returns:

the headers as a Stream

buildResultRow

public Map<String,Object> buildResultRow(Result result)

Builds map of result row from a result.

Parameters:

result - The result to process

Returns:

map of result row

buildResultRowWithSidecars

public Map<String,Object> buildResultRowWithSidecars(Result result,
                                                     Map<Dimension,Set<Map<DimensionField,String>>> sidecars)

Builds map of result row from a result and loads the dimension rows into the sidecar map.

Parameters:

result - The result to process

sidecars - Map of sidecar data (dimension rows in the result)

Returns:

map of result row

buildIntervalStringList

public List<String> buildIntervalStringList(Collection<org.joda.time.Interval> intervals)

Build a list of interval strings. Format of interval string: yyyy-MM-dd' 'HH:mm:ss/yyyy-MM-dd' 'HH:mm:ss

Parameters:

intervals - list of intervals to be converted into string

Returns:

list of interval strings

getDimensionColumnName

protected static String getDimensionColumnName(Dimension dimension,
                                               DimensionField dimensionField)

Retrieve dimension column name from cache, or build it and cache it.

Parameters:

dimension - The dimension for the column name

dimensionField - The dimensionField for the column name

Returns:

The name for the dimension and column as it will appear in the response document