@comunica/actor-rdf-join-inner-multi-sequential 2.0.1-alpha.5.0

package/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright © 2017–now Ruben Taelman, Joachim Van Herwegen
+Comunica Association and Ghent University – imec, Belgium
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,44 @@
+# Comunica Inner Multi-way Sequential RDF Join Actor
+
+[![npm version](https://badge.fury.io/js/%40comunica%2Factor-rdf-join-inner-multi-sequential.svg)](https://www.npmjs.com/package/@comunica/actor-rdf-join-inner-multi-sequential)
+
+An [RDF Join](https://github.com/comunica/comunica/tree/master/packages/bus-rdf-join) actor that inner-joins 3 or more streams
+by joining the first two, and joining the result with the remaining streams by delegating back to the [RDF Join bus](https://github.com/comunica/comunica/tree/master/packages/bus-rdf-join).
+
+This module is part of the [Comunica framework](https://github.com/comunica/comunica),
+and should only be used by [developers that want to build their own query engine](https://comunica.dev/docs/modify/).
+
+[Click here if you just want to query with Comunica](https://comunica.dev/docs/query/).
+
+## Install
+
+```bash
+$ yarn add @comunica/actor-rdf-join-inner-multi-sequential
+```
+
+## Configure
+
+After installing, this package can be added to your engine's configuration as follows:
+```text
+{
+  "@context": [
+    ...
+    "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/actor-rdf-join-inner-multi-sequential/^2.0.0/components/context.jsonld"  
+  ],
+  "actors": [
+    ...
+    {
+      "@id": "urn:comunica:default:rdf-join/actors#inner-multi-sequential",
+      "@type": "ActorRdfJoinMultiSequential",
+      "mediatorJoinSelectivity": { "@id": "urn:comunica:default:rdf-join-selectivity/mediators#main" },
+      "mediatorJoin": { "@id": "urn:comunica:default:rdf-join/mediators#main" }
+    }
+  ]
+}
+```
+
+### Config Parameters
+
+* `mediatorJoinSelectivity`: A mediator over the [RDF Join Selectivity bus](https://github.com/comunica/comunica/tree/master/packages/bus-rdf-join-selectivity).
+* `mediatorJoin`: A mediator over the [RDF Join bus](https://github.com/comunica/comunica/tree/master/packages/bus-rdf-join).
+

package/components/ActorRdfJoinMultiSequential.jsonld

@@ -0,0 +1,194 @@
+{
+  "@context": [
+    "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/actor-rdf-join-inner-multi-sequential/^2.0.0/components/context.jsonld",
+    "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/core/^2.0.0/components/context.jsonld",
+    "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/bus-rdf-join/^2.0.0/components/context.jsonld"
+  ],
+  "@id": "npmd:@comunica/actor-rdf-join-inner-multi-sequential",
+  "components": [
+    {
+      "@id": "carjimse:components/ActorRdfJoinMultiSequential.jsonld#ActorRdfJoinMultiSequential",
+      "@type": "Class",
+      "requireElement": "ActorRdfJoinMultiSequential",
+      "extends": [
+        "cbrj:components/ActorRdfJoin.jsonld#ActorRdfJoin"
+      ],
+      "comment": "A Multi Sequential RDF Join Actor. It accepts 3 or more streams, joins the first two, and joins the result with the remaining streams.",
+      "parameters": [
+        {
+          "@id": "carjimse:components/ActorRdfJoinMultiSequential.jsonld#ActorRdfJoinMultiSequential_args_mediatorJoin",
+          "range": "cc:components/Mediator.jsonld#Mediator",
+          "comment": "A mediator for joining Bindings streams"
+        },
+        {
+          "@id": "carjimse:components/ActorRdfJoinMultiSequential.jsonld#ActorRdfJoinMultiSequential_args_mediatorJoinSelectivity",
+          "range": "cc:components/Mediator.jsonld#Mediator"
+        },
+        {
+          "@id": "carjimse:components/ActorRdfJoinMultiSequential.jsonld#ActorRdfJoinMultiSequential_args_name",
+          "range": "xsd:string",
+          "default": {
+            "@id": "rdf:subject"
+          },
+          "comment": "The name for this actor."
+        },
+        {
+          "@id": "carjimse:components/ActorRdfJoinMultiSequential.jsonld#ActorRdfJoinMultiSequential_args_bus",
+          "range": {
+            "@type": "ParameterRangeGenericComponent",
+            "component": "cc:components/Bus.jsonld#Bus",
+            "genericTypeInstances": [
+              {
+                "@type": "ParameterRangeGenericComponent",
+                "component": "cc:components/Actor.jsonld#Actor",
+                "genericTypeInstances": [
+                  {
+                    "@type": "ParameterRangeGenericTypeReference",
+                    "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^2.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_I"
+                  },
+                  {
+                    "@type": "ParameterRangeGenericTypeReference",
+                    "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^2.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_T"
+                  },
+                  {
+                    "@type": "ParameterRangeGenericTypeReference",
+                    "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^2.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_O"
+                  }
+                ]
+              },
+              {
+                "@type": "ParameterRangeGenericTypeReference",
+                "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^2.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_I"
+              },
+              {
+                "@type": "ParameterRangeGenericTypeReference",
+                "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^2.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_T"
+              },
+              {
+                "@type": "ParameterRangeGenericTypeReference",
+                "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^2.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_O"
+              }
+            ]
+          },
+          "default": {
+            "@id": "cbrj:components/ActorRdfJoin.jsonld#ActorRdfJoin_default_bus",
+            "@type": "cc:components/Bus.jsonld#Bus"
+          },
+          "comment": "The bus this actor subscribes to."
+        },
+        {
+          "@id": "carjimse:components/ActorRdfJoinMultiSequential.jsonld#ActorRdfJoinMultiSequential_args_beforeActors",
+          "range": {
+            "@type": "ParameterRangeUnion",
+            "parameterRangeElements": [
+              {
+                "@type": "ParameterRangeArray",
+                "parameterRangeValue": {
+                  "@type": "ParameterRangeGenericComponent",
+                  "component": "cc:components/Actor.jsonld#Actor",
+                  "genericTypeInstances": [
+                    {
+                      "@type": "ParameterRangeGenericTypeReference",
+                      "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^2.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_I"
+                    },
+                    {
+                      "@type": "ParameterRangeGenericTypeReference",
+                      "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^2.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_T"
+                    },
+                    {
+                      "@type": "ParameterRangeGenericTypeReference",
+                      "parameterRangeGenericType": "npmd:@comunica/actor-abstract-mediatyped/^2.0.0/components/ActorAbstractMediaTyped.jsonld#ActorAbstractMediaTyped__generic_O"
+                    }
+                  ]
+                }
+              },
+              {
+                "@type": "ParameterRangeUndefined"
+              }
+            ]
+          },
+          "comment": "Actor that must be registered in the bus before this actor."
+        }
+      ],
+      "memberFields": [
+        {
+          "@id": "carjimse:components/ActorRdfJoinMultiSequential.jsonld#ActorRdfJoinMultiSequential__member_mediatorJoin",
+          "memberFieldName": "mediatorJoin",
+          "range": "cc:components/Mediator.jsonld#Mediator"
+        },
+        {
+          "@id": "carjimse:components/ActorRdfJoinMultiSequential.jsonld#ActorRdfJoinMultiSequential__member_FACTORY",
+          "memberFieldName": "FACTORY",
+          "range": {
+            "@type": "ParameterRangeWildcard"
+          }
+        },
+        {
+          "@id": "carjimse:components/ActorRdfJoinMultiSequential.jsonld#ActorRdfJoinMultiSequential__member_constructor",
+          "memberFieldName": "constructor"
+        },
+        {
+          "@id": "carjimse:components/ActorRdfJoinMultiSequential.jsonld#ActorRdfJoinMultiSequential__member_getOutput",
+          "memberFieldName": "getOutput"
+        },
+        {
+          "@id": "carjimse:components/ActorRdfJoinMultiSequential.jsonld#ActorRdfJoinMultiSequential__member_getJoinCoefficients",
+          "memberFieldName": "getJoinCoefficients"
+        }
+      ],
+      "constructorArguments": [
+        {
+          "@id": "carjimse:components/ActorRdfJoinMultiSequential.jsonld#ActorRdfJoinMultiSequential_args__constructorArgument",
+          "fields": [
+            {
+              "keyRaw": "mediatorJoin",
+              "value": {
+                "@id": "carjimse:components/ActorRdfJoinMultiSequential.jsonld#ActorRdfJoinMultiSequential_args_mediatorJoin"
+              }
+            },
+            {
+              "keyRaw": "mediatorJoinSelectivity",
+              "value": {
+                "@id": "carjimse:components/ActorRdfJoinMultiSequential.jsonld#ActorRdfJoinMultiSequential_args_mediatorJoinSelectivity"
+              }
+            },
+            {
+              "keyRaw": "name",
+              "value": {
+                "@id": "carjimse:components/ActorRdfJoinMultiSequential.jsonld#ActorRdfJoinMultiSequential_args_name"
+              }
+            },
+            {
+              "keyRaw": "bus",
+              "value": {
+                "@id": "carjimse:components/ActorRdfJoinMultiSequential.jsonld#ActorRdfJoinMultiSequential_args_bus"
+              }
+            },
+            {
+              "keyRaw": "beforeActors",
+              "value": {
+                "@id": "carjimse:components/ActorRdfJoinMultiSequential.jsonld#ActorRdfJoinMultiSequential_args_beforeActors"
+              }
+            }
+          ]
+        }
+      ]
+    },
+    {
+      "@id": "carjimse:components/ActorRdfJoinMultiSequential.jsonld#IActorRdfJoinMultiSequentialArgs",
+      "@type": "AbstractClass",
+      "requireElement": "IActorRdfJoinMultiSequentialArgs",
+      "extends": [
+        "cbrj:components/ActorRdfJoin.jsonld#IActorRdfJoinArgs"
+      ],
+      "parameters": [],
+      "memberFields": [
+        {
+          "@id": "carjimse:components/ActorRdfJoinMultiSequential.jsonld#IActorRdfJoinMultiSequentialArgs__member_mediatorJoin",
+          "memberFieldName": "mediatorJoin"
+        }
+      ],
+      "constructorArguments": []
+    }
+  ]
+}

package/components/components.jsonld

@@ -0,0 +1,11 @@
+{
+  "@context": [
+    "https://linkedsoftwaredependencies.org/bundles/npm/@comunica/actor-rdf-join-inner-multi-sequential/^2.0.0/components/context.jsonld"
+  ],
+  "@id": "npmd:@comunica/actor-rdf-join-inner-multi-sequential",
+  "@type": "Module",
+  "requireName": "@comunica/actor-rdf-join-inner-multi-sequential",
+  "import": [
+    "carjimse:components/ActorRdfJoinMultiSequential.jsonld"
+  ]
+}

package/components/context.jsonld

@@ -0,0 +1,52 @@
+{
+  "@context": [
+    "https://linkedsoftwaredependencies.org/bundles/npm/componentsjs/^4.0.0/components/context.jsonld",
+    {
+      "npmd": "https://linkedsoftwaredependencies.org/bundles/npm/",
+      "carjimse": "npmd:@comunica/actor-rdf-join-inner-multi-sequential/^2.0.0/",
+      "ActorRdfJoinMultiSequential": {
+        "@id": "carjimse:components/ActorRdfJoinMultiSequential.jsonld#ActorRdfJoinMultiSequential",
+        "@prefix": true,
+        "@context": {
+          "args_mediatorJoin": {
+            "@id": "carjimse:components/ActorRdfJoinMultiSequential.jsonld#ActorRdfJoinMultiSequential_args_mediatorJoin"
+          },
+          "args_mediatorJoinSelectivity": {
+            "@id": "carjimse:components/ActorRdfJoinMultiSequential.jsonld#ActorRdfJoinMultiSequential_args_mediatorJoinSelectivity"
+          },
+          "args_name": {
+            "@id": "carjimse:components/ActorRdfJoinMultiSequential.jsonld#ActorRdfJoinMultiSequential_args_name"
+          },
+          "args_bus": {
+            "@id": "carjimse:components/ActorRdfJoinMultiSequential.jsonld#ActorRdfJoinMultiSequential_args_bus"
+          },
+          "args_beforeActors": {
+            "@id": "carjimse:components/ActorRdfJoinMultiSequential.jsonld#ActorRdfJoinMultiSequential_args_beforeActors",
+            "@container": "@list"
+          },
+          "mediatorJoin": {
+            "@id": "carjimse:components/ActorRdfJoinMultiSequential.jsonld#ActorRdfJoinMultiSequential_args_mediatorJoin"
+          },
+          "mediatorJoinSelectivity": {
+            "@id": "carjimse:components/ActorRdfJoinMultiSequential.jsonld#ActorRdfJoinMultiSequential_args_mediatorJoinSelectivity"
+          },
+          "name": {
+            "@id": "carjimse:components/ActorRdfJoinMultiSequential.jsonld#ActorRdfJoinMultiSequential_args_name"
+          },
+          "bus": {
+            "@id": "carjimse:components/ActorRdfJoinMultiSequential.jsonld#ActorRdfJoinMultiSequential_args_bus"
+          },
+          "beforeActors": {
+            "@id": "carjimse:components/ActorRdfJoinMultiSequential.jsonld#ActorRdfJoinMultiSequential_args_beforeActors",
+            "@container": "@list"
+          }
+        }
+      },
+      "IActorRdfJoinMultiSequentialArgs": {
+        "@id": "carjimse:components/ActorRdfJoinMultiSequential.jsonld#IActorRdfJoinMultiSequentialArgs",
+        "@prefix": true,
+        "@context": {}
+      }
+    }
+  ]
+}

package/lib/ActorRdfJoinMultiSequential.d.ts

@@ -0,0 +1,22 @@
+import type { IActionRdfJoin, IActorRdfJoinOutputInner, IActorRdfJoinArgs, MediatorRdfJoin } from '@comunica/bus-rdf-join';
+import { ActorRdfJoin } from '@comunica/bus-rdf-join';
+import type { IMediatorTypeJoinCoefficients } from '@comunica/mediatortype-join-coefficients';
+import type { MetadataBindings } from '@comunica/types';
+import { Factory } from 'sparqlalgebrajs';
+/**
+ * A Multi Sequential RDF Join Actor.
+ * It accepts 3 or more streams, joins the first two, and joins the result with the remaining streams.
+ */
+export declare class ActorRdfJoinMultiSequential extends ActorRdfJoin {
+    readonly mediatorJoin: MediatorRdfJoin;
+    static readonly FACTORY: Factory;
+    constructor(args: IActorRdfJoinMultiSequentialArgs);
+    protected getOutput(action: IActionRdfJoin): Promise<IActorRdfJoinOutputInner>;
+    protected getJoinCoefficients(action: IActionRdfJoin, metadatas: MetadataBindings[]): Promise<IMediatorTypeJoinCoefficients>;
+}
+export interface IActorRdfJoinMultiSequentialArgs extends IActorRdfJoinArgs {
+    /**
+     * A mediator for joining Bindings streams
+     */
+    mediatorJoin: MediatorRdfJoin;
+}

package/lib/ActorRdfJoinMultiSequential.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ActorRdfJoinMultiSequential = void 0;
+const bus_query_operation_1 = require("@comunica/bus-query-operation");
+const bus_rdf_join_1 = require("@comunica/bus-rdf-join");
+const sparqlalgebrajs_1 = require("sparqlalgebrajs");
+/**
+ * A Multi Sequential RDF Join Actor.
+ * It accepts 3 or more streams, joins the first two, and joins the result with the remaining streams.
+ */
+class ActorRdfJoinMultiSequential extends bus_rdf_join_1.ActorRdfJoin {
+    constructor(args) {
+        super(args, {
+            logicalType: 'inner',
+            physicalName: 'multi-sequential',
+            limitEntries: 3,
+            limitEntriesMin: true,
+        });
+    }
+    async getOutput(action) {
+        // Join the two first streams, and then join the result with the remaining streams
+        const firstEntry = {
+            output: bus_query_operation_1.ActorQueryOperation.getSafeBindings(await this.mediatorJoin
+                .mediate({ type: action.type, entries: [action.entries[0], action.entries[1]], context: action.context })),
+            operation: ActorRdfJoinMultiSequential.FACTORY
+                .createJoin([action.entries[0].operation, action.entries[1].operation], false),
+        };
+        const remainingEntries = action.entries.slice(1);
+        remainingEntries[0] = firstEntry;
+        return {
+            result: await this.mediatorJoin.mediate({
+                type: action.type,
+                entries: remainingEntries,
+                context: action.context,
+            }),
+        };
+    }
+    async getJoinCoefficients(action, metadatas) {
+        const requestInitialTimes = bus_rdf_join_1.ActorRdfJoin.getRequestInitialTimes(metadatas);
+        const requestItemTimes = bus_rdf_join_1.ActorRdfJoin.getRequestItemTimes(metadatas);
+        return {
+            iterations: metadatas[0].cardinality.value * metadatas[1].cardinality.value *
+                metadatas.slice(2).reduce((acc, metadata) => acc * metadata.cardinality.value, 1),
+            persistedItems: 0,
+            blockingItems: 0,
+            requestTime: requestInitialTimes[0] + metadatas[0].cardinality.value * requestItemTimes[0] +
+                requestInitialTimes[1] + metadatas[1].cardinality.value * requestItemTimes[1] +
+                metadatas.slice(2)
+                    .reduce((sum, metadata, i) => sum + requestInitialTimes[i] +
+                    metadata.cardinality.value * requestItemTimes[i], 0),
+        };
+    }
+}
+exports.ActorRdfJoinMultiSequential = ActorRdfJoinMultiSequential;
+ActorRdfJoinMultiSequential.FACTORY = new sparqlalgebrajs_1.Factory();
+//# sourceMappingURL=ActorRdfJoinMultiSequential.js.map

package/lib/index.d.ts

@@ -0,0 +1 @@
+export * from './ActorRdfJoinMultiSequential';

package/lib/index.js

@@ -0,0 +1,14 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./ActorRdfJoinMultiSequential"), exports);
+//# sourceMappingURL=index.js.map

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@comunica/actor-rdf-join-inner-multi-sequential",
+  "version": "2.0.1-alpha.5.0",
+  "description": "A multi-sequential rdf-join actor",
+  "lsd:module": true,
+  "main": "lib/index.js",
+  "typings": "lib/index",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/comunica/comunica.git",
+    "directory": "packages/actor-rdf-join-inner-multi-sequential"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "comunica",
+    "actor",
+    "rdf-join",
+    "multi-sequential"
+  ],
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/comunica/comunica/issues"
+  },
+  "homepage": "https://comunica.dev/",
+  "files": [
+    "components",
+    "lib/**/*.d.ts",
+    "lib/**/*.js"
+  ],
+  "dependencies": {
+    "@comunica/bus-query-operation": "2.0.1-alpha.5.0",
+    "@comunica/bus-rdf-join": "2.0.1-alpha.5.0",
+    "@comunica/core": "2.0.1-alpha.5.0",
+    "@comunica/mediatortype-join-coefficients": "2.0.1-alpha.5.0",
+    "@comunica/types": "2.0.1-alpha.5.0",
+    "sparqlalgebrajs": "^4.0.0"
+  },
+  "scripts": {
+    "build": "npm run build:ts && npm run build:components",
+    "build:ts": "node \"../../node_modules/typescript/bin/tsc\"",
+    "build:components": "componentsjs-generator"
+  },
+  "gitHead": "e2ae2e9e924bf0656df60cc99774f7e560d47695"
+}