search

UnifiedViews / Core

UnifiedViews
https://www.poolparty.biz/agile-data-integration
Other
30 stars 7 forks source link

Proof-read guide for creating dpus #12

Closed tomas-knap closed 9 years ago

tomas-knap commented 10 years ago

https://grips.semantic-web.at/display/UDDOC/Creation+of+Plugins

Till 17.3. When done, pls assign on @tomas-knap

ghost commented 10 years ago

Could this be done by me? I have never created any DPU, like one for whom the doc. is written. So if I am able to create one using the tutorial, then the tutorial is well written.

tomas-knap commented 10 years ago

Ok, so @skodape, please adjust till 16.3. and then pls assign on @mkl-eea-sk , he will go through, try to use the tutorial and adjust the text slightly if needed.

skodapetr commented 10 years ago

Tutorial seems to be ok (but maybe it's only as I basically know how to create a new DPU, so I don't see problems) .. I have added some latest information about the dialog and about on(de)serialize function. We may also remove the information about our maven reupload script and provide some shell/cmd script instead.

Another improvement can be add more information about FileDataUnit, on the other hand .. I think the file data unit in somehow documented in javadoc.

tomas-knap commented 10 years ago

Yes, but it would be maybe useful to introduce basic use of file data unit. So that the reader can quickly imagine how file data unit can be used.

Yes, the reupload scripts can be reoved, I guess (or put to a separated page for advanced readers)

On Fri, Mar 14, 2014 at 8:21 PM, Petr Škoda notifications@github.comwrote:

Tutorial seems to be ok (but maybe it's only as I basically know how to create a new DPU, so I don't see problems) .. I have added some latest information about the dialog and about on(de)serialize function. We may also remove the information about our maven reupload script and provide some shell/cmd script instead.

Another improvement can be add more information about FileDataUnit, on the other hand .. I think the file data unit in somehow documented in javadoc.

— Reply to this email directly or view it on GitHubhttps://github.com/UnifiedViews/Core/issues/12#issuecomment-37685611 .

ghost commented 10 years ago

Regarding https://grips.semantic-web.at/pages/viewpage.action?pageId=52564333

This section describes basic knowledge needed to prepare your own data processing units (DPUs) for ODCleanStore.

  • rebrand

See an example for SPARQL transformer

  • all examples hyperlinks point to mff-uk repository. should be UV

the configuration dialog, which allows to configure the DPU in the graphical user interface of ODCleanStore.

  • rebrand

programmer should use appropriate

  • hyperlink should should point to mff-uk webpage

from package cz.cuni.mff.xrg.odcs.commons.module.dpu

  • not clear from which project or jar the package originates

already locally available for the ODCleanStore engine.

  • rebrand

Instead of implementing interface the configuration class can extend following preimplemented configuration class. class cz.cuni.mff.xrg.odcs.commons.module.config.DPUConfigObject

  • No such class exist

See reasons why the usage of

  • wrong hyperlink

Currently only RDF data units (units passing RDF data) are available.

  • is this statement true?

RDFDataUnitHelper provides methods for dealing with RDF content being passed in RDFDataUnit from one DPU to another DPU. The selected methods of RDFDataUnitHelper interface, which may be called on RDFDataUnits by the DPU developer for processing content of data units or for filling the data units with new RDF data, are: Methods for adding new RDF triples to Data Units

  • addTriple(Resource subject, URI predicate, Value object) - Add the defined triple (s,p,o) to the DataUnit.
  • addFromTurtleFile(File file) - Add triples from file to the data unit. The file type is Turtle (TTL)
  • addFromRDFXMLFile(File file) - Add triples from file to the data unit. The file type is RDF/XML
  • addFromFile(File file, RDFFormat format) - Add triples from file to the data unit. The file type is explicitely specified
  • addFromSPARQLEndpoint(URL endpointURL, String namedGraph) - Add triples from SPARQL endpoint specified by the endpoint URL and named graph to the data unit.
  • addFromSPARQLEndpoint(URL endpointURL, String namedGraph,String user, String password) - Add triples from SPARQL endpoint specified by the endpoint URL, named graph to the data unit, using user and password provided.
  • the methods listed here are belonging to RDFDataUnit not RDFDataUnitHelper as stated above.
  • There is no addFromSPARQLEndpoint and addFromSPARQLEndpoint.

List getTriples() - Get list of all RDF triples (Statements) in DataUnit.

  • why not List ... ? Uses raw type.

storeToFile(File file, RDFFormatType formatType) - Saves triples from data unit to file. The file type is explicitely specified.

  • there is no storeToFile, only loadToFile

executeSelectQuery(String selectQuery) - Execute SPARQL select query over RDF data in DataUnit.

  • no such method (why there is no return value type?)

executeConstructQuery(String selectQuery) - Execute SPARQL construct query over RDF data in DataUnit."

  • no return value type specified in document (it is Graph class)

