org.wso2.carbon.analytics.dataservice.restapi.resources

Class AnalyticsResource

java.lang.Object

org.wso2.carbon.analytics.dataservice.restapi.resources.AbstractResource

org.wso2.carbon.analytics.dataservice.restapi.resources.AnalyticsResource

public class AnalyticsResource
extends AbstractResource

The Class AnalyticsResource represents the REST APIs for AnalyticsDataService.

Nested Class Summary

Nested classes/interfaces inherited from class org.wso2.carbon.analytics.dataservice.restapi.resources.AbstractResource

AbstractResource.ResponseStatus

Constructor Summary

Constructors

Constructor and Description
AnalyticsResource() Instantiates a new analytics resource.

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	clearIndices(String tableName, int tenantI) Clear indices.
javax.ws.rs.core.Response	createTable(String tableName) Creates the table.
javax.ws.rs.core.Response	deleteRecords(String tableName, long timeFrom, long timeTo, List<String> ids) Delete records.
javax.ws.rs.core.Response	deleteTable(String tableName) Delete table.
javax.ws.rs.core.Response	getIndices(String tableName, int tenantI) Gets the indices.
javax.ws.rs.core.Response	getRecordCount(String tableName, int tenantI) Gets the record count.
javax.ws.rs.core.Response	getRecords(String tableName) Gets all the records.
javax.ws.rs.core.Response	getRecords(String tableName, long timeFrom, long timeTo) Gets the records.
javax.ws.rs.core.Response	getRecords(String tableName, long timeFrom, long timeTo, int recordsFrom, int count) Gets the records.
javax.ws.rs.core.Response	getRecordsByIds(String tableName, List<String> ids) Gets the records, But this is a POST request, since we have to send ids in the content.
javax.ws.rs.core.Response	insertRecords(List<RecordBean> recordBeans) Inserts a list of records.
javax.ws.rs.core.Response	listTables(int tenantI) List all the tables.
javax.ws.rs.core.Response	search(QueryBean queryBean) Search records.
javax.ws.rs.core.Response	searchCount(QueryBean queryBean) Returns the search record count.
javax.ws.rs.core.Response	setIndices(String tableName, int tenantI, Map<String,IndexTypeBean> columnsBean) Sets the indices.
javax.ws.rs.core.Response	tableExist(String tableName) Checks if a table exist.
javax.ws.rs.core.Response	updateRecords(List<RecordBean> recordBeans) Updates a list of records.

Methods inherited from class org.wso2.carbon.analytics.dataservice.restapi.resources.AbstractResource

handleResponse

Methods inherited from class java.lang.Object

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

Constructor Detail

AnalyticsResource

public AnalyticsResource()
                  throws AnalyticsRESTException

Instantiates a new analytics resource.

Throws:

AnalyticsRESTException - the analytics rest exception

Method Detail

createTable

public javax.ws.rs.core.Response createTable(String tableName)

Creates the table.

Parameters:

tableName - the table name

Returns:

the response

tableExist

public javax.ws.rs.core.Response tableExist(String tableName)

Checks if a table exist.

Parameters:

tableName - the table name

Returns:

the response

deleteTable

public javax.ws.rs.core.Response deleteTable(String tableName)

Delete table.

Parameters:

tableName - the table name

Returns:

the response

deleteRecords

public javax.ws.rs.core.Response deleteRecords(String tableName,
                                      long timeFrom,
                                      long timeTo,
                                      List<String> ids)

Delete records.

Parameters:

tableName - the table name

timeFrom - the time from

timeTo - the time to

ids - the ids

Returns:

the response

listTables

public javax.ws.rs.core.Response listTables(int tenantI)

List all the tables.

Parameters:

tenantI - the tenant i

Returns:

the response

getRecordCount

public javax.ws.rs.core.Response getRecordCount(String tableName,
                                       int tenantI)

Gets the record count.

Parameters:

tableName - the table name

tenantI - the tenant i

Returns:

the record count

getRecords

public javax.ws.rs.core.Response getRecords(String tableName,
                                   long timeFrom,
                                   long timeTo,
                                   int recordsFrom,
                                   int count)

Gets the records.

Parameters:

tableName - the table name

timeFrom - the start time

timeTo - the end time

recordsFrom - the starting record

count - the count

Returns:

the record groups

getRecords

public javax.ws.rs.core.Response getRecords(String tableName,
                                   long timeFrom,
                                   long timeTo)

Gets the records.

Parameters:

tableName - the table name

timeFrom - the time from

timeTo - the time to

Returns:

the records

getRecords

public javax.ws.rs.core.Response getRecords(String tableName)

Gets all the records.

Parameters:

tableName - the table name

Returns:

the records

getRecordsByIds

public javax.ws.rs.core.Response getRecordsByIds(String tableName,
                                        List<String> ids)

Gets the records, But this is a POST request, since we have to send ids in the content.

Parameters:

tableName - the table name

ids - the ids

Returns:

the records by ids

insertRecords

public javax.ws.rs.core.Response insertRecords(List<RecordBean> recordBeans)

Inserts a list of records.

Parameters:

recordBeans - the list of the record beans

Returns:

the response

updateRecords

public javax.ws.rs.core.Response updateRecords(List<RecordBean> recordBeans)

Updates a list of records.

Parameters:

recordBeans - the record beans

Returns:

the response

setIndices

public javax.ws.rs.core.Response setIndices(String tableName,
                                   int tenantI,
                                   Map<String,IndexTypeBean> columnsBean)

Sets the indices.

Parameters:

tableName - the table name

tenantI - the tenant i

columnsBean - the columns bean containing all the indices

Returns:

the response

getIndices

public javax.ws.rs.core.Response getIndices(String tableName,
                                   int tenantI)

Gets the indices.

Parameters:

tableName - the table name

tenantI - the tenant i

Returns:

the indices

clearIndices

public javax.ws.rs.core.Response clearIndices(String tableName,
                                     int tenantI)

Clear indices.

Parameters:

tableName - the table name

tenantI - the tenant i

Returns:

the response

search

public javax.ws.rs.core.Response search(QueryBean queryBean)

Search records.

Parameters:

queryBean - the query bean

Returns:

the response

searchCount

public javax.ws.rs.core.Response searchCount(QueryBean queryBean)

Returns the search record count.

Parameters:

queryBean - the query bean

Returns:

the response