issue #163: PICA: general changes

pkiraly · Aug 31, 2022 · 4f89f64 · 4f89f64
1 parent b43a7d9
commit 4f89f64
Show file tree

Hide file tree

Showing 94 changed files with 460 additions and 338 deletions.
diff --git a/src/main/java/de/gwdg/metadataqa/marc/MarcFactory.java b/src/main/java/de/gwdg/metadataqa/marc/MarcFactory.java
@@ -13,7 +13,9 @@
 import de.gwdg.metadataqa.marc.dao.Control008;
 import de.gwdg.metadataqa.marc.dao.DataField;
 import de.gwdg.metadataqa.marc.dao.Leader;
-import de.gwdg.metadataqa.marc.dao.MarcRecord;
+import de.gwdg.metadataqa.marc.dao.record.Marc21Record;
+import de.gwdg.metadataqa.marc.dao.record.BibliographicRecord;
+import de.gwdg.metadataqa.marc.dao.record.PicaRecord;
 import de.gwdg.metadataqa.marc.definition.bibliographic.SchemaType;
 import de.gwdg.metadataqa.marc.definition.structure.DataFieldDefinition;
 import de.gwdg.metadataqa.marc.definition.MarcVersion;
@@ -28,7 +30,6 @@
 import de.gwdg.metadataqa.marc.utils.pica.PicaFieldDefinition;
 import de.gwdg.metadataqa.marc.utils.pica.PicaLine;
 import de.gwdg.metadataqa.marc.utils.pica.PicaSchemaManager;
-import de.gwdg.metadataqa.marc.utils.pica.PicaSchemaReader;
 import de.gwdg.metadataqa.marc.utils.pica.PicaSubfield;
 import net.minidev.json.JSONArray;
 import org.marc4j.marc.ControlField;
@@ -57,12 +58,12 @@ private MarcFactory() {
     throw new IllegalStateException("This is a utility class, can not be instantiated");
   }
 
