org.wso2.carbon.analytics.dataservice

Class AnalyticsDataServiceImpl

java.lang.Object

org.wso2.carbon.analytics.dataservice.AnalyticsDataServiceImpl

All Implemented Interfaces:

AnalyticsDataService

public class AnalyticsDataServiceImpl
extends Object
implements AnalyticsDataService

The implementation of AnalyticsDataService.

Constructor Summary

Constructors

Constructor and Description
AnalyticsDataServiceImpl(AnalyticsDataServiceConfiguration config)
AnalyticsDataServiceImpl(org.wso2.carbon.analytics.datasource.core.AnalyticsRecordStore analyticsRecordStore, org.wso2.carbon.analytics.datasource.core.AnalyticsFileSystem analyticsFileSystem)

Method Summary

Methods

Modifier and Type	Method and Description
void	clearIndices(int tenantId, String tableName) Clears all the indices for the given table.
void	createTable(int tenantId, String tableName) Creates a table, if not already there, where the columns are not defined here, but can contain any arbitrary number of columns when data is added.
void	delete(int tenantId, String tableName, List<String> ids) Delete data in a table with given ids.
void	delete(int tenantId, String tableName, long timeFrom, long timeTo) Deletes a set of records in the table.
void	deleteTable(int tenantId, String tableName) Deletes the table with the given category and name if a table exists already.
void	destroy() Destroys and frees any resources taken up by the analytics data service implementation.
org.wso2.carbon.analytics.datasource.core.RecordGroup[]	get(int tenantId, String tableName, List<String> columns, List<String> ids) Retrieves data from a table with given ids.
org.wso2.carbon.analytics.datasource.core.RecordGroup[]	get(int tenantId, String tableName, List<String> columns, long timeFrom, long timeTo, int recordsFrom, int recordsCount) Retrieves data from a table.
org.wso2.carbon.analytics.datasource.core.AnalyticsRecordStore	getAnalyticsRecordStore()
AnalyticsDataIndexer	getIndexer()
Map<String,IndexType>	getIndices(int tenantId, String tableName) Returns the declared indices for a given table under the given tenant.
long	getRecordCount(int tenantId, String tableName) Returns the number of records in the table with the given category and name.
void	insert(List<org.wso2.carbon.analytics.datasource.core.Record> records) Adds a new record to the table.
List<String>	listTables(int tenantId) Lists all the current tables with the given category.
Iterator<org.wso2.carbon.analytics.datasource.core.Record>	readRecords(org.wso2.carbon.analytics.datasource.core.RecordGroup recordGroup) Reads in the records from a given record group, the records will be streamed in.
List<SearchResultEntry>	search(int tenantId, String tableName, String language, String query, int start, int count) Searches the data with a given search query.
int	searchCount(int tenantId, String tableName, String language, String query) Returns the search count of results of a given search query.
void	setIndices(int tenantId, String tableName, Map<String,IndexType> columns) Sets the indices for a given table under the given tenant.
boolean	tableExists(int tenantId, String tableName) Checks if the specified table with the given category and name exists.
void	update(List<org.wso2.carbon.analytics.datasource.core.Record> records) Updates the record store with the given records, matches by its record ids, this will be a full replace of the record, where the older record is effectively deleted and the new one is added, there will not be a merge of older record's field's with the new one.

Methods inherited from class java.lang.Object

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

Constructor Detail

AnalyticsDataServiceImpl

public AnalyticsDataServiceImpl(org.wso2.carbon.analytics.datasource.core.AnalyticsRecordStore analyticsRecordStore,
                        org.wso2.carbon.analytics.datasource.core.AnalyticsFileSystem analyticsFileSystem)
                         throws org.wso2.carbon.analytics.datasource.core.AnalyticsException

Throws:

org.wso2.carbon.analytics.datasource.core.AnalyticsException

AnalyticsDataServiceImpl

