class MAGES::DataContainer::MAGESDataContainer¶

Overview¶

Implementation of the DataContainer Interface. More…

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

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

Inherited Members¶

public:
    // methods

    virtual abstract void Startup() = 0;
    virtual abstract void Shutdown() = 0;
    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;

Detailed Documentation¶

Implementation of the DataContainer Interface.

Methods¶

virtual override void SetSchema(string keyPattern, Type schemaType)

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 override List> GetSpecificSchemaData(string keyPattern)

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 override void DeleteSpecificSchemaData(string keyPattern)

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

Parameters:

keyPattern	The key pattern of the data under the Schema.

virtual override void DeleteSchema(string keyPattern)

Deletes the whole Schema under the given key.

Parameters:

keyPattern	The given pattern/convention of the schema.
ArgumentException	Throws an exception if the key is not found.

virtual override void DeleteData(string key)

Deletes the data under the given key.

Parameters:

key	Given data key.
ArgumentException	Throws exception if the key is not found.

virtual override void ClearAllData()

Clears all data and all schemas.

virtual override void StoreData(string key, object value)

Stores data in the schema defined under the given key.

Parameters:

key	The given key.
value	The value to be stored.
ArgumentException	Throws an exception if the key is not found.

virtual override object GetData(string key)

Gets the data stored under the given key.

Parameters:

key	The given key.
ArgumentException	If no data is found under the given key.

Returns:

The value stored under the given key.

virtual override Dictionary GetSchemaData(string keyPattern)

Gets the whole Schema data stored under the given convention/pattern.

Parameters:

keyPattern	The convention/pattern the Schema is defined under.

Returns:

A dictionary of the whole Schema data.

virtual override void Startup()

Called when the module is started (usually on application start).

virtual override void Shutdown()

Called when the module is destroyed or replaced.