io.cdap.cdap.api.dataset.lib.cube

Class AbstractCubeHttpHandler

java.lang.Object

io.cdap.cdap.internal.api.AbstractProgramDatasetConfigurable<T>

io.cdap.cdap.internal.api.AbstractPluginConfigurable<V>

io.cdap.cdap.api.service.http.AbstractHttpServiceHandler

io.cdap.cdap.api.dataset.lib.cube.AbstractCubeHttpHandler

All Implemented Interfaces:

ProgramLifecycle, HttpServiceHandler

@Beta
public abstract class AbstractCubeHttpHandler
extends AbstractHttpServiceHandler

A basic implementation of HttpServiceHandler that provides endpoints to explore and execute queries in Cube dataset.

Subclasses must implement getCube() that returns Cube dataset.

Constructor Summary

Constructors

Constructor and Description
AbstractCubeHttpHandler()

Method Summary

Modifier and Type	Method and Description
void	addFact(HttpServiceRequest request, HttpServiceResponder responder) Adds facts to a Cube as defined by Cube.add(java.util.Collection).
protected abstract Cube	getCube()
void	query(HttpServiceRequest request, HttpServiceResponder responder) Queries data in a Cube as defined by Cube.query(CubeQuery).
void	searchDimensionValue(HttpServiceRequest request, HttpServiceResponder responder) Searches dimension values in a Cube as defined by Cube.findDimensionValues(CubeExploreQuery).
void	searchMeasure(HttpServiceRequest request, HttpServiceResponder responder) Searches measurements in a Cube as defined by Cube.findMeasureNames(CubeExploreQuery).

Methods inherited from class io.cdap.cdap.api.service.http.AbstractHttpServiceHandler

configure, configure, destroy, getConfigurer, getContext, initialize, setProperties

Methods inherited from class io.cdap.cdap.internal.api.AbstractPluginConfigurable

usePlugin, usePlugin, usePluginClass, usePluginClass

Methods inherited from class io.cdap.cdap.internal.api.AbstractProgramDatasetConfigurable

addDatasetModule, addDatasetType, createDataset, createDataset, createDataset, createDataset

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCubeHttpHandler

public AbstractCubeHttpHandler()

Method Detail

getCube

protected abstract Cube getCube()

Returns:

Cube dataset.

addFact

@Path(value="add")
 @POST
public void addFact(HttpServiceRequest request,
                                              HttpServiceResponder responder)

Adds facts to a Cube as defined by Cube.add(java.util.Collection).

searchDimensionValue

@Path(value="searchDimensionValue")
 @POST
public void searchDimensionValue(HttpServiceRequest request,
                                                                            HttpServiceResponder responder)

Searches dimension values in a Cube as defined by Cube.findDimensionValues(CubeExploreQuery).

searchMeasure

@Path(value="searchMeasure")
 @POST
public void searchMeasure(HttpServiceRequest request,
                                                              HttpServiceResponder responder)

Searches measurements in a Cube as defined by Cube.findMeasureNames(CubeExploreQuery).

query

@Path(value="query")
 @POST
public void query(HttpServiceRequest request,
                                              HttpServiceResponder responder)

Queries data in a Cube as defined by Cube.query(CubeQuery).