public AnalyticsDataServiceImpl(AnalyticsDataServiceConfiguration config)
                         throws org.wso2.carbon.analytics.datasource.core.AnalyticsException

Throws:

org.wso2.carbon.analytics.datasource.core.AnalyticsException

Method Detail

getIndexer

public AnalyticsDataIndexer getIndexer()

getAnalyticsRecordStore

public org.wso2.carbon.analytics.datasource.core.AnalyticsRecordStore getAnalyticsRecordStore()

createTable

public void createTable(int tenantId,
               String tableName)
                 throws org.wso2.carbon.analytics.datasource.core.AnalyticsException

Description copied from interface: AnalyticsDataService

Creates a table, if not already there, where the columns are not defined here, but can contain any arbitrary number of columns when data is added. The table names are not case sensitive.

Specified by:

createTable in interface AnalyticsDataService

Parameters:

tenantId - The tenant which this table belongs to

tableName - The name of the table to be created

Throws:

org.wso2.carbon.analytics.datasource.core.AnalyticsException

tableExists

public boolean tableExists(int tenantId,
                  String tableName)
                    throws org.wso2.carbon.analytics.datasource.core.AnalyticsException

Description copied from interface: AnalyticsDataService

Checks if the specified table with the given category and name exists.

Specified by:

tableExists in interface AnalyticsDataService

Parameters:

tenantId - The tenant which this table belongs to

tableName - The table name

Returns:

true if the table exists, false otherwise

Throws:

org.wso2.carbon.analytics.datasource.core.AnalyticsException

deleteTable

public void deleteTable(int tenantId,
               String tableName)
                 throws org.wso2.carbon.analytics.datasource.core.AnalyticsException

Description copied from interface: AnalyticsDataService

Deletes the table with the given category and name if a table exists already. This will not throw an error if the table is not there.

Specified by:

deleteTable in interface AnalyticsDataService

Parameters:

tenantId - The tenant which this table belongs to

tableName - The name of the table to be dropped

Throws:

org.wso2.carbon.analytics.datasource.core.AnalyticsException

listTables

public List<String> listTables(int tenantId)
                        throws org.wso2.carbon.analytics.datasource.core.AnalyticsException

Description copied from interface: AnalyticsDataService

Lists all the current tables with the given category.

Specified by:

listTables in interface AnalyticsDataService

Parameters:

tenantId - The tenant which this table belongs to

Returns:

The list of table names

Throws:

org.wso2.carbon.analytics.datasource.core.AnalyticsException

getRecordCount

public long getRecordCount(int tenantId,
                  String tableName)
                    throws org.wso2.carbon.analytics.datasource.core.AnalyticsException,
                           org.wso2.carbon.analytics.datasource.core.AnalyticsTableNotAvailableException

Description copied from interface: AnalyticsDataService

Returns the number of records in the table with the given category and name.

Specified by:

getRecordCount in interface AnalyticsDataService

Parameters:

tenantId - The tenant which this table belongs to

tableName - The name of the table to get the count from

Returns:

The record count

Throws:

org.wso2.carbon.analytics.datasource.core.AnalyticsException

org.wso2.carbon.analytics.datasource.core.AnalyticsTableNotAvailableException

insert

public void insert(List<org.wso2.carbon.analytics.datasource.core.Record> records)
            throws org.wso2.carbon.analytics.datasource.core.AnalyticsException,
                   org.wso2.carbon.analytics.datasource.core.AnalyticsTableNotAvailableException

Description copied from interface: AnalyticsDataService

Adds a new record to the table. If the record id is mentioned, it will be used to do the insert, or else, the insert will be done with a randomly generated id.

Specified by:

insert in interface AnalyticsDataService

Parameters:

records - The list of records to be inserted

Throws:

org.wso2.carbon.analytics.datasource.core.AnalyticsException

org.wso2.carbon.analytics.datasource.core.AnalyticsTableNotAvailableException

