org.wso2.carbon.analytics.restapi

Class Utils

java.lang.Object

org.wso2.carbon.analytics.restapi.Utils

public class Utils
extends Object

This class represents a set of utility functionalities for the analytics REST API.

Constructor Summary

Constructors

Constructor and Description
Utils()

Method Summary

Modifier and Type	Method and Description
static org.wso2.carbon.analytics.dataservice.commons.AggregateRequest	createAggregateRequest(AggregateRequestBean aggregateRequestBean)
static org.wso2.carbon.analytics.dataservice.commons.AggregateRequest[]	createAggregateRequests(AggregateRequestBean[] aggregateRequestBeans)
static org.wso2.carbon.analytics.datasource.commons.AnalyticsSchema	createAnalyticsSchema(AnalyticsSchemaBean analyticsSchemaBean) Create a Analytics schema from a bean class
static List<DrillDownRangeBean>	createDrillDownRangeBeans(List<org.wso2.carbon.analytics.dataservice.commons.AnalyticsDrillDownRange> ranges)
static org.wso2.carbon.analytics.dataservice.commons.CategoryDrillDownRequest	createDrilldownRequest(CategoryDrillDownRequestBean bean)
static org.wso2.carbon.analytics.dataservice.commons.AnalyticsDrillDownRequest	createDrilldownRequest(DrillDownRequestBean bean) Creates the AnalyticsDrilldownRequest object given a drilldownrequestBean class
static RecordBean	createRecordBean(org.wso2.carbon.analytics.datasource.commons.Record record) Create a RecordBean object out of a Record object
static Map<String,RecordBean>	createRecordBeans(List<org.wso2.carbon.analytics.datasource.commons.Record> records) Creates the record beans from records.
static SubCategoriesBean	createSubCategoriesBean(org.wso2.carbon.analytics.dataservice.commons.SubCategories subCategories)
static AnalyticsSchemaBean	createTableSchemaBean(org.wso2.carbon.analytics.datasource.commons.AnalyticsSchema analyticsSchema) Create table schema bean from a analytics schema
static org.wso2.carbon.analytics.api.AnalyticsDataAPI	getAnalyticsDataAPIs() Gets the analytics data service.
static org.wso2.carbon.analytics.dataservice.core.AnalyticsDataService	getAnalyticsDataService() Gets AnalyticsData Service OSGI service instance.
static String	getCompleteErrorMessage(String msg, Exception e) Gets the complete error message.
static org.wso2.carbon.user.core.service.RealmService	getRealmService() Gets User Realm OSGI service.
static List<String>	getRecordIds(List<org.wso2.carbon.analytics.dataservice.commons.SearchResultEntry> searchResults) Gets the record ids from search results.
static List<org.wso2.carbon.analytics.datasource.commons.Record>	getRecords(String username, List<RecordBean> recordBeans) Gets the records from record beans.
static List<org.wso2.carbon.analytics.datasource.commons.Record>	getRecordsForTable(String username, String tableName, List<RecordBean> recordBeans) Gets the records from record beans belongs to a specific table.
static List<org.wso2.carbon.analytics.dataservice.commons.SortByField>	getSortedFields(List<SortByFieldBean> sortByFieldBeans)
static List<RecordBean>	getSortedRecordBeans(Map<String,RecordBean> recordBeans, List<org.wso2.carbon.analytics.dataservice.commons.SearchResultEntry> searchResults)

Methods inherited from class java.lang.Object

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

Constructor Detail

Utils

public Utils()

Method Detail

getAnalyticsDataAPIs

public static org.wso2.carbon.analytics.api.AnalyticsDataAPI getAnalyticsDataAPIs()
                                                                           throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Gets the analytics data service.

Returns:

the analytics data service

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

getRealmService

public static org.wso2.carbon.user.core.service.RealmService getRealmService()
                                                                      throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Gets User Realm OSGI service.

Returns:

the relam service instance.

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

getAnalyticsDataService

public static org.wso2.carbon.analytics.dataservice.core.AnalyticsDataService getAnalyticsDataService()
                                                                                               throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Gets AnalyticsData Service OSGI service instance.

Returns:

