-public class ModelData {
-
- private int pIModelDataInstance;
-
- public ModelData(int iModelDataInstance)
- {
- pIModelDataInstance = iModelDataInstance;
- }
-
- public int GetDataId()
- {
- return CoreController.getInstance().GetDataId(pIModelDataInstance);
- }
-
- public int GetPropertyCount()
- {
- return CoreController.getInstance().GetPropertyCount(pIModelDataInstance);
- }
-
- public String GetPropertyName(int propertyIndex)
- {
- return CoreController.getInstance().GetPropertyName(pIModelDataInstance, propertyIndex);
- }
-
- public String GetPropertyValue(int propertyIndex)
- {
- return CoreController.getInstance().GetPropertyValue(pIModelDataInstance, propertyIndex);
- }
+/**
+ * @class ModelData
+ * @brief This class provides a set of API for DataReader class to handle the data
+ * received by IQueryEngineEvent listeners from SSMCore
+ *
+ */
+public class ModelData
+{
+
+ private int pIModelDataInstance;
+
+ public ModelData(int iModelDataInstance)
+ {
+ pIModelDataInstance = iModelDataInstance;
+ }
+
+ /**
+ * Get the affected DataId. ContextModel has plenty of data so returned data is matched
+ * from given condition which in this case is the model data object instance
+ *
+ * @return int - the affected DataId
+ *
+ */
+ public int getDataId()
+ {
+ return CoreController.getInstance().getDataId(pIModelDataInstance);
+ }
+
+ /**
+ * ContextModel has at least one property that contains data \n
+ * property is described from its specification.
+ *
+ * @return int - number of properties
+ *
+ */
+ public int getPropertyCount()
+ {
+ return CoreController.getInstance().getPropertyCount(
+ pIModelDataInstance);
+ }
+
+ /**
+ * Retrieve the name of the property using the given index
+ *
+ * @param propertyIndex
+ * - index of property to read
+ *
+ * @return String - property name
+ *
+ */
+ public String getPropertyName(int propertyIndex)
+ {
+ return CoreController.getInstance().getPropertyName(
+ pIModelDataInstance, propertyIndex);
+ }
+
+ /**
+ * Retrieve the value of the property using the given index
+ *
+ * @param propertyIndex
+ * - index of property to read
+ *
+ * @return String - property value
+ *
+ */
+ public String getPropertyValue(int propertyIndex)
+ {
+ return CoreController.getInstance().getPropertyValue(
+ pIModelDataInstance, propertyIndex);
+ }