-  public static MarcRecord create(JsonPathCache cache) {
+  public static BibliographicRecord create(JsonPathCache cache) {
     return create(cache, MarcVersion.MARC21);
   }
 
-  public static MarcRecord create(JsonPathCache cache, MarcVersion version) {
-    var marcRecord = new MarcRecord();
+  public static BibliographicRecord create(JsonPathCache cache, MarcVersion version) {
+    var marcRecord = new Marc21Record();
     for (JsonBranch branch : schema.getPaths()) {
       if (branch.getParent() != null)
         continue;
@@ -109,23 +110,23 @@ public static MarcRecord create(JsonPathCache cache, MarcVersion version) {
     return marcRecord;
   }
 
-  public static MarcRecord createFromMarc4j(Record marc4jRecord) {
+  public static BibliographicRecord createFromMarc4j(Record marc4jRecord) {
     return createFromMarc4j(marc4jRecord, null, MarcVersion.MARC21);
   }
 
-  public static MarcRecord createFromMarc4j(Record marc4jRecord,
-                                            Leader.Type defaultType) {
+  public static BibliographicRecord createFromMarc4j(Record marc4jRecord,
+                                                     Leader.Type defaultType) {
     return createFromMarc4j(marc4jRecord, defaultType, MarcVersion.MARC21);
   }
 
-  public static MarcRecord createFromMarc4j(Record marc4jRecord,
-                                            MarcVersion marcVersion) {
+  public static BibliographicRecord createFromMarc4j(Record marc4jRecord,
+                                                     MarcVersion marcVersion) {
     return createFromMarc4j(marc4jRecord, null, marcVersion);
   }
 
-  public static MarcRecord createFromMarc4j(Record marc4jRecord,
-                                            Leader.Type defaultType,
-                                            MarcVersion marcVersion) {
+  public static BibliographicRecord createFromMarc4j(Record marc4jRecord,
+                                                     Leader.Type defaultType,
+                                                     MarcVersion marcVersion) {
     return createFromMarc4j(marc4jRecord, defaultType, marcVersion, null);
   }
 
@@ -137,11 +138,11 @@ public static MarcRecord createFromMarc4j(Record marc4jRecord,
    * @param replecementInControlFields A ^ or # character which sould be replaced with space in control fields
    * @return
    */
-  public static MarcRecord createFromMarc4j(Record marc4jRecord,
-                                            Leader.Type defaultType,
-                                            MarcVersion marcVersion,
-                                            String replecementInControlFields) {
-    var marcRecord = new MarcRecord();
+  public static BibliographicRecord createFromMarc4j(Record marc4jRecord,
+                                                     Leader.Type defaultType,
+                                                     MarcVersion marcVersion,
+                                                     String replecementInControlFields) {
+    var marcRecord = new Marc21Record();
 
     if (marc4jRecord.getLeader() != null) {
       String data = marc4jRecord.getLeader().marshal();
@@ -166,8 +167,8 @@ public static MarcRecord createFromMarc4j(Record marc4jRecord,
     return marcRecord;
   }
 
-  public static MarcRecord createPicaFromMarc4j(Record marc4jRecord, PicaSchemaManager picaSchemaManager) {
-    var marcRecord = new MarcRecord();
+  public static BibliographicRecord createPicaFromMarc4j(Record marc4jRecord, PicaSchemaManager picaSchemaManager) {
+    var marcRecord = new PicaRecord();
     marcRecord.setSchemaType(SchemaType.PICA);
 
     importMarc4jControlFields(marc4jRecord, marcRecord, null);
@@ -178,7 +179,7 @@ public static MarcRecord createPicaFromMarc4j(Record marc4jRecord, PicaSchemaMan
   }
 
   private static void importMarc4jControlFields(Record marc4jRecord,
-                                                MarcRecord marcRecord,
+                                                BibliographicRecord marcRecord,
                                                 String replecementInControlFields) {
     for (ControlField controlField : marc4jRecord.getControlFields()) {
       String data = controlField.getData();
@@ -208,7 +209,7 @@ private static boolean isFixable(String tag) {
   }
 
   private static void importMarc4jDataFields(Record marc4jRecord,
-                                             MarcRecord marcRecord,
+                                             BibliographicRecord marcRecord,
                                              MarcVersion marcVersion) {
     for (org.marc4j.marc.DataField dataField : marc4jRecord.getDataFields()) {
       var definition = getDataFieldDefinition(dataField, marcVersion);
@@ -221,7 +222,7 @@ private static void importMarc4jDataFields(Record marc4jRecord,
   }
 
   private static void importMarc4jDataFields(Record marc4jRecord,
-                                             MarcRecord marcRecord,
+                                             BibliographicRecord marcRecord,
                                              PicaSchemaManager schema) {
     for (org.marc4j.marc.DataField dataField : marc4jRecord.getDataFields()) {
       var definition = schema.lookup(dataField.getTag());
@@ -325,23 +326,23 @@ private static String extractFirst(JsonPathCache cache, JsonBranch branch) {
     return null;
   }
 
-  public static MarcRecord createFromFormattedText(String marcRecordAsText) {
+  public static BibliographicRecord createFromFormattedText(String marcRecordAsText) {
     return createFromFormattedText(Arrays.asList(marcRecordAsText.split("\n")));
   }
 
-  public static MarcRecord createFromFormattedText(String marcRecordAsText, MarcVersion marcVersion) {
+  public static BibliographicRecord createFromFormattedText(String marcRecordAsText, MarcVersion marcVersion) {
     return createFromFormattedText(Arrays.asList(marcRecordAsText.split("\n")), marcVersion);
   }
 
-  public static MarcRecord createFromFormattedText(List<String> lines) {
+  public static BibliographicRecord createFromFormattedText(List<String> lines) {
     return createFromFormattedText(lines, MarcVersion.MARC21);
   }
 
-  public static MarcRecord createFromFormattedText(List<String> lines, MarcVersion marcVersion) {
+  public static BibliographicRecord createFromFormattedText(List<String> lines, MarcVersion marcVersion) {
     if (marcVersion == null)
       marcVersion = MarcVersion.MARC21;
 
-    var marcRecord = new MarcRecord();
+    var marcRecord = new Marc21Record();
     for (String line : lines) {
       if (line.startsWith("LEADER ")) {
         marcRecord.setLeader(line.replace("LEADER ", ""), marcVersion);
@@ -354,12 +355,12 @@ public static MarcRecord createFromFormattedText(List<String> lines, MarcVersion
     return marcRecord;
   }
 
-  public static MarcRecord createFromAlephseq(List<AlephseqLine> lines,
-                                              MarcVersion marcVersion) {
+  public static BibliographicRecord createFromAlephseq(List<AlephseqLine> lines,
+                                                       MarcVersion marcVersion) {
     if (marcVersion == null)
       marcVersion = MarcVersion.MARC21;
 
-    var marcRecord = new MarcRecord();
+    var marcRecord = new Marc21Record();
     for (AlephseqLine line : lines) {
       if (line.isLeader()) {
         marcRecord.setLeader(line.getContent());

diff --git a/src/main/java/de/gwdg/metadataqa/marc/MarcSubfield.java b/src/main/java/de/gwdg/metadataqa/marc/MarcSubfield.java
@@ -1,7 +1,7 @@
 package de.gwdg.metadataqa.marc;
 
 import de.gwdg.metadataqa.marc.dao.DataField;
-import de.gwdg.metadataqa.marc.dao.MarcRecord;
+import de.gwdg.metadataqa.marc.dao.record.BibliographicRecord;
 import de.gwdg.metadataqa.marc.definition.*;
 import de.gwdg.metadataqa.marc.definition.general.Linkage;
 import de.gwdg.metadataqa.marc.definition.general.parser.ParserException;
@@ -23,7 +23,7 @@ public class MarcSubfield implements Validatable, Serializable {
 
   private static final Logger logger = Logger.getLogger(MarcSubfield.class.getCanonicalName());
 
-  private MarcRecord marcRecord;
+  private BibliographicRecord marcRecord;
   private DataField field;
   private SubfieldDefinition definition;
   private final String code;
@@ -93,11 +93,11 @@ public void setDefinition(SubfieldDefinition definition) {
     this.definition = definition;
   }
 
-  public MarcRecord getMarcRecord() {
+  public BibliographicRecord getMarcRecord() {
     return marcRecord;
   }
 
-  public void setMarcRecord(MarcRecord marcRecord) {
+  public void setMarcRecord(BibliographicRecord marcRecord) {
     this.marcRecord = marcRecord;
   }
 

diff --git a/src/main/java/de/gwdg/metadataqa/marc/analysis/AuthorithyAnalyzer.java b/src/main/java/de/gwdg/metadataqa/marc/analysis/AuthorithyAnalyzer.java
@@ -1,7 +1,7 @@
 package de.gwdg.metadataqa.marc.analysis;
 
 import de.gwdg.metadataqa.marc.dao.DataField;
-import de.gwdg.metadataqa.marc.dao.MarcRecord;
+import de.gwdg.metadataqa.marc.dao.record.BibliographicRecord;
 import de.gwdg.metadataqa.marc.MarcSubfield;
 import de.gwdg.metadataqa.marc.cli.utils.Schema;
 import de.gwdg.metadataqa.marc.definition.SourceSpecificationType;
@@ -28,10 +28,10 @@ public class AuthorithyAnalyzer {
   );
   private static final Pattern NUMERIC = Pattern.compile("^\\d");
 
-  private MarcRecord marcRecord;
+  private BibliographicRecord marcRecord;
   private AuthorityStatistics authoritiesStatistics;
 
-  public AuthorithyAnalyzer(MarcRecord marcRecord,
+  public AuthorithyAnalyzer(BibliographicRecord marcRecord,
                             AuthorityStatistics authoritiesStatistics) {
     this.marcRecord = marcRecord;
     this.authoritiesStatistics = authoritiesStatistics;

diff --git a/src/main/java/de/gwdg/metadataqa/marc/analysis/BLClassifier.java b/src/main/java/de/gwdg/metadataqa/marc/analysis/BLClassifier.java
@@ -4,7 +4,7 @@
 import de.gwdg.metadataqa.marc.analysis.bl.UseCase;
 import de.gwdg.metadataqa.marc.analysis.bl.Element;
 import de.gwdg.metadataqa.marc.dao.DataField;
-import de.gwdg.metadataqa.marc.dao.MarcRecord;
+import de.gwdg.metadataqa.marc.dao.record.BibliographicRecord;
 
 import java.util.ArrayList;
 import java.util.List;
@@ -35,7 +35,7 @@ else if (useCase.getBand().equals(EFFECTIVE))
   }
 
   @Override
-  public String classify(MarcRecord marcRecord) {
+  public String classify(BibliographicRecord marcRecord) {
     String level = DEFICIENT.name();
 
     for (UseCase useCase : basicUseCases)
@@ -55,7 +55,7 @@ public String classify(MarcRecord marcRecord) {
     return level;
   }
 
-  private boolean satisfy(MarcRecord marcRecord, UseCase useCase) {
+  private boolean satisfy(BibliographicRecord marcRecord, UseCase useCase) {
     for (Element element : useCase.getElements()) {
       if (marcRecord.hasDatafield(element.getTag())) {
         if (element.getSubfield() == null) {

diff --git a/src/main/java/de/gwdg/metadataqa/marc/analysis/ClassificationAnalyzer.java b/src/main/java/de/gwdg/metadataqa/marc/analysis/ClassificationAnalyzer.java
@@ -2,7 +2,7 @@
 
 import de.gwdg.metadataqa.marc.Utils;
 import de.gwdg.metadataqa.marc.dao.DataField;
-import de.gwdg.metadataqa.marc.dao.MarcRecord;
+import de.gwdg.metadataqa.marc.dao.record.BibliographicRecord;
 import de.gwdg.metadataqa.marc.MarcSubfield;
 import de.gwdg.metadataqa.marc.cli.utils.Schema;
 import de.gwdg.metadataqa.marc.definition.bibliographic.SchemaType;
@@ -32,7 +32,7 @@ public class ClassificationAnalyzer {
   private static final Pattern NUMERIC = Pattern.compile("^\\d");
 
   private final ClassificationStatistics statistics;
-  private MarcRecord marcRecord;
+  private BibliographicRecord marcRecord;
   private List<Schema> schemasInRecord;
 
   private static final List<String> fieldsWithIndicator1AndSubfield2 = Arrays.asList(
@@ -87,7 +87,7 @@ public class ClassificationAnalyzer {
     new FieldWithScheme("045R", "Regensburger Verbundklassifikation")
   );
 
-  public ClassificationAnalyzer(MarcRecord marcRecord, ClassificationStatistics statistics) {
+  public ClassificationAnalyzer(BibliographicRecord marcRecord, ClassificationStatistics statistics) {
     this.marcRecord = marcRecord;
     this.statistics = statistics;
   }
@@ -180,7 +180,7 @@ private int processFieldsWithIndicator1AndSubfield2(int total) {
     return total;
   }
 
-  private int processFieldWithScheme(MarcRecord marcRecord,
+  private int processFieldWithScheme(BibliographicRecord marcRecord,
                                      FieldWithScheme fieldEntry) {
     var count = 0;
     final String tag = fieldEntry.getTag();
@@ -222,7 +222,7 @@ private int processFieldWithScheme(MarcRecord marcRecord,
     return count;
   }
 
-  private int processFieldWithSchemePica(MarcRecord marcRecord,
+  private int processFieldWithSchemePica(BibliographicRecord marcRecord,
                                          FieldWithScheme fieldEntry) {
     var count = 0;
     final String tag = fieldEntry.getTag();
@@ -269,7 +269,7 @@ private void registerSchemas(List<Schema> schemas) {
     schemasInRecord.addAll(uniqSchemas);
   }
 
-  private int processFieldWithIndicator1AndSubfield2(MarcRecord marcRecord, String tag) {
+  private int processFieldWithIndicator1AndSubfield2(BibliographicRecord marcRecord, String tag) {
     var count = 0;
     if (!marcRecord.hasDatafield(tag))
       return count;
@@ -302,7 +302,7 @@ private int processFieldWithIndicator1AndSubfield2(MarcRecord marcRecord, String
     return count;
   }
 
-  private int processFieldWithIndicator2AndSubfield2(MarcRecord marcRecord, String tag) {
+  private int processFieldWithIndicator2AndSubfield2(BibliographicRecord marcRecord, String tag) {
     var count = 0;
     if (!marcRecord.hasDatafield(tag))
       return count;
@@ -333,7 +333,7 @@ private int processFieldWithIndicator2AndSubfield2(MarcRecord marcRecord, String
     return count;
   }
 
-  private int processFieldWithSubfield2(MarcRecord marcRecord, String tag) {
+  private int processFieldWithSubfield2(BibliographicRecord marcRecord, String tag) {
     var count = 0;
     if (!marcRecord.hasDatafield(tag))
       return count;
@@ -351,7 +351,7 @@ private int processFieldWithSubfield2(MarcRecord marcRecord, String tag) {
     return count;
   }
 
-  private int processFieldWithoutSource(MarcRecord marcRecord, String tag) {
+  private int processFieldWithoutSource(BibliographicRecord marcRecord, String tag) {
     var count = 0;
     if (!marcRecord.hasDatafield(tag))
       return count;

diff --git a/src/main/java/de/gwdg/metadataqa/marc/analysis/Classifier.java b/src/main/java/de/gwdg/metadataqa/marc/analysis/Classifier.java
@@ -1,7 +1,7 @@
 package de.gwdg.metadataqa.marc.analysis;
 
-import de.gwdg.metadataqa.marc.dao.MarcRecord;
+import de.gwdg.metadataqa.marc.dao.record.BibliographicRecord;
 
 public interface Classifier {
-  String classify(MarcRecord marcRecord);
+  String classify(BibliographicRecord marcRecord);
 }
diff --git a/src/main/java/de/gwdg/metadataqa/marc/analysis/DataElementCounter.java b/src/main/java/de/gwdg/metadataqa/marc/analysis/DataElementCounter.java
@@ -2,7 +2,7 @@
 
 import de.gwdg.metadataqa.marc.MarcSubfield;
 import de.gwdg.metadataqa.marc.dao.DataField;
-import de.gwdg.metadataqa.marc.dao.MarcRecord;
+import de.gwdg.metadataqa.marc.dao.record.BibliographicRecord;
 import org.apache.commons.io.FileUtils;
 
 import java.io.File;
@@ -45,7 +45,7 @@ public DataElementCounter(String dir, String fileName, Basis basis) {
     this.header = _header;
   }
 
-  public List<Integer> count(MarcRecord marcRecord) {
+  public List<Integer> count(BibliographicRecord marcRecord) {
     List<Integer> counts = new ArrayList<>();
     for (Map.Entry<String, List<DataElement>> entry : tags.entrySet()) {
       List<DataField> instances = marcRecord.getDatafield(entry.getKey());

diff --git a/src/main/java/de/gwdg/metadataqa/marc/analysis/NetworkAnalyzer.java b/src/main/java/de/gwdg/metadataqa/marc/analysis/NetworkAnalyzer.java
@@ -1,16 +1,16 @@
 package de.gwdg.metadataqa.marc.analysis;
 
 import de.gwdg.metadataqa.marc.dao.DataField;
-import de.gwdg.metadataqa.marc.dao.MarcRecord;
+import de.gwdg.metadataqa.marc.dao.record.BibliographicRecord;
 
 import java.util.*;
 
 public class NetworkAnalyzer {
 
-  private final MarcRecord marcRecord;
+  private final BibliographicRecord marcRecord;
   private final Set<DataField> collector;
 
-  public NetworkAnalyzer(MarcRecord marcRecord) {
+  public NetworkAnalyzer(BibliographicRecord marcRecord) {
     this.marcRecord = marcRecord;
     collector = new HashSet<>();
   }