VersaTul.Object.Converters 1.0.12

VersaTul Object Converters

VersaTul Object Converters is a project that provides the ability to convert objects into key/value pairs dictionary stores. For example, you can use converters to convert instances of classes into a dictionary representation of the data from the class. This package works with the Collection streamers package.

Features

• IFlattener: An interface that describes the functionality needed to successfully convert from a multi-dimensional object to a one-dimensional key/value pair dictionary with flattened keys.
• IObjectProcessor: An interface that represents functionality that can convert an object into a dictionary of string keys and object values.
• IPropertyProcessor: An interface that describes the functionality needed to successfully process the properties of object instances.
• ObjectProcessor: A concrete implementation of IObjectProcessor.
• PropertyProcessor: A concrete implementation of IPropertyProcessor.

Usage

To use VersaTul Object Converters, you need to install the package and import the relevant classes. Then, you can create instances of ObjectProcessor and PropertyProcessor and use their methods to convert objects into dictionaries. For example:

using VersaTul.ObjectConverters;

// Create an object to convert
var person = new Person
{
    Name = "John",
    Age = 25,
    Address = new Address
    {
        Street = "123 Main St",
        City = "New York",
        Zip = "10001"
    }
};

// Create an instance of ObjectProcessor
var objectProcessor = new ObjectProcessor();

// Convert the object into a dictionary
var dictionary = objectProcessor.ToDictionary(person);

// Print the dictionary
foreach (var pair in dictionary)
{
    Console.WriteLine($"{pair.Key}: {pair.Value}");
}

The output of this code would be:

Name: John
Age: 25
Address.Street: 123 Main St
Address.City: New York
Address.Zip: 10001

You can also use the IFlattener interface to convert a dictionary into a string or another dictionary with flattened keys. For example:

using VersaTul.ObjectConverters;

// Create a dictionary to convert
var dictionary = new Dictionary<string, object>
{
    {"Name", "John"},
    {"Age", 25},
    {"Address", new Dictionary<string, object>
        {
            {"Street", "123 Main St"},
            {"City", "New York"},
            {"Zip", "10001"}
        }
    }
};

// Create an instance of Flattener
var flattener = new Flattener();

// Convert the dictionary into a string
var string = flattener.AsString(dictionary);

// Print the string
Console.WriteLine(string);

The output of this code would be:

Name=John;Age=25;Address.Street=123 Main St;Address.City=New York;Address.Zip=10001

License

This project is licensed under the MIT License - see the LICENSE file for details.