interface MAGES::ISchema¶

Overview¶

Interface of the Schema. More…

interface ISchema
{
    // methods

    void Store(string key, object data);
    object Get(string key);
    Dictionary GetAllData(string keyPattern);
    void DeleteData(string key);
    void DeleteAllData(string keyPattern);
    List> GetSpecificData(string keyPattern);
    void DeleteSpecificData(string keyPattern);
    void ClearAllData();
    static ISchema GetInstance();
};

// direct descendants

class CountSchema;
class EventSchema;
class ListSchema;

Detailed Documentation¶

Interface of the Schema.

Methods¶

void Store(string key, object data)

Stores the data under the given key.

Parameters:

key	Dictionary key.
data	Data to be stored.

object Get(string key)

Retrieves the data under the given key.

Parameters:

key	The lookup key.

Returns:

The data under the key.

Dictionary GetAllData(string keyPattern)

Gets all the data under the given key pattern.

Parameters:

keyPattern	Given key pattern.

Returns:

The data under certain schema.

void DeleteData(string key)

Deletes the data under the given key.

Parameters:

key	Given key.

void DeleteAllData(string keyPattern)

Deletes data of subschema under the given key pattern.

Parameters:

keyPattern	Given key pattern.

List> GetSpecificData(string keyPattern)

Get specific sub-convention/pattern data under the given key pattern.

Parameters:

keyPattern	Given key pattern.

Returns:

Dictionary of data.

void DeleteSpecificData(string keyPattern)

Delete specific sub-convention/pattern data under the given key pattern.

Parameters:

keyPattern	Given key pattern.

void ClearAllData()

Clears all data.

static ISchema GetInstance()

Gets the singleton instance of the schema.

Returns:

The singleton instance.