class MAGES::DataContainerModule¶

Overview¶

The data container module base class. More…

class DataContainerModule: public MAGES::HubModule
{
public:
    // methods

    virtual abstract void SetSchema(string keyPattern, Type schemaType) = 0;
    virtual abstract void StoreData(string key, object value) = 0;
    virtual abstract object GetData(string key) = 0;
    virtual abstract Dictionary GetSchemaData(string keyPattern) = 0;
    virtual abstract void DeleteData(string key) = 0;
    virtual abstract void DeleteSchema(string keyPattern) = 0;
    virtual abstract List> GetSpecificSchemaData(string keyPattern) = 0;
    virtual abstract void DeleteSpecificSchemaData(string keyPattern) = 0;
    virtual abstract void ClearAllData() = 0;
};

// direct descendants

class MAGESDataContainer;
class StubDataContainer;

Inherited Members¶

public:
    // methods

    virtual abstract void Startup() = 0;
    virtual abstract void Shutdown() = 0;

Detailed Documentation¶

The data container module base class.

Methods¶

virtual abstract void SetSchema(string keyPattern, Type schemaType) = 0

Sets the schema for the data container.

Parameters:

keyPattern	The convention/pattern the Schema is created under, i.e mages.actions.* .
schemaType	The type of the Schema.

virtual abstract void StoreData(string key, object value) = 0

Stores value in the data container under the given key.

Parameters:

key	The key of the data container.
value	The value to be stored.

virtual abstract object GetData(string key) = 0

Get the data from the data container under the given key.

Parameters:

key	The given key.

Returns:

The value under the given key.

virtual abstract Dictionary GetSchemaData(string keyPattern) = 0

Returns the schema data for the given key pattern.

Parameters:

keyPattern	The convention/pattern.

Returns:

A dictionary with the data of the whole Schema under the given convention/pattern.

virtual abstract void DeleteData(string key) = 0

Deletes the data under the given key.

Parameters:

key	The key to be deleted.

virtual abstract void DeleteSchema(string keyPattern) = 0

Deletes the schema under the given key pattern.

Parameters:

keyPattern	The convention/pattern of the schema to be deleted.

virtual abstract List> GetSpecificSchemaData(string keyPattern) = 0

Returns the data of the schema under the given key pattern.

Parameters:

keyPattern	The key pattern of the data under the Schema.

Returns:

Returns a dictionary of the data that are stored under the given keyPattern.

virtual abstract void DeleteSpecificSchemaData(string keyPattern) = 0

Deletes the data of the schema under the given key pattern.

Parameters:

keyPattern	The key pattern of the data under the Schema.

virtual abstract void ClearAllData() = 0

Clears all data and all schemas.