Semantica.Lib.Storage 8.1.0-beta

Semantica.Lib.Storage

This package is part of the design packages of Semantica.Lib.

Summary

Provides interfaces and types for usage with your storables, as well as abstractions used to build on the patterns included in Semantica.Lib.Domain and base classes from Semantica.Lib.Domain.Data. This package is independent of those packages, so can be included in a storage layer that can be completely independent of your domain layer. The abstractions are also independent of a specific ORM-framework, but were designed with EntityFramework in mind.

Implementations for the abstractions provided in this package are provided in the Semantica.Lib.Storage.Data and Semantica.Lib.Storage.EntityFramework packages.

Dependencies

• Semantica.Lib.Checks
• Semantica.Lib.Core
• Semantica.Lib.Extensions
• Semantica.Lib.Linq
• Semantica.Lib.Ordering
• Semantica.Lib.Patterns

Documentation generated from the XMLDoc:

<a name='assembly'></a>

Lib.Storage

Contents

• CharEnumConverter
• IAggregateDataStore`2
• ICompositeAggregateDataStore`2
• IDataStore`2
• IIdentity`1
  • Id
• IKeyConverter`2
  • ToBlankStorable()
  • ToKey()
• KeyConverter`2

<a name='T-Semantica-Storage-CharEnums-CharEnumConverter'></a>

CharEnumConverter type

Namespace

Semantica.Storage.CharEnums

Summary

Provides static methods that help with converting strings or chars into enums that are of type ushort and vice versa.

These "CharEnums" can be defined using char literals, can be mapped onto char(1) database columns, and allow for more readable and less error prone storing of enums in a database, without sacrificing performance (which can be particularly important for keys or indices).

enum MyCharEnum : ushort
{
   Apples = 'A',
   Oranges = 'O',
   Pears = 'P'
}

<a name='T-Semantica-Storage-DataStores-IAggregateDataStore`2'></a>

IAggregateDataStore`2 type

Namespace

Semantica.Storage.DataStores

Summary

Defines methods for retreiving TStorables using an aggregating (typically foreign) key.

Only use this interface when TAggregateKey is a simple key (), otherwise use ICompositeAggregateDataStore`2.

A standard implementation using entity framework is provided in the Lib.Storage.EntityFramework package.

Generic Types

<a name='T-Semantica-Storage-DataStores-ICompositeAggregateDataStore`2'></a>

ICompositeAggregateDataStore`2 type

Namespace

Semantica.Storage.DataStores

Summary

Defines methods for retreiving TStorables using an aggregating (typically foreign) key.

If TAggregateKey is a simple key (), you can use IAggregateDataStore`2 for additional functionality.

A standard implementation using entity framework is provided in the Lib.Storage.EntityFramework package.

Generic Types

<a name='T-Semantica-Storage-DataStores-IDataStore`2'></a>

IDataStore`2 type

Namespace

Semantica.Storage.DataStores

Summary

Simple datastore

Generic Types

<a name='T-Semantica-Storage-IIdentity`1'></a>

IIdentity`1 type

Namespace

Semantica.Storage

Summary

Generic Types

<a name='P-Semantica-Storage-IIdentity`1-Id'></a>

Id property

Summary

Primary key of the entity

<a name='T-Semantica-Storage-IKeyConverter`2'></a>

IKeyConverter`2 type

Namespace

Semantica.Storage

Summary

Generic converter used by the base repository to convert keys into storables and back.

Generic Types

<a name='M-Semantica-Storage-IKeyConverter2-ToBlankStorable-1-'></a>

ToBlankStorable() method

Summary

Creates an empty storable with only key properties set. Used for removing entities.

Parameters

This method has no parameters.

<a name='M-Semantica-Storage-IKeyConverter2-ToKey-0-'></a>

ToKey() method

Summary

Makes a key from a storable.

Parameters

This method has no parameters.

<a name='T-Semantica-Storage-KeyConverter`2'></a>

KeyConverter`2 type

Namespace

Semantica.Storage

Summary

Generic implementation of IKeyConverter`2 that can be instantiated with delegate functions to provide the conversions.

Generic Types