Skip to content

Commit ec8bbda

Browse files
committed
Update readme.md
1 parent 21df536 commit ec8bbda

1 file changed

Lines changed: 17 additions & 7 deletions

File tree

DataPresenter.DataSources.OData/readme.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,18 @@
77

88
####This open source solution contains several projects:
99

10-
1. A project that contains a reference implementation of an OData data source built on the functionality provided in the **AsyncPagingDataSourceBase** class shipped as part of **Infragistics NetAdvantage 16.1**. Note that this project references the source code in the _Shared Project_ at [**..\ODataDataProvider**](https://github.com/Infragistics/DataSource-Reference-Implementations/tree/master/ODataDataProvider)
11-
2. A sample application project that demonstrates how to use the OData data source with the XamDataPresenter _(shipped as part of Infragistics NetAdvantage 16.1.)_ The sample app presents a UI that lets you explore the capability of the OData data source as well as the XamDataPresenter's handling of the asynchronous/paged data fetching implemented in the data source. Several public accessible OData service Uris are built-in to the sample to enable browsing of data containing different data types and hosted on servers with varying performance characteristics.
10+
1. [**ODataDataSource Component**](https://github.com/Infragistics/DataSource-Reference-Implementations/tree/master/DataPresenter.DataSources.OData/DataPresenter.DataSources.OData) - A reference implementation of an OData data source built on the functionality provided in the **AsyncPagingDataSourceBase** class shipped as part of **Infragistics NetAdvantage 16.1**. Note that this project references the source code in the _Shared Project_ at [**..\ODataDataProvider**](https://github.com/Infragistics/DataSource-Reference-Implementations/tree/master/ODataDataProvider)
11+
2. [**Sample Application**](https://github.com/Infragistics/DataSource-Reference-Implementations/tree/master/DataPresenter.DataSources.OData/DataPresenter.DataSources.OData.SampleApp) - A sample application that demonstrates how to use the OData data source with the XamDataPresenter _(shipped as part of Infragistics NetAdvantage 16.1.)_ The sample app presents a UI that lets you explore the capability of the OData data source as well as the XamDataPresenter's handling of the asynchronous/paged data fetching implemented in the data source. Several public accessible OData service Uris are built-in to the sample to enable browsing of data containing different data types and hosted on servers with varying performance characteristics.
12+
13+
####ODataDataSource Component Notes
14+
* A reference implementation built on the functionality provided in the **AsyncPagingDataSourceBase** class shipped as part of **Infragistics NetAdvantage 16.1**
15+
* References the source code in the _Shared Project_ at [**..\ODataDataProvider**](https://github.com/Infragistics/DataSource-Reference-Implementations/tree/master/ODataDataProvider)
16+
* Exposes 3 public properties for configuring the data source:
17+
+ **BaseUri** - Returns/sets the root uri of the OData service endpoint from which to retrieve data.
18+
+ **EntitySet** - Returns/sets the desired entity set within the root OData API from which to retrieve data.
19+
+ **TimeoutMilliseconds** - Returns/sets the desired timeout to use for requests made to the OData API.
20+
* Relies on the [**Simple.OData.Client**](https://www.nuget.org/packages/Simple.OData.Client/) library _(not authored by Infragistics)_ to make the actual REST queries to the backend OData service.
21+
* As with the **AsyncPagingDataSourceBase** class it is derived from, this component is designed to be used with the XamDataPresenter family of controls _(shipped as part of Infragistics NetAdvantage 16.1)_ and is not compatible with other controls that are designed to work with _IEnumerable_ data sources.
1222

1323
####AsyncPagingDataSourceBase Class Notes
1424
* This library is shipped as part of NA 16.1.
@@ -26,9 +36,9 @@
2636
These properties can be used to tune the fetching and caching behavior of the APDSB to optimize performance for specific server scenarios.
2737

2838
####XamDataPresenter Notes
29-
The XamDataPresenter (XDP) has undergone some minor modifications for 16.1 to support using the APDSB as a data source. For example, a new property on the XDP's **DataRecordCellArea** class and a new **DataPresenterBrushKey** let the developer control what the XDP displays when data fetches are pending. Here are some highlights:
30-
* The developer uses the APDSB with the XDP the same way that any other data source is used – i.e., by setting the XDP’s DataSource property to an instance of an APDSB-derived data source. No other property settings are required to use the APDSB with the XDP.
31-
* XDP performance can be improved when using the APDSB if you know the contents of the OData schema for the EntitySet whose data you are retrieving. By defining a FieldLayout in the XDP with a subset of the schema fields, the APDSB will request and return less data over the server connection.
39+
The XamDataPresenter (XDP) has undergone some minor modifications for 16.1 to support using the APDSB _(and derived implementations such as **ODataDataSource**)_ as a data source. For example, a new property on the XDP's **DataRecordCellArea** class and a new **DataPresenterBrushKey** let the developer control what the XDP displays when data fetches are pending. Here are some highlights:
40+
* The developer uses the APDSB with the XDP the same way that any other data source is used – i.e., by setting the XDP’s **DataSource** property to an instance of an APDSB-derived data source such as the **ODataDataSource**. No other property settings are required to use the APDSB with the XDP.
41+
* XDP performance can be improved when using the APDSB if you know the contents of the OData schema for the _EntitySet_ whose data you are retrieving. By defining a _FieldLayout_ in the XDP with a subset of the schema fields, the APDSB will request and return less data over the server connection.
3242

3343
_**NOTE:** You can also limit the amount of data requested and returned by the APDSB by setting the APDSB’s DesiredFields property to a subset of the fields in the backend schema._
3444

@@ -45,7 +55,7 @@ _**NOTE:** The XDP can use the APDSP in all its views (GridView, CardView etc.)
4555
* Editing is not supported in the XamDataPresenter when using APDSB – the grid is read-only in this scenario. Adding/removing records is also not supported.
4656
* The XDP’s filter dropdown does not include a list of unique data values from the associated column since the APDSB does not support the ability to query the backend for those unique values.
4757
* A **FieldLayoutSettings.FilterUIType** of **LabelIcons** is not supported when the XDP is using an APDSB as its data source. The **FilterUIType** will always resolve to **FilterUIType.FilterRecord** in this scenario since the unique data values that would normally be displayed in the filter dropdown when the Label icon is clicked are not available as described above.
48-
* The following ComparisonOperators are not supported when filtering:
58+
* The following **ComparisonOperators** are not supported when filtering:
4959
+ Match
5060
+ DoesNotMatch
5161
+ Like
@@ -54,7 +64,7 @@ _**NOTE:** The XDP can use the APDSP in all its views (GridView, CardView etc.)
5464
+ TopPercentile
5565
+ Bottom
5666
+ BottomPercentile
57-
* The following SpecialFilterOperands are not supported:
67+
* The following **SpecialFilterOperands** are not supported:
5868
+ BlanksOperand
5969
+ AverageOperand
6070
* Grouping is not currently supported

0 commit comments

Comments
 (0)