org.apache.lens.server.ui
Class MetastoreUIResource

java.lang.Object
  org.apache.lens.server.ui.MetastoreUIResource

@Path(value="metastoreapi")
public class MetastoreUIResource
extends Object

metastore UI resource api

This provides api for all things metastore UI.

Field Summary

static org.apache.commons.logging.Log

LOG

Constructor Summary

MetastoreUIResource()

Method Summary

String	getAllTables(UUID publicId) Get all Cube names, Dimension Table names and Storage names
String	getDescription(UUID publicId, String type, String name) Gets metadata of a cube or dimension
String	getFilterResults(UUID publicId, String keyword) Get all Table and column names and types which contain the search word
String	getMessage() API to know if metastore service is up and running
CubeMetastoreService	getSvc()

Methods inherited from class java.lang.Object

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

Field Detail

LOG

public static final org.apache.commons.logging.Log LOG

Constructor Detail

MetastoreUIResource

public MetastoreUIResource()

Method Detail

getSvc

public CubeMetastoreService getSvc()

getMessage

@GET
@Produces(value="text/plain")
public String getMessage()

API to know if metastore service is up and running

Returns:

Simple text saying it up

getAllTables

@GET
@Path(value="tables")
@Produces(value={"text/html","application/json","application/xml"})
public String getAllTables(@QueryParam(value="publicId")
                                             UUID publicId)

Get all Cube names, Dimension Table names and Storage names

Parameters:

publicId - The publicId for the session in which user is working

Returns:

JSON string consisting of different table names and types

Throws:

LensException, - JSONException

getDescription

@GET
@Path(value="tables/{name}")
@Produces(value={"text/html","application/json","application/xml"})
public String getDescription(@QueryParam(value="publicId")
                                               UUID publicId,
                                               @QueryParam(value="type")
                                               String type,
                                               @PathParam(value="name")
                                               String name)

Gets metadata of a cube or dimension

Parameters:

publicId - The publicId for the session in which user is working

name - name of cube or dimension to be described

Returns:

JSON string consisting of different dimension and measure names and types

Throws:

LensException, - JSONException

getFilterResults

@GET
@Path(value="searchablefields")
@Produces(value={"text/html","application/json","application/xml"})
public String getFilterResults(@QueryParam(value="publicId")
                                                 UUID publicId,
                                                 @QueryParam(value="keyword")
                                                 String keyword)

Get all Table and column names and types which contain the search word

Parameters:

publicId - The publicId for the session in which user is working

keyword - keyword to be searched

Returns:

JSON string consisting of different table and column names and types

Throws:

LensException, - JSONException