VIVO Documentation
Old Release
This documentation relates to an old version of VIVO, version 1.10.x. Looking for another version? See all documentation.
The Data Distribution API uses RDF statements of the form subject predicate object to specify the configuration for an action. Each distributor has a type (specified by "a" see below), an action name, and may use additional predicates to indicate relations to other entities. Multiple distributors may be used in the a single configuration to drill down, iterate, and/or assemble graphs.
The table includes all predicates, but only certain predicates can be used with specific data distributor. Check the documentation for the distributor you are using to determine which predicates apply to that distributor.
| Predicate | Type | Usage |
|---|---|---|
| a | O | Specify the type of data distributor |
| actionName | D | Associates the instance with an HTTP request. |
| child | O | The “wrapped” Data Distributor |
| childGraphBuilder | O | The “decorated” GraphBuilder instance(s), which will produce the RDF graph. |
| constructQuery | D | The SPARQL CONSTRUCT query |
| contentType | D | The MIME type to be sent in the HTTP response header. |
| drillDownQuery | D | Discovers the values that will be passed to the child GraphBuilder instance(s). |
| emptyResponse | D | A string to be served as an “empty data set”, if the file is not found. |
| filepathTemplate | D | A template for constructing the file path from the selection value. If the constructed path is relative, it is relative to the Vitro home directory. |
| graphBuilder | O | Creates an internal RDF graph |
| literalBinding | D | The name of a request parameter whose value should be bound in the query as a plain literal. |
| parameterName | D | The request parameter name. Used in various contexts by the distributors. See the examples. |
| parameterPattern | D | A regular expression to extract the file selector from the parameter value. |
| parameterValue | D | A that will be added to the named parameter, each value will be used in a run of childGraphBuilder |
| path | D | The location of a file to be served by the FileDistributor. If a relative path, it is relative to the Vitro home directory. |
| query | D | The SPARQL SELECT query. |
| script | D | A string of JavaScript to be interpreted and executed. It must contain a function named transform which accepts a String as argument and returns a String as result. |
| supportingScript | D | The path to a JavaScript file in the webapp. The path must be as specified for ServletContext.getResource(). That is, it must begin with a ‘/’ and is interpreted as relative to the context root of the webapp. |
| topLevelGraphBuilder | O | The source of the top-level graph, against which the drillDownQuery is run. |
| uriBinding | D | The name of a request parameter whose value should be bound in the query as a URI. |
Overview
Content Tools
All content on the LYRASIS Wiki is licensed under the CC BY (Attribution) license
, unless otherwise noted.