transform(String updateQuery) - Transform RDF data in DataUnit using SPARQL (update) query

  • no such method named transform

Such messages (events) are stored and accessible to the user via execution monitor in the administration interface of ODCleanStore.

  • rebrand

As the DPU's execution can be time consuming, ODCleanStore provides user with the possibilit

  • rebrand

le to the user by the graphical user interface of ODCleanStore. If

  • rebrand

© 2014,???

  • yes, there are question marks.
ghost commented 10 years ago

Regarding https://grips.semantic-web.at/display/UDDOC/Basic+Technologies

ODCleanStore

  • rebrand

TODO describe the minimum install - local repository, TODO describe the work with dependencies, scopes - compile, ..

  • do it or remove TODOs

© 2014,???

  • ???
nagyhel commented 10 years ago

Hi, all

searched and replaced ODCleanStore with UnifiedViews throughout the documentation.

Screenshots will follow.

Added swc and semantica in the footer instead of ??? :)

@Tomas, let me know if that's OK.

Regards Helmut

Helmut Nagy COO, Semantic Web Company (SWC) h.nagy@semantic-web.at

On Wed, Mar 19, 2014 at 7:01 AM, Michal Klempa notifications@github.comwrote:

Regarding https://grips.semantic-web.at/display/UDDOC/Basic+Technologies

ODCleanStore

  • rebrand

TODO describe the minimum install - local repository, TODO describe the work with dependencies, scopes - compile, ..

  • do it or remove TODOs

(c) 2014,???

  • ???

Reply to this email directly or view it on GitHubhttps://github.com/UnifiedViews/Core/issues/12#issuecomment-38020417 .

tomas-knap commented 10 years ago

Hi Helmut,

On Wed, Mar 19, 2014 at 10:03 AM, Helmut Nagy notifications@github.comwrote:

Hi, all

searched and replaced ODCleanStore with UnifiedViews throughout the documentation.

Ok, thanks for that.

Screenshots will follow.

Regarding the layout, you already set for: https://grips.semantic-web.at/display/UDDOC/Settings+Section, I would like to discuss that a bit.

The white rectangle behind the logo is not that nice. Also we cannot have menu bar in blue and menu on the left in grey (in settings), that looks strange.

So I would suggest to wait with screenshots adjustments, in order not to do it twice.

Added swc and semantica in the footer instead of ??? :)

Ok, but we should discuss where to put it. On the about page (obtained when clicking on the logo)?

Tomas

@Tomas, let me know if that's OK.

Regards Helmut

Helmut Nagy COO, Semantic Web Company (SWC) h.nagy@semantic-web.at

On Wed, Mar 19, 2014 at 7:01 AM, Michal Klempa <notifications@github.com

wrote:

Regarding https://grips.semantic-web.at/display/UDDOC/Basic+Technologies

ODCleanStore

  • rebrand

TODO describe the minimum install - local repository, TODO describe the work with dependencies, scopes - compile, ..

  • do it or remove TODOs

(c) 2014,???

  • ???

Reply to this email directly or view it on GitHub< https://github.com/UnifiedViews/Core/issues/12#issuecomment-38020417>

.

Reply to this email directly or view it on GitHubhttps://github.com/UnifiedViews/Core/issues/12#issuecomment-38029440 .

ghost commented 10 years ago

Regarding https://grips.semantic-web.at/display/UDDOC/DPU+Creation+Tutorial

ODCLeanStore

  • rebrand

the code may be obtained from Github project site, master branch, folder {root}/module/DPU_template)

  • wrong hyperlink
  • provide hyperlink directly to folder DPU_template?

See for details

  • see what?
  • hyperlink to mff-uk

TODOs in the pom.xml template

  • hyperlink to mff-uk repo

    If you want to use copy-to-odcs or publish-to-odcs maven p

  • hyperlink

: If you want to use copy-to-odcs or publish-to-odcs maven profiles, put her

  • hyperlinks

ethod for a SPARQL transformer executing th

  • hyperlink

The file DPUTemplateConfig.java contain

  • hyperlink

tion object for a SPARQL transformer.

  • hyperlink

The file DPUTemplateDialog.java contains implementation

  • hyperlink

implemented as a Vaadincomponent.

  • hyperlink (vaadin)

DPUs are packed in the form of OSGi bundles

  • hyperlink

placed to module.path/lib, wh

  • why it is hyperlink? it does not point to any meaningful location

    See this section for details how to

  • hyperlink to mffuk
ghost commented 10 years ago

I havent passed the dependency section though. The tutorial is one big mess. Example how to get transformer which only copies input triples to output triples should exist at least. I don't see any sence in proof-reading something that even author itself did not read after him.. Assign to me again when author thinks it is complete and without errors.

skrchnavy commented 9 years ago

Issue is closed, this belongs now to UnifiedViews/Plugins repository