BrBETA_dnet-hadoop/dhp-workflows/dhp-graph-mapper/src/main/java/eu/dnetlib/dhp/oa/graph/raw/OdfToOafMapper.java

package eu.dnetlib.dhp.oa.graph.raw;

import static eu.dnetlib.dhp.oa.graph.raw.common.OafMapperUtils.createOpenaireId;
import static eu.dnetlib.dhp.oa.graph.raw.common.OafMapperUtils.field;
import static eu.dnetlib.dhp.oa.graph.raw.common.OafMapperUtils.structuredProperty;

import eu.dnetlib.dhp.schema.oaf.Author;
import eu.dnetlib.dhp.schema.oaf.DataInfo;
import eu.dnetlib.dhp.schema.oaf.Field;
import eu.dnetlib.dhp.schema.oaf.GeoLocation;
import eu.dnetlib.dhp.schema.oaf.Instance;
import eu.dnetlib.dhp.schema.oaf.KeyValue;
import eu.dnetlib.dhp.schema.oaf.Oaf;
import eu.dnetlib.dhp.schema.oaf.Qualifier;
import eu.dnetlib.dhp.schema.oaf.Relation;
import eu.dnetlib.dhp.schema.oaf.StructuredProperty;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import org.apache.commons.lang3.StringUtils;
import org.dom4j.Document;
import org.dom4j.Node;

public class OdfToOafMapper extends AbstractMdRecordToOafMapper {

  public OdfToOafMapper(final Map<String, String> code2name) {
    super(code2name);
  }

  @Override
  protected List<StructuredProperty> prepareTitles(final Document doc, final DataInfo info) {
    return prepareListStructProps(doc, "//datacite:title", MAIN_TITLE_QUALIFIER, info);
  }

  @Override
  protected List<Author> prepareAuthors(final Document doc, final DataInfo info) {
    final List<Author> res = new ArrayList<>();
    int pos = 1;
    for (final Object o : doc.selectNodes("//datacite:creator")) {
      final Node n = (Node) o;
      final Author author = new Author();
      author.setFullname(n.valueOf("./datacite:creatorName"));
      author.setName(n.valueOf("./datacite:givenName"));
      author.setSurname(n.valueOf("./datacite:familyName"));
      author.setAffiliation(prepareListFields(doc, "./datacite:affiliation", info));
      author.setPid(preparePids(doc, info));
      author.setRank(pos++);
      res.add(author);
    }
    return res;
  }

  private List<StructuredProperty> preparePids(final Document doc, final DataInfo info) {
    final List<StructuredProperty> res = new ArrayList<>();
    for (final Object o : doc.selectNodes("./datacite:nameIdentifier")) {
      res.add(
          structuredProperty(
              ((Node) o).getText(),
              prepareQualifier(
                  (Node) o, "./@nameIdentifierScheme", "dnet:pid_types", "dnet:pid_types"),
              info));
    }
    return res;
  }

  @Override
  protected List<Instance> prepareInstances(
      final Document doc,
      final DataInfo info,
      final KeyValue collectedfrom,
      final KeyValue hostedby) {

    final Instance instance = new Instance();
    instance.setUrl(new ArrayList<>());
    instance.setInstancetype(
        prepareQualifier(
            doc, "//dr:CobjCategory", "dnet:publication_resource", "dnet:publication_resource"));
    instance.setCollectedfrom(collectedfrom);
    instance.setHostedby(hostedby);
    instance.setDateofacceptance(field(doc.valueOf("//oaf:dateAccepted"), info));
    instance.setDistributionlocation(doc.valueOf("//oaf:distributionlocation"));
    instance.setAccessright(
        prepareQualifier(doc, "//oaf:accessrights", "dnet:access_modes", "dnet:access_modes"));
    instance.setLicense(field(doc.valueOf("//oaf:license"), info));
    instance.setRefereed(field(doc.valueOf("//oaf:refereed"), info));
    instance.setProcessingchargeamount(field(doc.valueOf("//oaf:processingchargeamount"), info));
    instance.setProcessingchargecurrency(
        field(doc.valueOf("//oaf:processingchargeamount/@currency"), info));

    for (final Object o :
        doc.selectNodes("//datacite:alternateIdentifier[@alternateIdentifierType='URL']")) {
      instance.getUrl().add(((Node) o).getText().trim());
    }
    for (final Object o : doc.selectNodes("//datacite:identifier[@identifierType='URL']")) {
      instance.getUrl().add(((Node) o).getText().trim());
    }
    for (final Object o :
        doc.selectNodes("//datacite:alternateIdentifier[@alternateIdentifierType='DOI']")) {
      instance.getUrl().add("http://dx.doi.org/" + ((Node) o).getText().trim());
    }
    for (final Object o : doc.selectNodes("//datacite:identifier[@identifierType='DOI']")) {
      instance.getUrl().add("http://dx.doi.org/" + ((Node) o).getText().trim());
    }
    return Arrays.asList(instance);
  }

