Unify URIs of module parameters - Githubissues

kbss-cvut / s-pipes

Tool for execution of RDF-based pipelines.

GNU Lesser General Public License v3.0

4 stars 5 forks source link

Unify URIs of module parameters #275

Open blcham opened 2 months ago

blcham commented 2 months ago

There are multiple ways in which parameter URIs are defined:

e.g. Ckan2RdfModule prefixes all properties by p-, i.e. @Parameter(iri = TYPE_URI + "/" + "p-ckan-url", comment = "URL of the CKAN server.")
e.g. TabularModule -- @Parameter(iri = PARAM_URL_PREFIX + "source-resource-uri"

There are multiple use cases for parameters:

some parameters are reusable across all modules (kbss-module:has-input-graph-constraint)
some parameters are reusable (e.g. sml:replace, kbss-module:is-parse-text, kbss-module:has-resource-uri)-
some parameters are not reusable at all

A/C:

A guide to README is added what is the best practice to create new reusable/specific params and how/when to migrate params from specific to reusable
module parameters are refactored according to the guide while there is also mechanism how to log deprecated parameters of modules

blcham commented 2 months ago

I suggest to start refactoring most used modules first such as Tabular module and create TABULAR.java for the prefixes