the analytics data service instance.

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

getRecords

public static List<org.wso2.carbon.analytics.datasource.commons.Record> getRecords(String username,
                                                                                   List<RecordBean> recordBeans)
                                                                            throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Gets the records from record beans.

Parameters:

recordBeans - the record beans

Returns:

the records from record beans

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException - if the tableName is not specified

getRecordsForTable

public static List<org.wso2.carbon.analytics.datasource.commons.Record> getRecordsForTable(String username,
                                                                                           String tableName,
                                                                                           List<RecordBean> recordBeans)
                                                                                    throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Gets the records from record beans belongs to a specific table.

Parameters:

recordBeans - the record beans

Returns:

the records from record beans

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

createRecordBeans

public static Map<String,RecordBean> createRecordBeans(List<org.wso2.carbon.analytics.datasource.commons.Record> records)

Creates the record beans from records.

Parameters:

records - the records

Returns:

the Map of recordBeans

createRecordBean

public static RecordBean createRecordBean(org.wso2.carbon.analytics.datasource.commons.Record record)

Create a RecordBean object out of a Record object

Parameters:

record - the record object

Returns:

RecordBean object

getRecordIds

public static List<String> getRecordIds(List<org.wso2.carbon.analytics.dataservice.commons.SearchResultEntry> searchResults)

Gets the record ids from search results.

Parameters:

searchResults - the search results

Returns:

the record ids from search results

getCompleteErrorMessage

public static String getCompleteErrorMessage(String msg,
                                             Exception e)

Gets the complete error message.

Parameters:

msg - the Message

e - the exception

Returns:

the complete error message

createAnalyticsSchema

public static org.wso2.carbon.analytics.datasource.commons.AnalyticsSchema createAnalyticsSchema(AnalyticsSchemaBean analyticsSchemaBean)

Create a Analytics schema from a bean class

Parameters:

analyticsSchemaBean - bean table schema to be converted to Analytics Schema.

Returns:

Analytics schema

createTableSchemaBean

public static AnalyticsSchemaBean createTableSchemaBean(org.wso2.carbon.analytics.datasource.commons.AnalyticsSchema analyticsSchema)

Create table schema bean from a analytics schema

Parameters:

analyticsSchema - Analytics schema to be converted to table schema bean

Returns:

Table schema bean

createDrilldownRequest

public static org.wso2.carbon.analytics.dataservice.commons.AnalyticsDrillDownRequest createDrilldownRequest(DrillDownRequestBean bean)
                                                                                                      throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Creates the AnalyticsDrilldownRequest object given a drilldownrequestBean class

Parameters:

bean - bean class which represents the drilldown request.

Returns:

Equivalent AnalyticsDrilldownRequest object.

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

createDrilldownRequest

public static org.wso2.carbon.analytics.dataservice.commons.CategoryDrillDownRequest createDrilldownRequest(CategoryDrillDownRequestBean bean)

createSubCategoriesBean

public static SubCategoriesBean createSubCategoriesBean(org.wso2.carbon.analytics.dataservice.commons.SubCategories subCategories)

createDrillDownRangeBeans

public static List<DrillDownRangeBean> createDrillDownRangeBeans(List<org.wso2.carbon.analytics.dataservice.commons.AnalyticsDrillDownRange> ranges)

createAggregateRequest

public static org.wso2.carbon.analytics.dataservice.commons.AggregateRequest createAggregateRequest(AggregateRequestBean aggregateRequestBean)

createAggregateRequests

public static org.wso2.carbon.analytics.dataservice.commons.AggregateRequest[] createAggregateRequests(AggregateRequestBean[] aggregateRequestBeans)

getSortedFields

public static List<org.wso2.carbon.analytics.dataservice.commons.SortByField> getSortedFields(List<SortByFieldBean> sortByFieldBeans)
                                                                                       throws org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

Throws:

org.wso2.carbon.analytics.datasource.commons.exception.AnalyticsException

getSortedRecordBeans

public static List<RecordBean> getSortedRecordBeans(Map<String,RecordBean> recordBeans,
                                                    List<org.wso2.carbon.analytics.dataservice.commons.SearchResultEntry> searchResults)