  @Override
  protected List<Field<String>> prepareSources(final Document doc, final DataInfo info) {
    return new ArrayList<>(); // Not present in ODF ???
  }

  @Override
  protected List<StructuredProperty> prepareRelevantDates(final Document doc, final DataInfo info) {
    final List<StructuredProperty> res = new ArrayList<>();
    for (final Object o : doc.selectNodes("//datacite:date")) {
      final String dateType = ((Node) o).valueOf("@dateType");
      if (StringUtils.isBlank(dateType)
          && !dateType.equalsIgnoreCase("Accepted")
          && !dateType.equalsIgnoreCase("Issued")
          && !dateType.equalsIgnoreCase("Updated")
          && !dateType.equalsIgnoreCase("Available")) {
        res.add(
            structuredProperty(
                ((Node) o).getText(),
                "UNKNOWN",
                "UNKNOWN",
                "dnet:dataCite_date",
                "dnet:dataCite_date",
                info));
      }
    }
    return res;
  }

  @Override
  protected List<Field<String>> prepareCoverages(final Document doc, final DataInfo info) {
    return new ArrayList<>(); // Not present in ODF ???
  }

  @Override
  protected List<Field<String>> prepareContributors(final Document doc, final DataInfo info) {
    return prepareListFields(doc, "//datacite:contributorName", info);
  }

  @Override
  protected List<Field<String>> prepareFormats(final Document doc, final DataInfo info) {
    return prepareListFields(doc, "//datacite:format", info);
  }

  @Override
  protected Field<String> preparePublisher(final Document doc, final DataInfo info) {
    return prepareField(doc, "//datacite:publisher", info);
  }

  @Override
  protected List<Field<String>> prepareDescriptions(final Document doc, final DataInfo info) {
    return prepareListFields(doc, "//datacite:description[@descriptionType='Abstract']", info);
  }

  @Override
  protected List<StructuredProperty> prepareSubjects(final Document doc, final DataInfo info) {
    return prepareListStructProps(doc, "//datacite:subject", info);
  }

  @Override
  protected Qualifier prepareLanguages(final Document doc) {
    return prepareQualifier(doc, "//datacite:language", "dnet:languages", "dnet:languages");
  }

  @Override
  protected List<Field<String>> prepareOtherResearchProductTools(
      final Document doc, final DataInfo info) {
    return new ArrayList<>(); // Not present in ODF ???
  }

  @Override
  protected List<Field<String>> prepareOtherResearchProductContactGroups(
      final Document doc, final DataInfo info) {
    return prepareListFields(
        doc,
        "//datacite:contributor[@contributorType='ContactGroup']/datacite:contributorName",
        info);
  }

  @Override
  protected List<Field<String>> prepareOtherResearchProductContactPersons(
      final Document doc, final DataInfo info) {
    return prepareListFields(
        doc,
        "//datacite:contributor[@contributorType='ContactPerson']/datacite:contributorName",
        info);
  }

  @Override
  protected Qualifier prepareSoftwareProgrammingLanguage(final Document doc, final DataInfo info) {
    return prepareQualifier(
        doc, "//datacite:format", "dnet:programming_languages", "dnet:programming_languages");
  }

  @Override
  protected Field<String> prepareSoftwareCodeRepositoryUrl(
      final Document doc, final DataInfo info) {
    return null; // Not present in ODF ???
  }

  @Override
  protected List<StructuredProperty> prepareSoftwareLicenses(
      final Document doc, final DataInfo info) {
    return new ArrayList<>(); // Not present in ODF ???
  }

