phmatray / TheRightCollection

A .NET console application demonstrating advanced collection management and event handling through a custom PersonCollection class that encapsulates typical list operations with added functionalities like sorting, filtering, and event-driven notifications.

The Right Collection

Overview

This project demonstrates how to encapsulate a collection of people in a custom collection class, PersonCollection, providing a more meaningful and controlled interface than built-in collection types in .NET. This class showcases best practices in object-oriented design, including encapsulation, event handling, and the use of LINQ for data manipulation.

Features

• Custom Collection: PersonCollection is a custom class that encapsulates a list of Person objects and exposes a set of methods for interacting with the data more effectively.
• Indexers: Provides two indexers, one for accessing Person objects by their index and another by their name.
• Advanced Query Capabilities: Includes methods for sorting, filtering, and finding specific people based on attributes like name and age.
• Event Handling: Implements events to notify other parts of the application when a person is added or removed.
• Statistics Methods: Functions to retrieve statistical information such as the average age, the oldest person, and the youngest person from the collection.

Usage

Creating and Managing People

You can create a new instance of PersonCollection and add Person objects to it. Each person is represented with a name and an age. Here's how to add people to the collection:

PersonCollection people = new PersonCollection();
people.Add(new Person("Alice", 40));
people.Add(new Person("Bob", 35));
people.Add(new Person("Charlie", 50));

Querying the Collection

The collection can be queried in various ways, such as finding people by name, sorting by age, or getting statistical data:

var bobs = people.FindByName("Bob");
people.SortByAge();
var oldest = people.OldestPerson();
var youngest = people.YoungestPerson();

Event Subscriptions

You can subscribe to PersonAdded and PersonRemoved events to get notified when changes occur in the collection:

people.PersonAdded += (sender, e) => Console.WriteLine($"Person added: {e.Person.Name}");
people.PersonRemoved += (sender, e) => Console.WriteLine($"Person removed: {e.Person.Name}");

Running the Application

To run this application, compile the code using Visual Studio or the .NET CLI, and execute the built executable. The program will demonstrate the capabilities of the PersonCollection class through various operations displayed in the console output.

Contributions

Contributions are welcome. Please feel free to fork the repository, make changes, and submit a pull request. For major changes, please open an issue first to discuss what you would like to change.

License

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