update

public void update(List<org.wso2.carbon.analytics.datasource.core.Record> records)
            throws org.wso2.carbon.analytics.datasource.core.AnalyticsException,
                   org.wso2.carbon.analytics.datasource.core.AnalyticsTableNotAvailableException

Description copied from interface: AnalyticsDataService

Updates the record store with the given records, matches by its record ids, this will be a full replace of the record, where the older record is effectively deleted and the new one is added, there will not be a merge of older record's field's with the new one.

Specified by:

update in interface AnalyticsDataService

Parameters:

records - The records to be updated

Throws:

org.wso2.carbon.analytics.datasource.core.AnalyticsException

org.wso2.carbon.analytics.datasource.core.AnalyticsTableNotAvailableException

get

public org.wso2.carbon.analytics.datasource.core.RecordGroup[] get(int tenantId,
                                                          String tableName,
                                                          List<String> columns,
                                                          long timeFrom,
                                                          long timeTo,
                                                          int recordsFrom,
                                                          int recordsCount)
                                                            throws org.wso2.carbon.analytics.datasource.core.AnalyticsException,
                                                                   org.wso2.carbon.analytics.datasource.core.AnalyticsTableNotAvailableException

Description copied from interface: AnalyticsDataService

Retrieves data from a table.

Specified by:

get in interface AnalyticsDataService

Parameters:

tenantId - The tenant which this table belongs to

tableName - The name of the table to search on

columns - The list of columns to required in results, null if all needs to be returned

timeFrom - The starting time to get records from, inclusive, -1 for beginning of time

timeTo - The ending time to get records to, non-inclusive, -1 for infinity

recordsFrom - The paginated index from value, zero based, inclusive

recordsCount - The paginated records count to be read, -1 for infinity

Returns:

An array of RecordGroup objects, which contains individual data sets in their local location

Throws:

org.wso2.carbon.analytics.datasource.core.AnalyticsException

org.wso2.carbon.analytics.datasource.core.AnalyticsTableNotAvailableException

get

public org.wso2.carbon.analytics.datasource.core.RecordGroup[] get(int tenantId,
                                                          String tableName,
                                                          List<String> columns,
                                                          List<String> ids)
                                                            throws org.wso2.carbon.analytics.datasource.core.AnalyticsException,
                                                                   org.wso2.carbon.analytics.datasource.core.AnalyticsTableNotAvailableException

Description copied from interface: AnalyticsDataService

Retrieves data from a table with given ids.

Specified by:

get in interface AnalyticsDataService

Parameters:

tenantId - The tenant which this table belongs to

tableName - The name of the table to search on

columns - The list of columns to required in results, null if all needs to be returned

ids - The list of ids of the records to be read

Returns:

An array of RecordGroup objects, which contains individual data sets in their local location

Throws:

org.wso2.carbon.analytics.datasource.core.AnalyticsException

org.wso2.carbon.analytics.datasource.core.AnalyticsTableNotAvailableException

readRecords

public Iterator<org.wso2.carbon.analytics.datasource.core.Record> readRecords(org.wso2.carbon.analytics.datasource.core.RecordGroup recordGroup)
                                                                       throws org.wso2.carbon.analytics.datasource.core.AnalyticsException

Description copied from interface: AnalyticsDataService

Reads in the records from a given record group, the records will be streamed in.

Specified by:

readRecords in interface AnalyticsDataService

Parameters:

recordGroup - The record group which represents the local data set

Returns:

An iterator of type Record in the local record group

Throws:

org.wso2.carbon.analytics.datasource.core.AnalyticsException

delete

public void delete(int tenantId,
          String tableName,
          long timeFrom,
          long timeTo)
            throws org.wso2.carbon.analytics.datasource.core.AnalyticsException,
                   org.wso2.carbon.analytics.datasource.core.AnalyticsTableNotAvailableException