  @Override
  protected List<Field<String>> prepareSoftwareDocumentationUrls(
      final Document doc, final DataInfo info) {
    return prepareListFields(
        doc,
        "//datacite:relatedIdentifier[@relatedIdentifierType='URL' and @relationType='IsDocumentedBy']",
        info);
  }

  // DATASETS

  @Override
  protected List<GeoLocation> prepareDatasetGeoLocations(final Document doc, final DataInfo info) {
    final List<GeoLocation> res = new ArrayList<>();

    for (final Object o : doc.selectNodes("//datacite:geoLocation")) {
      final GeoLocation loc = new GeoLocation();
      loc.setBox(((Node) o).valueOf("./datacite:geoLocationBox"));
      loc.setPlace(((Node) o).valueOf("./datacite:geoLocationPlace"));
      loc.setPoint(((Node) o).valueOf("./datacite:geoLocationPoint"));
      res.add(loc);
    }
    return res;
  }

  @Override
  protected Field<String> prepareDatasetMetadataVersionNumber(
      final Document doc, final DataInfo info) {
    return null; // Not present in ODF ???
  }

  @Override
  protected Field<String> prepareDatasetLastMetadataUpdate(
      final Document doc, final DataInfo info) {
    return prepareField(doc, "//datacite:date[@dateType='Updated']", info);
  }

  @Override
  protected Field<String> prepareDatasetVersion(final Document doc, final DataInfo info) {
    return prepareField(doc, "//datacite:version", info);
  }

  @Override
  protected Field<String> prepareDatasetSize(final Document doc, final DataInfo info) {
    return prepareField(doc, "//datacite:size", info);
  }

  @Override
  protected Field<String> prepareDatasetDevice(final Document doc, final DataInfo info) {
    return null; // Not present in ODF ???
  }

  @Override
  protected Field<String> prepareDatasetStorageDate(final Document doc, final DataInfo info) {
    return prepareField(doc, "//datacite:date[@dateType='Issued']", info);
  }

  @Override
  protected List<Oaf> addOtherResultRels(
      final Document doc,
      final KeyValue collectedFrom,
      final DataInfo info,
      final long lastUpdateTimestamp) {

    final String docId = createOpenaireId(50, doc.valueOf("//dri:objIdentifier"), false);

    final List<Oaf> res = new ArrayList<>();

    for (final Object o :
        doc.selectNodes("//datacite:relatedIdentifier[@relatedIdentifierType='OPENAIRE']")) {

      final String originalId = ((Node) o).getText();

      if (StringUtils.isNotBlank(originalId)) {
        final String otherId = createOpenaireId(50, originalId, false);
        final String type = ((Node) o).valueOf("@relationType");

        if (type.equals("IsSupplementTo")) {
          res.add(
              prepareOtherResultRel(
                  collectedFrom,
                  info,
                  lastUpdateTimestamp,
                  docId,
                  otherId,
                  "supplement",
                  "isSupplementTo"));
          res.add(
              prepareOtherResultRel(
                  collectedFrom,
                  info,
                  lastUpdateTimestamp,
                  otherId,
                  docId,
                  "supplement",
                  "isSupplementedBy"));
        } else if (type.equals("IsPartOf")) {
          res.add(
              prepareOtherResultRel(
                  collectedFrom, info, lastUpdateTimestamp, docId, otherId, "part", "IsPartOf"));
          res.add(
              prepareOtherResultRel(
                  collectedFrom, info, lastUpdateTimestamp, otherId, docId, "part", "HasParts"));
        } else {
        }
      }
    }
    return res;
  }

  private Relation prepareOtherResultRel(
      final KeyValue collectedFrom,
      final DataInfo info,
      final long lastUpdateTimestamp,
      final String source,
      final String target,
      final String subRelType,
      final String relClass) {
    final Relation r = new Relation();
    r.setRelType("resultResult");
    r.setSubRelType(subRelType);
    r.setRelClass(relClass);
    r.setSource(source);
    r.setTarget(target);
    r.setCollectedfrom(Arrays.asList(collectedFrom));
    r.setDataInfo(info);
    r.setLastupdatetimestamp(lastUpdateTimestamp);
    return r;
  }

  @Override
  protected Qualifier prepareResourceType(final Document doc, final DataInfo info) {
    return prepareQualifier(
        doc,
        "//*[local-name() = 'resource']//*[local-name() = 'resourceType']",
        "dnet:dataCite_resource",
        "dnet:dataCite_resource");
  }
}