[MGNLUI-4987] DOC: datasource (key concept) Created: 01/Feb/19  Updated: 02/Sep/19  Resolved: 16/Jul/19

Status: Closed
Project: Magnolia UI
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Task Priority: Neutral
Reporter: Christoph Meier Assignee: Ashraf Khamis
Resolution: Done Votes: 0
Labels: Datasource, key-concept, new-UI-framework, new-data-binding
Remaining Estimate: 0d
Time Spent: 1h 44m
Original Estimate: Not Specified

Issue Links:
Relates
relates to MGNLUI-5210 Replace code-based datasource compone... Closed
dependency
is depended upon by MGNLUI-4988 DOC: datasource (API) Closed
is depended upon by MGNLUI-5067 DOC: How to define datasource for Con... Closed
Template:
Acceptance criteria:
Empty
Task DoR:
Empty
Date of First Response:
Epic Link: DOC: Documentation for Magnolia 6.1
Sprint: UI Framework 1
Story Points: 3

 Description   

Summary

  • Explain the key concept of data source and how it differs from that of content connector.
  • What classes/interfaces are or can be involved in defining a data source (components for each data source definition)?
  • Mention existing example(s) (mainly for the JCR data source).

This ticket should be tackled in conjunction with MGNLUI-4988.

IMPORTANT NOTE

Refer to the new Data source definition page in the description of the datasource property at https://documentation.magnolia-cms.com/display/DOCS61/App+descriptor+-+6+UI and https://documentation.magnolia-cms.com/display/DOCS61/Subapp+descriptor+-+6+UI.



 Comments   
Comment by Roman Kovařík [ 28/Jun/19 ]

What classes / interfaces are or can be involved to define __ a datasource bundle?

Mention the existing example(s) (mainly for a JCR data source).

  • info.magnolia.ui.framework.datasource.components.PropertySetFactory
    • allows to read and write properties from/to item in a form (detail view or dialog opened on a selected item).
  • info.magnolia.ui.contentapp.browser.preview.PreviewProvider
    • Provides resource which is shown as preview of selected item (e.g. content of a binary node or link to an image)
  • info.magnolia.ui.field.SelectFieldSupport
    • allows to use this datasource in a select field as the source of all available items
  • info.magnolia.ui.contentapp.browser.List/TreePresenter
    • is a class used by list/tree view in a grid to provide
      • data provider (e.g. JcrDataProvider)
      • property set (allows to read/write items) for inline editing in grid
Comment by Ashraf Khamis [ 16/Jul/19 ]

Parent page created at https://documentation.magnolia-cms.com/display/DOCS61/Data+source+definition. Fully reviewed by Sasha and Roman.

For the data source definition pages, see MGNLUI-4988.

Generated at Mon Feb 12 09:22:05 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.