Fix put_rdfmap (metafacture-core#415)

- add tests
- add to README

Author: dr0i

README.md

@@ -200,6 +200,17 @@ Options:
 - `key_column`: Defines the column to be used for keys. Uses zero index. (Default: `0`)
 - `value_column`: Defines the column to be used for values. Uses zero index. (Default: `1`)
 
+##### `put_rdfmap`
+
+Defines an external RDF map for lookup from a file or an HTTP(S) resource.
+As the RDF map is reducing RDF triples to a key/value map it is mandatory to set the target.
+The targeted RDF property can optional be bound by an RDF language tag.
+
+```perl
+put_rdfmap("<rdfResource>", "<rdfMapName>", target: "<rdfProperty>")
+put_rdfmap("<rdfResource>", "<rdfMapName>", target: "<rdfProperty>, target_language: "<rdfLanguageTag>"")
+```
+
 ##### `put_map`
 
 Defines an internal map for [lookup](#lookup) from key/value pairs.
@@ -608,12 +619,15 @@ lookup("path.to.field", "map-name", print_unknown: "true", destination: "unknown
 
 ##### `lookup_rdf`
 
-Looks up matching values in an RDF resource and replaces the field value with this match. A file as well as an HTTP(S) resource can be used.
+Looks up matching values in an RDF resource and replaces the field value with a match defined by a targeted RDF property. External files or HTTP(S) resources as well as internal RDF maps can be used.
+The targeted RDF property can optional be bound by an RDF language tag.
 
 ```perl
-lookup_rdf("<sourceField>", "<rdfResource>", target: "<rdfProperty>")
-lookup_rdf("<sourceField>", "<rdfResource>", target: "<rdfProperty>", target_language: "<rdfLanguageTag>")
-lookup_rdf("<sourceField>", "<rdfResource>", target: "<rdfProperty>", __default: "NA")
+lookup_rdf("<sourceField>", "<rdfFile>", target: "<rdfProperty>")
+lookup_rdf("<sourceField>", "<rdfHttpUri>", target: "<rdfProperty>")
+lookup_rdf("<sourceField>", "<rdfMapName>", target: "<rdfProperty>")
+lookup_rdf("<sourceField>", "<rdfMapName>", target: "<rdfProperty>", target_language: "<rdfLanguageTag>")
+lookup_rdf("<sourceField>", "<rdfMapName>", target: "<rdfProperty>", __default: "NA")
 ```
 
 ##### `prepend`

metafix/src/main/java/org/metafacture/metafix/FixMethod.java

@@ -96,13 +96,14 @@ public void apply(final Metafix metafix, final Record record, final List<String>
     put_rdfmap {
         @Override
         public void apply(final Metafix metafix, final Record record, final List<String> params, final Map<String, String> options) {
-            final String fileName = params.get(0);
+            final String resourceName = params.get(0);
             final RdfMap rdf = new RdfMap();
-            rdf.setFile(metafix.resolvePath(fileName));
-            withOption(options, "target", rdf::setTarget);
-            withOption(options, "target_language", rdf::setTargetLanguage);
+            rdf.setResource(metafix.resolvePath(resourceName));
+            withOption(options, RdfMap.TARGET, rdf::setTarget);
+            withOption(options, RdfMap.TARGET_LANGUAGE, rdf::setTargetLanguage);
             withOption(options, Maps.DEFAULT_MAP_KEY, rdf::setDefault);
-            metafix.putMap(params.size() > 1 ? params.get(1) : fileName, rdf);
+            final String mapName = (params.size() > 1 ? params.get(1) : params.get(0)) + options.get(RdfMap.TARGET) + options.getOrDefault(RdfMap.TARGET_LANGUAGE, "");
+            metafix.putMap(mapName, rdf);
         }
     },
     put_var {
@@ -680,15 +681,20 @@ private static Map<String, String> getMap(final Metafix metafix, final Record re
             map = options;
         }
         else {
-            final String mapName = params.get(1);
-
+            final String mapName;
+            if (kindOfMap.equals(KIND_OF_FILEMAP)) {
+                mapName = params.get(1);
+            }
+            else {
+                mapName = params.get(1) + options.get(RdfMap.TARGET) + options.getOrDefault(RdfMap.TARGET_LANGUAGE, "");
+            }
             if (!metafix.getMapNames().contains(mapName)) {
                 if (mapName.contains(".") || mapName.contains(File.separator)) {
                     if (kindOfMap.equals(KIND_OF_FILEMAP)) {
                         put_filemap.apply(metafix, record, Arrays.asList(mapName), options);
                     }
                     if (kindOfMap.equals(KIND_OF_RDFMAP)) {
-                        put_rdfmap.apply(metafix, record, Arrays.asList(mapName), options);
+                        put_rdfmap.apply(metafix, record, Arrays.asList(params.get(1)), options);
                     }
                 }
                 else {

metafix/src/main/java/org/metafacture/metafix/maps/RdfMap.java

@@ -56,30 +56,30 @@
  * @see org.metafacture.metamorph.maps.FileMap
  */
 public final class RdfMap extends AbstractReadOnlyMap<String, String> {
-    private static String targetLanguage = "";
-    private static String target;
-    private static final Logger LOG = LoggerFactory.getLogger(RdfMap.class);
+    public static final String TARGET = "target";
+    public static final String TARGET_LANGUAGE = "target_language";
     private static final int MAX_REDIRECTIONS = 10;
     private static final int MIN_HTTP_STATUS_CODE = 299;
     private static final int MAX_HTTP_STATUS_CODE = 400;
-
+    private static final Logger LOG = LoggerFactory.getLogger(RdfMap.class);
     private Model model;
     private boolean isUninitialized = true;
     private final ArrayList<String> filenames = new ArrayList<>();
     private final Map<String, String> map = new HashMap<>();
+    private String targetLanguage = "";
+    private String target;
 
     /**
      * Creates an instance of {@link RdfMap}.
      */
     public RdfMap() {
         targetLanguage = "";
+        setDefault(Maps.DEFAULT_MAP_KEY);
+
     }
 
     private void init() {
         loadFiles();
-        if (!map.containsKey(Maps.DEFAULT_MAP_KEY)) {
-            setDefault(Maps.DEFAULT_MAP_KEY);
-        }
         if (!target.toLowerCase().startsWith("http")) {
             final String[] nsPrefixAndProperty = target.split(":");
             target = nsPrefixAndProperty.length == 2 ? model.getNsPrefixURI(nsPrefixAndProperty[0]) + nsPrefixAndProperty[1] : nsPrefixAndProperty[0];
@@ -101,7 +101,7 @@ public void setFiles(final String files) {
      *
      * @param file the file
      */
-    public void setFile(final String file) {
+    public void setResource(final String file) {
         Collections.addAll(filenames, file);
     }
 
@@ -147,20 +147,20 @@ private void loadFile(final String file) {
      */
     @Override
     public String get(final Object key) {
-        if (isUninitialized) {
-            init();
-        }
         String ret;
         if (map.containsKey(key.toString())) {
             ret = map.get(key.toString());
         }
         else {
+            if (isUninitialized) {
+                init();
+            }
             final Resource resource = ResourceFactory.createResource(key.toString());
             final Property targetProperty = ResourceFactory.createProperty(target);
             try {
                 //first try to get LITERAL using SUBJECT and PROPERTY
-                if (!RdfMap.targetLanguage.isEmpty()) {
-                    ret = model.getRequiredProperty(resource, targetProperty, RdfMap.targetLanguage).getString();
+                if (!targetLanguage.isEmpty()) {
+                    ret = model.getRequiredProperty(resource, targetProperty, targetLanguage).getString();
                 }
                 else {
                     ret = model.getRequiredProperty(resource, targetProperty).getString();
@@ -174,7 +174,7 @@ public String get(final Object key) {
                     ret = getLiteralOfPredicateUsingOtherPredicate(key, targetProperty);
                 }
                 else {
-                    LOG.info("Could not lookup:'" + key + "@" + (RdfMap.targetLanguage.isEmpty() ? RdfMap.targetLanguage : "") + " for " + target + "'. Going with default value.");
+                    LOG.info("Could not lookup:'" + key  + (targetLanguage.isEmpty() ? "@" + targetLanguage : "") + " for " + target + "'. Going with default value.");
                 }
             }
             map.put(key.toString(), ret);
@@ -194,7 +194,7 @@ private String getLiteralOfPredicateUsingOtherPredicate(final Object key, final
                 final StmtIterator iterProp = resource.listProperties(targetProperty);
                 while (iterProp.hasNext()) {
                     stmt = iterProp.nextStatement();
-                    if (stmt.getLanguage().equals(RdfMap.targetLanguage) && !stmt.getString().equals(key)) {
+                    if (stmt.getLanguage().equals(targetLanguage) && !stmt.getString().equals(key)) {
                         ret = stmt.getString();
                     }
                 }
@@ -210,8 +210,8 @@ private String getSubjectUsingPropertyAndLiteral(final Object key, final Propert
         while (iter.hasNext()) {
             resource = iter.nextResource();
             if (resource.getProperty(targetProperty).getString().equals(key.toString())) {
-                if (!RdfMap.targetLanguage.isEmpty()) {
-                    if (resource.getProperty(targetProperty).getLanguage().equals(RdfMap.targetLanguage)) {
+                if (!this.targetLanguage.isEmpty()) {
+                    if (resource.getProperty(targetProperty).getLanguage().equals(targetLanguage)) {
                         ret = resource.getURI();
                     }
                 }
@@ -223,6 +223,16 @@ private String getSubjectUsingPropertyAndLiteral(final Object key, final Propert
         return ret;
     }
 
+    /**
+     * Gets the language of the target Property which is queried in the RDF. Valid values are defined by BCP47.
+     * <br>
+     *
+     * @return the targeted language
+     */
+    public String getTargetLanguage() {
+        return targetLanguage;
+    }
+
     /**
      * Sets the language of the target Property which is queried in the RDF. Valid values are defined by BCP47.
      * <br>
@@ -231,7 +241,17 @@ private String getSubjectUsingPropertyAndLiteral(final Object key, final Propert
      * @param targetLanguage the language of the target Property to be queried
      */
     public void setTargetLanguage(final String targetLanguage) {
-        RdfMap.targetLanguage = targetLanguage;
+        this.targetLanguage = targetLanguage;
+    }
+
+    /**
+     * Gets the target Property which is queried in the RDF. Namespaces are allowed.
+     * <br>
+     *
+     * @return the target Property to be queried
+     */
+    public String getTarget() {
+        return target;
     }
 
     /**
@@ -242,7 +262,7 @@ public void setTargetLanguage(final String targetLanguage) {
      * @param target the Property to be queried
      */
     public void setTarget(final String target) {
-        RdfMap.target = target;
+        this.target = target;
     }
 
     /**

metafix/src/test/java/org/metafacture/metafix/MetafixLookupTest.java

@@ -958,6 +958,30 @@ public void shouldPrintUnknownToFileWithoutAppend() throws IOException {
         MetafixTestHelpers.assertTempFile("you\ntoo\n", p -> shouldPrintUnknown(", destination: '" + p + "', append: 'false'", null, ""));
     }
 
+    @Test
+    public void shouldLookupInSeparateExternalRdfFileMapWithName() {
+        assertRdfMap(
+            "put_rdfmap('" + RDF_MAP + "', 'testMapSkosNotation', target: 'skos:notation')",
+            "lookup_rdf('notation', 'testMapSkosNotation', target: 'skos:notation')"
+        );
+    }
+
+    @Test
+    public void shouldLookupInSeparateExternalRdfFileMapWithDifferentTargets() {
+        assertRdfMapWithDifferentTargets(
+            "put_rdfmap('" + RDF_MAP + "', 'testRdfMapSkosNotation', target: 'skos:notation')",
+            "put_rdfmap('" + RDF_MAP + "', 'testRdfMapCreated', target: 'created')",
+            "lookup_rdf('notation', 'testRdfMapSkosNotation', target: 'skos:notation')",
+            "lookup_rdf('created', 'testRdfMapCreated', target: 'created')");
+    }
+
+    @Test
+    public void shouldLookupInExternalRdfWithDifferentTargets() {
+        assertRdfMapWithDifferentTargets(
+            "lookup_rdf('notation', '" + RDF_MAP + "', target: 'skos:notation')",
+            "lookup_rdf('created', '" + RDF_MAP + "', target: 'created')");
+    }
+
     @Test
     public void shouldLookupInExternalRdfUseDefinedDefaultValueIfNotFound() {
         MetafixTestHelpers.assertFix(streamReceiver, Arrays.asList(
@@ -996,19 +1020,8 @@ public void shouldLookupInExternalRdfUseDefaultValueIfNotFound() {
 
     @Test
     public void shouldLookupInExternalRdfMapGetObjectOfSubjectWithTargetedPredicate() {
-        MetafixTestHelpers.assertFix(streamReceiver, Arrays.asList(
-                "lookup_rdf('notation', '" + RDF_MAP + "', target: 'skos:notation')"
-            ),
-            i -> {
-                i.startRecord("1");
-                i.literal("notation", "https://w3id.org/kim/hochschulfaechersystematik/n4");
-                i.endRecord();
-            },
-            o -> {
-                o.get().startRecord("1");
-                o.get().literal("notation", "4");
-                o.get().endRecord();
-            }
+        assertRdfMap(
+            "lookup_rdf('notation', '" + RDF_MAP + "', target: 'skos:notation')"
         );
     }
 
@@ -1114,4 +1127,36 @@ private void assertMap(final String... fixDef) {
         );
     }
 
+    private void assertRdfMap(final String... fixDef) {
+        MetafixTestHelpers.assertFix(streamReceiver, Arrays.asList(fixDef),
+            i -> {
+                i.startRecord("1");
+                i.literal("notation", "https://w3id.org/kim/hochschulfaechersystematik/n4");
+                i.endRecord();
+            },
+            o -> {
+                o.get().startRecord("1");
+                o.get().literal("notation", "4");
+                o.get().endRecord();
+            }
+        );
+    }
+
+    private void assertRdfMapWithDifferentTargets(final String... fixDef) {
+        MetafixTestHelpers.assertFix(streamReceiver, Arrays.asList(fixDef),
+            i -> {
+                i.startRecord("1");
+                i.literal("notation", "https://w3id.org/kim/hochschulfaechersystematik/n4");
+                i.literal("created", "https://w3id.org/kim/hochschulfaechersystematik/n4");
+                i.endRecord();
+            },
+            o -> {
+                o.get().startRecord("1");
+                o.get().literal("notation", "4");
+                o.get().literal("created", "__default");
+                o.get().endRecord();
+            }
+        );
+    }
+
 }