}
static private CoreController coreController;
-
+
+ /**
+ * Return instance of this class.
+ *
+ * @return CoreController - instance of this class
+ *
+ */
public static CoreController getInstance()
{
if (coreController == null)
* of the query engine with which the query is to be registered
*
* @param queryEngineEvent
- * - the event to register with QueryEngine
+ * - the event class to receive QueryEngine events
*
* @return void
*
/**
- * Kill the registered ContextQuery corresponding to the to cqid
+ * Kill the registered ContextQuery corresponding to the cqid
*
* @param pQueryEngineInstance
* - instance(created on creation of the QueryEngine)
* property is described from its specification.
*
* @param pIModelDataInstance - instance(created on creation of the ModelData)
- * of the model data for which propertycount is to be returned
+ * of the model data for which property count is to be returned
*
* @return @return int - number of properties
*
/**
* Get affected context models. The CQL(context query language) can specify
* multiple ContextModels for retrieving data so a list of string of affected
- * dacontext models is returned
+ * context models is returned
*
* @param pDataReaderInstance
* - instance(created on creation of the DataReader)
/**
* Get affected context models. The CQL(context query language) can specify
* multiple ContextModels for retrieving data so a list of string of affected
- * dacontext models is returned
+ * context models is returned
*
* @return List<String> - affected ContextModel list
*
* Application should implement the pure virtual function OnQueryEngineEvent.
* The Application should call registerQuery() and add a listener.
*
- *
+ *<pre>
Sample code :
int cqid = SoftSensorManager.registerQuery(edtQuery.getText().toString(), mQueryEngineEventListener);
}
}
}
- };
+ };</pre>
*/
public abstract class IQueryEngineEvent
{
* This abstract method needs to be implemeted by application
* as a precondition for query engine implementation.
*
- * @param tag
+ * @param tag - tag from SSMCore
*
* @param msg - received message
*
* Register QueryEngineEvent to QueryEngine
*
* @param queryEngineEvent
- * - the event to register with QueryEngine
+ * - the event class to receive QueryEngine events
*
* @return void
*
*
* @brief This file gives description of SSMInterface class and its utility functions.
* This is the interface between an application and the query engine.
- * SSMinterface makes desired querries in form of CQL(Context Query Language)
+ * SSMinterface makes desired queries in form of CQL(Context Query Language)
* to the query engine and passes the returned result obtained in form of callback
* back to the application.
*/
* @class SSMInterface
* @brief This class provides a set of APIs to manage the SSM framework
* This class sits in between the application and query engine and acts
- * as an interface between them. SSMinterface makes desired querries in form of CQL(Context Query Language)
+ * as an interface between them. SSMinterface makes desired queries in form of CQL(Context Query Language)
* to the query engine and passes the returned result obtained in form of callback
* back to the application
*/
}
/**
- * To lock QueryEngineEventReceiver object to execute a query atomicaly,
+ * To lock QueryEngineEventReceiver object to execute a query atomically,
* this is done to provide synchronization in case of multiple queries.
*
* @return void
}
/**
- * unregister a registered query using its query ID the query corresponding
+ * unregister a registered query using its query ID. The query corresponding
* to the cqid will be terminated and removes listener for the given query
* The SSMCore will not send any callbacks after successful unregistration.
*