Data Adaptors in ASP.NET MVC DataManager

1 Mar 202224 minutes to read

DataManger uses adaptors to process data. There are three types of adaptors in the DataManger. They are

  • JSON Adaptor
  • URL Adaptor
  • OData Adaptor

Here, you can learn when and how each adaptor is used.

JSON Adaptor

JSONAdaptor is used to process JSON data. It contains methods to process the given JSON data based on the queries. The following code example illustrates on how to use the JSONAdaptor.

JSONAdaptor has the following unique in-built methods,

Properties
 Parameters
 Description
processQuery(dataManagerObj, query)
dataManagerObj Object ej.DataManager object
query ej.Query Sets the default query for the data source
Used to prepare query string for the request data
processResponse(data, dataObj, query, xhr)
data Object JSON data or JSON array
dataObj Object ej.DataManager object
query ej.Query Sets the default query for the data source
xhr Object XMLHTTPRequest object
Used to precess the response which is return from the Data Source
insert(dataManagerObj, data)
data Object JSON data or JSON array
dataManagerObj Object ej.DataManager object
Inserts a data item in the data table.
remove(dataManagerObj, keyField, value, tableName)
dataManagerObj Object ej.DataManager object
keyField String KeyColumn to find the data
String Object Specified value for the keyField
tableName String Name of the source table
It is used to remove the data from the dataSource
update(dataManagerObj, keyField, value, tableName)
dataManagerObj Object ej.DataManager object
keyField String KeyColumn to find the data
String Object Specified value for the keyField
tableName String Name of the source table
Updates existing record and saves the changes to the table..
  • C#
    • public ActionResult GridFeatures()
    {
        var DataSource = new NorthwindDataContext().OrdersViews.ToList();
        ViewBag.dataSource = DataSource;
        return View();
    }
  • CSHTML
    • @(Html.EJ().DataManager("FlatData").Json((IEnumerable<object>)ViewBag.dataSource))

    @(Html.EJ().Grid<MVCdoc.OrdersView>("FlatGrid")
            .DataManagerID("FlatData")
            .Query("new ej.Query().select(['OrderID', 'CustomerID', 'EmployeeID', 'ShipCity', 'Freight']).take(5)")
            .Columns(col =>
            {
                col.Field("OrderID").HeaderText("Order ID").IsPrimaryKey(true).TextAlign(TextAlign.Right).Width(75).Add();
                col.Field("CustomerID").HeaderText("Customer ID").Width(80).Add();
                col.Field("EmployeeID").HeaderText("Employee ID").TextAlign(TextAlign.Right).Width(75).Add();
                col.Field("Freight").HeaderText("Freight").TextAlign(TextAlign.Right).Width(75).Format("{0:C}").Add();
                col.Field("ShipCity").HeaderText("Ship City").Width(110).Add();
            })
    )

    The result of above code example is illustrated as follows.

    ASP.NET MVC DataManager JSON Adaptor

    JSON adaptor

    URL Adaptor

    URL Adaptor of the DataManager can be used when you are required to use remote service to retrieve data. It interacts with server-side for all DataManager Queries and CRUD operations. Now, in the following code example, the data is retrieved from the MVCController.

    UrlAdaptor has the following unique in-built methods,

    Properties
    		 Parameters
    		 Description
    processQuery(dataManagerObj, query, hierarchyFilters)
    dataManagerObj Object ej.DataManager object
    query ej.Query Sets the default query for the data source
    hierarchyFilters ej.Query The hierarchical query can be provided by using the hierarchical function.
    		Used to prepare query string for the request data
    processResponse(data, dataObj, query, xhr, request, changes)
    data Object JSON data or JSON array of Result
    dataObj Object ej.DataManager object
    query ej.Query Sets the default query for the data source
    xhr Object XMLHTTPRequest object
    request Object request object to the Data Source
    changes Object Specified changes to the Data Source
    		Used to precess the response which is return from the Data Source
    insert(dataManagerObj, data, tableName, query)
    data Object JSON data or JSON array
    dataManagerObj Object ej.DataManager object
    tableName String Name of the source table
    query ej.Query Sets the default query for the data source
    		Inserts a data item in the data table.
    remove(dataManagerObj, keyField, value, tableName, query)
    dataManagerObj Object ej.DataManager object
    keyField String KeyColumn to find the data
    String Object Specified value for the keyField
    tableName String Name of the source table
    query ej.Query Sets the default query for the data source
    		It is used to remove the data from the dataSource
    update(dataManagerObj, keyField, value, tableName, query)
    dataManagerObj Object ej.DataManager object
    keyField String KeyColumn to find the data
    String Object Specified value for the keyField
    tableName String Name of the source table
    query ej.Query Sets the default query for the data source
    		Updates existing record and saves the changes to the table.. 
    @(Html.EJ().DataManager("FlatData").URL("Home/DataSource").Adaptor(AdaptorType.UrlAdaptor))

    @(Html.EJ().Grid<MVCdoc.OrdersView>("FlatGrid")
            .DataManagerID("FlatData")
            .Query("new ej.Query().select(['OrderID', 'CustomerID', 'EmployeeID', 'ShipCity', 'Freight']).take(5)")
            .Columns(col =>
            {
                col.Field("OrderID").HeaderText("Order ID").IsPrimaryKey(true).TextAlign(TextAlign.Right).Width(75).Add();
                col.Field("CustomerID").HeaderText("Customer ID").Width(80).Add();
                col.Field("EmployeeID").HeaderText("Employee ID").TextAlign(TextAlign.Right).Width(75).Add();
                col.Field("Freight").HeaderText("Freight").TextAlign(TextAlign.Right).Width(75).Format("{0:C}").Add();
                col.Field("ShipCity").HeaderText("Ship City").Width(110).Add();
            })

    )
    public class HomeController : Controller
    {
        public ActionResult Index()
        {
            return View();
        }
        public ActionResult DataSource(Syncfusion.JavaScript.DataManager dataManagerObj)
        {
            var DataSource = OrderRepository.GetAllRecords();
            DataResult result = new DataResult();
            result.result = DataSource.Skip(dataManagerObj.Skip).Take(dataManagerObj.Take).ToList();
            result.count = DataSource.Count();
            return Json(result, JsonRequestBehavior.AllowGet);
        }
        public class DataResult
        {
            public IEnumerable<EditableOrder> result { get; set; }
            public int count { get; set; }
        }

    }

    The result of the above code example is illustrated as follows.

    ASP.NET MVC DataManager URL Adaptor

    URL Adaptor

    OData Adaptor

    OData Adaptor that is extended from URL Adaptor is used for consuming data through OData Service. You can use the following code example to use OData adaptor.

    ODataAdaptor has the following unique in-built methods,

    Properties
    		 Parameters
    		 Description
    processResponse(data, dataObj, query, xhr, request, changes)
    data Object JSON data or JSON array
    dataObj Object ej.DataManager object
    query ej.Query Sets the default query for the data source
    xhr Object XMLHTTPRequest object
    request Object request object to the Data Source
    changes Object Specified changes to the Data Source
    		Used to precess the response which is return from the Data Source
    insert(dataManagerObj, data, tableName)
    data Object JSON data or JSON array
    dataManagerObj Object ej.DataManager object
    tableName String Name of the source table
    		Inserts a data item in the data table.
    remove(dataManagerObj, keyField, value, tableName)
    dataManagerObj Object ej.DataManager object
    keyField String KeyColumn to find the data
    String Object Specified value for the keyField
    tableName String Name of the source table
    		It is used to remove the data from the dataSource
    update(dataManagerObj, keyField, value, tableName)
    dataManagerObj Object ej.DataManager object
    keyField String KeyColumn to find the data
    String Object Specified value for the keyField
    tableName String Name of the source table
    		Updates existing record and saves the changes to the table..
  • CSHTML
    • @(Html.EJ().DataManager("FlatData").URL("http://mvc.syncfusion.com/Services/Northwnd.svc/Orders/").Offline(true).CrossDomain(true))

    @(Html.EJ().Grid<MVCdoc.OrdersView>("FlatGrid")
        .DataManagerID("FlatData")
        .Query("new ej.Query().select(['OrderID', 'CustomerID', 'EmployeeID', 'ShipCity', 'Freight']).take(5)")
        .Columns(col =>
        {
            col.Field("OrderID").HeaderText("Order ID").IsPrimaryKey(true).TextAlign(TextAlign.Right).Width(75).Add();
            col.Field("CustomerID").HeaderText("Customer ID").Width(80).Add();  
            col.Field("EmployeeID").HeaderText("Employee ID").TextAlign(TextAlign.Right).Width(75).Add();
            col.Field("Freight").HeaderText("Freight").TextAlign(TextAlign.Right).Width(75).Format("{0:C}").Add();
            col.Field("ShipCity").HeaderText("Ship City").Width(110).Add();
        })
    )

    The result of the above code example is illustrated as follows.

    ASP.NET MVC DataManager OData Adaptor

    OData adaptor

    WebAPI Adaptor

    WebAPIAdaptor extended from the UrlAdaptor of the DataManager is used for retrieving data from WebAPI service. Refer to the following code example.

    WebApiAdaptor has the following unique in-built methods,

    Properties
    		 Parameters
    		 Description
    processResponse(data, dataObj, query, xhr, request, changes)
    data Object JSON data or JSON array
    dataObj Object ej.DataManager object
    query ej.Query Sets the default query for the data source
    xhr Object XMLHTTPRequest object
    request Object request object to the Data Source
    changes Object Specified changes to the Data Source
    		Used to precess the response which is return from the Data Source
    insert(dataManagerObj, data, tableName)
    data Object JSON data or JSON array
    dataManagerObj Object ej.DataManager object
    tableName String Name of the source table
    		Inserts a data item in the data table.
    remove(dataManagerObj, keyField, value, tableName)
    dataManagerObj Object ej.DataManager object
    keyField String KeyColumn to find the data
    String Object Specified value for the keyField
    tableName String Name of the source table
    		It is used to remove the data from the dataSource
    update(dataManagerObj, keyField, value, tableName)
    dataManagerObj Object ej.DataManager object
    keyField String KeyColumn to find the data
    String Object Specified value for the keyField
    tableName String Name of the source table
    		Updates existing record and saves the changes to the table..
  • C#
    • public class EmployeeController : ApiController
    {
        static readonly IEmployeeRepository repository = new EmployeeRepository();
        // GET API/<controller>
        [HttpGet]
        public object Get()
        {
            var data = repository.GetAll().ToList();
            return new { Items = data, Count = data.Count() };
        }
    }
  • CSHTML
    • @(Html.EJ().DataManager("FlatData").URL("/api/Employee").Adaptor(AdaptorType.WebApiAdaptor))

    @(Html.EJ().Grid<Sample.Models.Employee>("FlatGrid")
            .DataManagerID("FlatData")
            .Query("new ej.Query().select(['EmployeeID', 'FirstName', 'LastName'])")
            .Columns(col =>
            {
                col.Field("EmployeeID").HeaderText("EmployeeID").IsPrimaryKey(true).Width(75).Add();
                col.Field("FirstName").HeaderText("FirstName").Width(80).Add();
                col.Field("LastName").HeaderText("LastName").Add();
            })
    )

    Result of the above code example is illustrated as follows.

    ASP.NET MVC DataManager WebAPI Adaptor

    Web API Adaptor

    RemoteSave Adaptor

    RemoteSaveAdaptor extended from the JsonAdaptor of theDataManager is used for binding local data and performs all DataManager queries in client-side. It interacts with server-side only for CRUD operations to pass the modified records. Refer to the following code example.

    RemoteSaveAdaptor has the following unique in-built methods,

    Properties
    		 Parameters
    		 Description
    insert(dataManagerObj, data, tableName, query)
    data Object JSON data or JSON array
    dataManagerObj Object ej.DataManager object
    tableName String Name of the source table
    query ej.Query Sets the default query for the data source
    		Inserts a data item in the data table.
    remove(dataManagerObj, keyField, value, tableName, query)
    dataManagerObj Object ej.DataManager object
    keyField String KeyColumn to find the data
    String Object Specified value for the keyField
    tableName String Name of the source table
    query ej.Query Sets the default query for the data source
    		It is used to remove the data from the dataSource
    update(dataManagerObj, keyField, value, tableName, query)
    dataManagerObj Object ej.DataManager object
    keyField String KeyColumn to find the data
    String Object Specified value for the keyField
    tableName String Name of the source table
    query ej.Query Sets the default query for the data source
    		Updates existing record and saves the changes to the table.. 
    @(Html.EJ().Grid<object>("FlatGrid")
                .Datasource(dataSource => dataSource.Json((IEnumerable<object>)ViewBag.datasource).UpdateURL("/Home/Update")
                .InsertURL("/Home/Insert").RemoveURL("/Home/Remove").Adaptor(AdaptorType.RemoteSaveAdaptor))
                .AllowPaging()
                .EditSettings(edit => { edit.AllowAdding().AllowDeleting().AllowEditing(); })
                .ToolbarSettings(toolbar =>
                {
                toolbar.ShowToolbar().ToolbarItems(items =>
                    {
                        items.AddTool(ToolBarItems.Add);
                        items.AddTool(ToolBarItems.Edit);
                        items.AddTool(ToolBarItems.Delete);
                        items.AddTool(ToolBarItems.Update);
                        items.AddTool(ToolBarItems.Cancel);
                    });
                })
            .Columns(col =>
                {
                col.Field("OrderID").IsPrimaryKey(true).Add();
                col.Field("EmployeeID").Add();
                col.Field("CustomerID").Add();
                col.Field("ShipCountry").Add();
                col.Field("Freight").Add();
            })
        )
    namespace EJGrid.Controllers
          {
             public class HomeController : Controller
              {
             public ActionResult Index()
              {
                var data = OrderRepository.GetAllRecords();
                ViewBag.dataSource = data;
                return View();
              }
             public ActionResult Update(EditableOrder value)
              {
                OrderRepository.Update(value);
                var data = OrderRepository.GetAllRecords();
                return Json(data, JsonRequestBehavior.AllowGet);
              }
             public ActionResult Insert(EditableOrder value)
              {
                OrderRepository.Add(value);
                var data = OrderRepository.GetAllRecords();
                return Json(data, JsonRequestBehavior.AllowGet);
             }
            public ActionResult Remove(int key)
            {
               OrderRepository.Delete(key);
               var data = OrderRepository.GetAllRecords();
               return Json(data, JsonRequestBehavior.AllowGet);
            }
         }
      }

    Result of the above code example is illustrated as follows.

    ASP.NET MVC DataManager RemoteSave Adaptor

    RemoteSave Adaptor

    Custom Adaptor

    Custom Adaptor is a key technique to customize adaptors in the DataManager. It is useful to write own adaptor. Normally ej.Adaptor is base class for all adaptors. Therefore, first inherit the ej.Adaptor to develop the customized one and then override functionality in Custom Adaptor with base class. The following code example illustrates you how to create the Custom Adaptor.

  • HTML
    • @(Html.EJ().DataManager("FlatData”))

    @(Html.EJ().Grid<MVCdoc.OrdersView>("FlatGrid")
        .DataManagerID("FlatData")
        .Query("new ej.Query().select(['OrderID', 'CustomerID', 'EmployeeID', 'ShipCity', 'Freight']).take(5)")
        .Columns(col =>
        {
            col.Field("OrderID").HeaderText("Order ID").IsPrimaryKey(true).TextAlign(TextAlign.Right).Width(75).Add();
            col.Field("CustomerID").HeaderText("Customer ID").Width(80).Add();
            col.Field("EmployeeID").HeaderText("Employee ID").TextAlign(TextAlign.Right).Width(75).Add();
            col.Field("Freight").HeaderText("Freight").TextAlign(TextAlign.Right).Width(75).Format("{0:C}").Add();
            col.Field("ShipCity").HeaderText("Ship City").Width(110).Add();
        })

)



<script type="text/javascript">

        $(function () {// Document is ready.

            //new custom adaptor implementation
            //able to implement more option in custom adaptor other than insert
            var customAdaptor = new ej.Adaptor().extend({
                insert: function (dataManagerObj, data) {
                    return dataManagerObj.dataSource.json.push(data);
                },
                processQuery: ej.JsonAdaptor.prototype.processQuery // reused process query from json adaptor
            });

            window.FlatData.Adaptor = new customAdaptor()
            window.FlatData.insert({ OrderID: 10240, CustomerID: "HANAR", EmployeeID: 3, ShipCity: "Reims", Freight: "23.4" });
            window.FlatData.insert({ OrderID: 10241, CustomerID: "HANAR", EmployeeID: 2, ShipCity: "Reims", Freight: "21.4" });
            window.FlatData.insert({ OrderID: 10242, CustomerID: "VINET", EmployeeID: 5, ShipCity: "Lyon", Freight: "13.4" });
            var obj = $("#FlatGrid").ejGrid("instance");
            obj.dataSource(window.FlatData.executeLocal(new ej.Query().take(7)));

        })

</script>

    Result of above code example is as follows.

    ASP.NET MVC DataManager Custom Adaptor

    Custom adaptor

    Using Custom Adaptor, you can override the existing method of Extended Adaptor,

    Properties
    		 Description
    beforeSend Custom headers can be set using pre-request callback beforeSend, by using the setRequestHeader method can be used to modify the XMLHTTPRequest
    processQuery Used to prepare query string for the request data
    processResponse Used to precess the response which is return from the Data Source
    insert The insert method of the data manager is used to add a new record to the table
    remove The remove action submits the data items that should be deleted
    update The update method is used to update the modified changes made to a record in the data source of the DataManager.

    Cache Adaptor

    Cache Adaptor is used to cache the data of the visited pages. It prevents new requests for the previously visited pages. It can be enabled by using the EnableCaching property. You can configure cache page size and duration of caching by using CachingPageSize and TimeTillExpiration properties of the “DataManager”.

    CacheAdaptor has the following unique in-built methods,

    Properties
    		 Parameters
    		 Description
    processQuery(dataManagerObj, query, hierarchyFilters)
    dataManagerObj Object ej.DataManager object
    query ej.Query Sets the default query for the data source
    hierarchyFilters ej.Query The hierarchical query can be provided by using the hierarchical function.
    		Used to prepare query string for the request data
    processResponse(data, dataObj, query, xhr, request, changes)
    data Object JSON data or JSON array
    dataObj Object ej.DataManager object
    query ej.Query Sets the default query for the data source
    xhr Object XMLHTTPRequest object
    request Object Sets the default query for the data source
    changes Object XMLHTTPRequest object
    		Used to precess the response which is return from the Data Source
    insert(dataManagerObj, data, tableName)
    data Object JSON data or JSON array
    dataManagerObj Object ej.DataManager object
    tableName String Name of the source table
    		Inserts a data item in the data table.
    remove(dataManagerObj, keyField, value, tableName)
    dataManagerObj Object ej.DataManager object
    keyField String KeyColumn to find the data
    String Object Specified value for the keyField
    tableName String Name of the source table
    		It is used to remove the data from the dataSource
    update(dataManagerObj, keyField, value, tableName)
    dataManagerObj Object ej.DataManager object
    keyField String KeyColumn to find the data
    String Object Specified value for the keyField
    tableName String Name of the source table
    		Updates existing record and saves the changes to the table..
  • CSHTML
    • @(Html.EJ().Grid<OrdersView>("Grid")
        .Datasource(dataSource => dataSource.URL(@Url.Action("DataSource"))
        .EnableCaching()
        .CachingPageSize(4)
        .TimeTillExpiration(120000)
        .Adaptor(AdaptorType.UrlAdaptor))
        .AllowPaging()
        .Columns(col =>
            {
                col.Field(p => p.OrderID).HeaderText("Order ID").Add();
                col.Field(p => p.CustomerID).HeaderText("Customer ID").TextAlign(TextAlign.Left).Add();
                col.Field(p => p.EmployeeID).HeaderText("Employee ID").Add();
                col.Field(p => p.Freight).HeaderText("Freight").Format("{0:C2}").Add();
            })
    )
  • C#
    • //Refer the Syncfusion DataSource assembly 
    using Syncfusion.JavaScript;
    using Syncfusion.JavaScript.DataSources;

    public IEnumerable OrderData = new NorthwindDataContext().OrdersViews.ToList();
    public ActionResult GridFeatures()
    {
        return View();
    }
    public ActionResult DataSource(DataManager dataManagerObj) 
    {
        IEnumerable data = OrderData;
        DataOperations operation = new DataOperations();
        if (dataManagerObj.Sorted != null && dataManagerObj.Sorted.Count > 0) //Sorting
        {
            data= operation.PerformSorting(data, dataManagerObj.Sorted);
        }            
        if (dataManagerObj.Where != null && dataManagerObj.Where.Count > 0) //Filtering
        {
            data= operation.PerformWhereFilter(data, dataManagerObj.Where, dataManagerObj.Where[0].Operator);
        }            
        int count = data.Cast<OrdersView>().Count();
        if (dataManagerObj.Skip != 0)
        {
            data= operation.PerformSkip(data, dataManagerObj.Skip);
        }            
        if (dataManagerObj.Take != 0)
        {
            data= operation.PerformTake(data, dataManagerObj.Take);
        }
        return Json(new { result = data, count = count });
        }
    }

    ASP.NET MVC DataManager Cache Adaptor
    Cache Adaptor

    Cache Adaptor has the following unique properties,

    Properties
    		Description
    TimeTillExpiration Specifies the duration of cached pages in milliseconds
    CachingPageSize A number of pages to be cached