Description copied from interface: AnalyticsDataService

Deletes a set of records in the table.

Specified by:

delete in interface AnalyticsDataService

Parameters:

tenantId - The tenant which this table belongs to

tableName - The name of the table to search on

timeFrom - The starting time to get records from for deletion

timeTo - The ending time to get records to for deletion

Throws:

org.wso2.carbon.analytics.datasource.core.AnalyticsException

org.wso2.carbon.analytics.datasource.core.AnalyticsTableNotAvailableException

delete

public void delete(int tenantId,
          String tableName,
          List<String> ids)
            throws org.wso2.carbon.analytics.datasource.core.AnalyticsException,
                   org.wso2.carbon.analytics.datasource.core.AnalyticsTableNotAvailableException

Description copied from interface: AnalyticsDataService

Delete data in a table with given ids.

Specified by:

delete in interface AnalyticsDataService

Parameters:

tenantId - The tenant which this table belongs to

tableName - The name of the table to search on

ids - The list of ids of the records to be deleted

Throws:

org.wso2.carbon.analytics.datasource.core.AnalyticsException

org.wso2.carbon.analytics.datasource.core.AnalyticsTableNotAvailableException

setIndices

public void setIndices(int tenantId,
              String tableName,
              Map<String,IndexType> columns)
                throws AnalyticsIndexException

Description copied from interface: AnalyticsDataService

Sets the indices for a given table under the given tenant. The indices must be saved in a persistent storage under analytics data service, to be able to lookup the indices later, i.e. these indices should be in-effect after a server restart.

Specified by:

setIndices in interface AnalyticsDataService

Parameters:

tenantId - The tenant id

tableName - The table name

columns - The set of columns to create indices for, and their data types

Throws:

AnalyticsIndexException

search

public List<SearchResultEntry> search(int tenantId,
                             String tableName,
                             String language,
                             String query,
                             int start,
                             int count)
                               throws AnalyticsIndexException

Description copied from interface: AnalyticsDataService

Searches the data with a given search query.

Specified by:

search in interface AnalyticsDataService

Parameters:

tenantId - The tenant id

tableName - The table name

language - The language used to give the search query

query - The search query

start - The start location of the result, 0 based

count - The maximum number of result entries to be returned

Returns:

A list of SearchResultEntrys

Throws:

AnalyticsIndexException

searchCount

public int searchCount(int tenantId,
              String tableName,
              String language,
              String query)
                throws AnalyticsIndexException

Description copied from interface: AnalyticsDataService

Returns the search count of results of a given search query.

Specified by:

searchCount in interface AnalyticsDataService

Parameters:

tenantId - The tenant id

tableName - The table name

language - The language used to give the search query

query - The search query

Returns:

The count of results

Throws:

AnalyticsIndexException

getIndices

public Map<String,IndexType> getIndices(int tenantId,
                               String tableName)
                                 throws AnalyticsIndexException

Description copied from interface: AnalyticsDataService

Returns the declared indices for a given table under the given tenant.

Specified by:

getIndices in interface AnalyticsDataService

Parameters:

tenantId - The tenant id

tableName - The table name

Returns:

List of indices of the table

Throws:

AnalyticsIndexException

clearIndices

public void clearIndices(int tenantId,
                String tableName)
                  throws AnalyticsIndexException

Description copied from interface: AnalyticsDataService

Clears all the indices for the given table.

Specified by:

clearIndices in interface AnalyticsDataService

Parameters:

tenantId - The tenant id

tableName - The table name

Throws:

AnalyticsIndexException

destroy

public void destroy()
             throws org.wso2.carbon.analytics.datasource.core.AnalyticsException

Description copied from interface: AnalyticsDataService

Destroys and frees any resources taken up by the analytics data service implementation.

Specified by:

destroy in interface AnalyticsDataService

Throws:

org.wso2.carbon.analytics.datasource.core.AnalyticsException