Select a site

IMPORTANT: This version of Sitefinity CMS is out of support and the respective product documentation is no longer maintained and can be outdated. Use the version selector to view a supported product version.

Locations module: Implement fluent mappings

After you Locations module: Implement the OpenAccess data provider, you need to implement the fluent mappings to map your model classes to database tables. To use the mappings in the data provider, you must return an instance of the LocationsFluentMetadataSource in the GetMetaDataSourcemethod of the provider.

To implement the fluent mappings for your data provider, you must create the LocationsFluentMapping and the LocationsFluentMetadataSource classes.

Create the LocationsFluentMapping class

The LocationsFluentMapping class defines the mapping for the LocationItem model class. To create the class:

  1. In Visual Studio, in Solution Explorer, navigate to LocationsModule project » Data folder and open the context menu of the OpenAccess folder.
    Click Add » Class.
  2. Name the class file LocationsFluentMapping.cs and click Add.
  3. Open the file LocationsFluentMapping.cs.
  4. Add the following using statements:
    • using Telerik.Sitefinity;
    • using Telerik.OpenAccess.Metadata.Fluent;
    • using Telerik.OpenAccess.Metadata.Fluent.Advanced;
    • using Telerik.Sitefinity.Model;
    • using LocationsModule.Model;
    • using Telerik.OpenAccess;
  5. Make the LocationsFluentMapping class inherit the OpenAccessFluentMappingBase class:
    public class LocationsFluentMapping : OpenAccessFluentMappingBase
    {
    }
  6. Create the following constructor for the class:
    public LocationsFluentMapping(IDatabaseMappingContext context)
        : base(context)
    {
    }
  7. Implement the OpenAccessFluentMappingBase abstract class.

    To implement it, you must override the GetMappings abstract method. In the method, create the required mappings. Use the following code for the method:

    public override IList<MappingConfiguration> GetMapping()
    {
        // initialize and return mappings
        var mappings = new List<MappingConfiguration>();
        MapItem(mappings);
        MapUrlData(mappings);
        return mappings;
    }
     
    private void MapItem(IList<MappingConfiguration> mappings)
    {
        // initialize mapping
        var itemMapping = new MappingConfiguration<LocationItem>();
        itemMapping.HasProperty(p => p.Id).IsIdentity();
        itemMapping.MapType(p => new { }).ToTable("sf_locations");
     
        // add properties
        itemMapping.HasProperty(p => p.Address);
        itemMapping.HasProperty(p => p.City);
        itemMapping.HasProperty(p => p.Region).IsNullable();
        itemMapping.HasProperty(p => p.PostalCode);
        itemMapping.HasProperty(p => p.Country);
     
        // map urls table association
        itemMapping.HasAssociation(p => p.Urls).WithOppositeMember("parent", "Parent").ToColumn("content_id").IsDependent().IsManaged();
        mappings.Add(itemMapping);
    }
     
    private void MapUrlData(IList<MappingConfiguration> mappings)
    {
        // map the Url data type
        var urlDataMapping = new MappingConfiguration<LocationItemUrlData>();
        urlDataMapping.MapType(p => new { }).Inheritance(InheritanceStrategy.Flat).ToTable("sf_url_data");
        mappings.Add(urlDataMapping);
    }

     

Create the LocationsFluentMetadataSource class

The LocationsFluentMetadataSource class wraps the mappings and exposes them to the OpenAccess data provider. To create the class, perform the following:

  1. In Visual Studio, in Solution Explorer, navigate to LocationsModule project » Data folder and open the context menu of the OpenAccess folder.
    Click Add » Class.
  2. Name the class file LocationsFluentMetadataSource.cs and click Add.
  3. Open the file LocationsFluentMetadataSource.cs.
  4. Add the following using statements:
    • using Telerik.Sitefinity.Model;
    • using Telerik.Sitefinity.Modules.GenericContent.Data;
  5. Make the LocationsFluentMetadataSource class inherit the ContentBaseMetadataSource class:
    public class LocationsFluentMetadataSource : ContentBaseMetadataSource
    {
    }
  6. Create the following constructors for the class:
    public LocationsFluentMetadataSource()
        : base(null)
    {
    }
     
    public LocationsFluentMetadataSource(IDatabaseMappingContext context)
        : base(context)
    {
    }
  7. Override the BuildCustomMappings method. In the method, create an instance of the LocationsFluentMapping class and add the instance to the default set of mappings. Use the following code for the method:
    protected override IList<IOpenAccessFluentMapping> BuildCustomMappings()
    {
        var sitefinityMappings = base.BuildCustomMappings();
        sitefinityMappings.Add(new LocationsFluentMapping(this.Context));
        return sitefinityMappings;
    }

Back To Top

Next: Locations module: Implement a configuration class