RawOccurrenceRecord.java

/*
 * Copyright 2011 Global Biodiversity Information Facility (GBIF)
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.gbif.occurrence.model;

import org.gbif.dwca.record.DarwinCoreRecord;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;


/**
 * This is mostly cut and paste from synchronizer-gbif, intended as a place holder until this project is
 * integrated with the main synchronizer process. Differences from sync-gbif are that id and dateIdentified are String,
 * and occurenceDate is retained as a verbatim string rather than parsed to year, month and day.
 */
public class RawOccurrenceRecord implements Serializable {

  private static final Logger LOG = LoggerFactory.getLogger(RawOccurrenceRecord.class);

  // TODO: why aren't these private?
  protected String id;
  protected Integer dataProviderId;
  protected Integer dataResourceId;
  protected Integer resourceAccessPointId;
  protected String institutionCode;
  protected String collectionCode;
  protected String catalogueNumber;
  protected String scientificName;
  protected String author;
  protected String rank;
  protected String kingdom;
  protected String phylum;
  protected String klass;
  protected String order;
  protected String family;
  protected String genus;
  protected String species;
  protected String subspecies;
  protected String latitude;
  protected String longitude;
  protected String latLongPrecision;
  protected String geodeticDatum;
  protected String minAltitude;
  protected String maxAltitude;
  protected String altitudePrecision;
  protected String minDepth;
  protected String maxDepth;
  protected String depthPrecision;
  protected String continentOrOcean;
  protected String country;
  protected String stateOrProvince;
  protected String county;
  protected String collectorName;
  protected String collectorsFieldNumber;
  protected String locality;
  protected String year;
  protected String month;
  protected String day;
  protected String occurrenceDate;
  protected String basisOfRecord;
  protected String identifierName;
  protected String yearIdentified;
  protected String monthIdentified;
  protected String dayIdentified;
  protected String dateIdentified;
  protected String unitQualifier;
  protected long created;
  protected long modified;

  private List<IdentifierRecord> identifierRecords = new ArrayList<IdentifierRecord>();
  private List<TypificationRecord> typificationRecords = new ArrayList<TypificationRecord>();
  private List<ImageRecord> imageRecords = new ArrayList<ImageRecord>();
  private List<LinkRecord> linkRecords = new ArrayList<LinkRecord>();

  /**
   * Default
   */
  public RawOccurrenceRecord() {
  }

  /**
   * TODO: handle supporting table records & maybe dwca extensions?
   */
  public RawOccurrenceRecord(DarwinCoreRecord dwcr) {
    this.basisOfRecord = dwcr.getBasisOfRecord();
    this.catalogueNumber = dwcr.getCatalogNumber();
    this.klass = dwcr.getClasss();
    this.collectionCode = dwcr.getCollectionCode();
    this.continentOrOcean = dwcr.getContinent();
    this.country =
      dwcr.getCountry() == null || dwcr.getCountry().isEmpty() ? dwcr.getCountryCode() : dwcr.getCountry();
    this.county = dwcr.getCounty();
    this.dateIdentified = dwcr.getDateIdentified();
    this.latitude = dwcr.getVerbatimLatitude() == null ? dwcr.getDecimalLatitude() : dwcr.getVerbatimLatitude();
    this.longitude = dwcr.getVerbatimLongitude() == null ? dwcr.getDecimalLongitude() : dwcr.getVerbatimLongitude();
    this.geodeticDatum = dwcr.getGeodeticDatum();
    this.family = dwcr.getFamily();
    this.scientificName =
      dwcr.getScientificName() == null || dwcr.getScientificName().isEmpty() ? dwcr.getFullScientificName()
        : dwcr.getScientificName();
    this.genus = dwcr.getGenus();
    this.identifierName = dwcr.getIdentifiedBy();
    this.institutionCode = dwcr.getInstitutionCode();
    this.kingdom = dwcr.getKingdom();
    this.maxDepth = dwcr.getMaximumDepthInMeters();
    this.minDepth = dwcr.getMinimumDepthInMeters();
    this.maxAltitude = dwcr.getMaximumElevationInMeters();
    this.minAltitude = dwcr.getMinimumElevationInMeters();
    this.order = dwcr.getOrder();
    this.phylum = dwcr.getPhylum();
    this.occurrenceDate = dwcr.getYear() + '-' + dwcr.getMonth() + '-' + dwcr.getDay();
    this.collectorsFieldNumber = dwcr.getRecordNumber();
  }

  public String getAltitudePrecision() {
    return altitudePrecision;
  }

  public String getAuthor() {
    return author;
  }

  public String getBasisOfRecord() {
    return basisOfRecord;
  }

  public String getCatalogueNumber() {
    return catalogueNumber;
  }

  public String getCollectionCode() {
    return collectionCode;
  }

  public String getCollectorName() {
    return collectorName;
  }

  public String getContinentOrOcean() {
    return continentOrOcean;
  }

  public String getCountry() {
    return country;
  }

  public String getCounty() {
    return county;
  }

  public long getCreated() {
    return created;
  }

  public Integer getDataProviderId() {
    return dataProviderId;
  }

  public Integer getDataResourceId() {
    return dataResourceId;
  }

  public String getDateIdentified() {
    return dateIdentified;
  }

  public String getDepthPrecision() {
    return depthPrecision;
  }

  public String getFamily() {
    return family;
  }

  public String getGenus() {
    return genus;
  }

  public String getGeodeticDatum() {
    return geodeticDatum;
  }

  public void setGeodeticDatum(String geodeticDatum) {
    this.geodeticDatum = geodeticDatum;
  }

  public String getId() {
    return id;
  }

  public String getIdentifierName() {
    return identifierName;
  }

  public String getInstitutionCode() {
    return institutionCode;
  }

  public String getKingdom() {
    return kingdom;
  }

  public String getKlass() {
    return klass;
  }

  public String getLatitude() {
    return latitude;
  }

  public String getLatLongPrecision() {
    return latLongPrecision;
  }

  public String getLocality() {
    return locality;
  }

  public String getLongitude() {
    return longitude;
  }

  public String getMaxAltitude() {
    return maxAltitude;
  }

  public String getMaxDepth() {
    return maxDepth;
  }

  public String getMinAltitude() {
    return minAltitude;
  }

  public String getMinDepth() {
    return minDepth;
  }

  public long getModified() {
    return modified;
  }

  public String getOrder() {
    return order;
  }

  public String getPhylum() {
    return phylum;
  }

  public String getRank() {
    return rank;
  }

  public Integer getResourceAccessPointId() {
    return resourceAccessPointId;
  }

  public String getScientificName() {
    return scientificName;
  }

  public String getSpecies() {
    return species;
  }

  public String getStateOrProvince() {
    return stateOrProvince;
  }

  public String getSubspecies() {
    return subspecies;
  }

  public String getUnitQualifier() {
    return unitQualifier;
  }

  public void setAltitudePrecision(String altitudePrecision) {
    this.altitudePrecision = altitudePrecision;
  }

  public void setAuthor(String author) {
    this.author = author;
  }

  public void setBasisOfRecord(String basisOfRecord) {
    this.basisOfRecord = basisOfRecord;
  }

  public void setCatalogueNumber(String catalogueNumber) {
    this.catalogueNumber = catalogueNumber;
  }

  public void setCollectionCode(String collectionCode) {
    this.collectionCode = collectionCode;
  }

  public void setCollectorName(String collectorName) {
    this.collectorName = collectorName;
  }

  public void setContinentOrOcean(String continentOrOcean) {
    this.continentOrOcean = continentOrOcean;
  }

  public void setCountry(String country) {
    this.country = country;
  }

  public void setCounty(String county) {
    this.county = county;
  }

  public void setCreated(long created) {
    this.created = created;
  }

  public void setDataProviderId(Integer dataProviderId) {
    this.dataProviderId = dataProviderId;
  }

  public void setDataResourceId(Integer dataResourceId) {
    this.dataResourceId = dataResourceId;
  }

  public void setDateIdentified(String dateIdentified) {
    this.dateIdentified = dateIdentified;
  }

  public void setDepthPrecision(String depthPrecision) {
    this.depthPrecision = depthPrecision;
  }

  public void setFamily(String family) {
    this.family = family;
  }

  public void setGenus(String genus) {
    this.genus = genus;
  }

  public void setId(String id) {
    this.id = id;
  }

  public void setIdentifierName(String identifierName) {
    this.identifierName = identifierName;
  }

  public void setInstitutionCode(String institutionCode) {
    this.institutionCode = institutionCode;
  }

  public void setKingdom(String kingdom) {
    this.kingdom = kingdom;
  }

  public void setKlass(String klass) {
    this.klass = klass;
  }

  public void setLatitude(String latitude) {
    this.latitude = latitude;
  }

  public void setLatLongPrecision(String latLongPrecision) {
    this.latLongPrecision = latLongPrecision;
  }

  public void setLocality(String locality) {
    this.locality = locality;
  }

  public void setLongitude(String longitude) {
    this.longitude = longitude;
  }

  public void setMaxAltitude(String maxAltitude) {
    this.maxAltitude = maxAltitude;
  }

  public void setMaxDepth(String maxDepth) {
    this.maxDepth = maxDepth;
  }

  public void setMinAltitude(String minAltitude) {
    this.minAltitude = minAltitude;
  }

  public void setMinDepth(String minDepth) {
    this.minDepth = minDepth;
  }

  public void setModified(long modified) {
    this.modified = modified;
  }

  public void setOrder(String order) {
    this.order = order;
  }

  public void setPhylum(String phylum) {
    this.phylum = phylum;
  }

  public void setRank(String rank) {
    this.rank = rank;
  }

  public void setResourceAccessPointId(Integer resourceAccessPointId) {
    this.resourceAccessPointId = resourceAccessPointId;
  }

  public void setScientificName(String scientificName) {
    this.scientificName = scientificName;
  }

  public void setSpecies(String species) {
    this.species = species;
  }

  public void setStateOrProvince(String stateOrProvince) {
    this.stateOrProvince = stateOrProvince;
  }

  public void setSubspecies(String subspecies) {
    this.subspecies = subspecies;
  }

  public void setUnitQualifier(String unitQualifier) {
    this.unitQualifier = unitQualifier;
  }

  public List<IdentifierRecord> getIdentifierRecords() {
    return identifierRecords;
  }

  public void setIdentifierRecords(List<IdentifierRecord> identifierRecords) {
    this.identifierRecords = identifierRecords;
  }

  public List<TypificationRecord> getTypificationRecords() {
    return typificationRecords;
  }

  public void setTypificationRecords(List<TypificationRecord> typificationRecords) {
    this.typificationRecords = typificationRecords;
  }

  public List<ImageRecord> getImageRecords() {
    return imageRecords;
  }

  public void setImageRecords(List<ImageRecord> imageRecords) {
    this.imageRecords = imageRecords;
  }

  public List<LinkRecord> getLinkRecords() {
    return linkRecords;
  }

  public void setLinkRecords(List<LinkRecord> linkRecords) {
    this.linkRecords = linkRecords;
  }

  public String getYear() {
    return year;
  }

  public void setYear(String year) {
    this.year = year;
  }

  public String getMonth() {
    return month;
  }

  public void setMonth(String month) {
    this.month = month;
  }

  public String getDay() {
    return day;
  }

  public void setDay(String day) {
    this.day = day;
  }

  public String getYearIdentified() {
    return yearIdentified;
  }

  public void setYearIdentified(String yearIdentified) {
    this.yearIdentified = yearIdentified;
  }

  public String getMonthIdentified() {
    return monthIdentified;
  }

  public void setMonthIdentified(String monthIdentified) {
    this.monthIdentified = monthIdentified;
  }

  public String getDayIdentified() {
    return dayIdentified;
  }

  public void setDayIdentified(String dayIdentified) {
    this.dayIdentified = dayIdentified;
  }

  public String getOccurrenceDate() {
    return occurrenceDate;
  }

  public void setOccurrenceDate(String occurrenceDate) {
    this.occurrenceDate = occurrenceDate;
  }

  public String getCollectorsFieldNumber() {
    return collectorsFieldNumber;
  }

  public void setCollectorsFieldNumber(String collectorsFieldNumber) {
    this.collectorsFieldNumber = collectorsFieldNumber;
  }

  public String debugDump() {
    return "RawOccurrenceRecord [\n id=" + id + ",\n dataProviderId=" + dataProviderId + ",\n dataResourceId=" +
           dataResourceId + ",\n resourceAccessPointId=" + resourceAccessPointId + ",\n institutionCode=" +
           institutionCode + ",\n collectionCode=" + collectionCode + ",\n catalogueNumber=" + catalogueNumber +
           ",\n scientificName=" + scientificName + ",\n author=" + author + ",\n rank=" + rank + ",\n kingdom=" +
           kingdom + ",\n phylum=" + phylum + ",\n klass=" + klass + ",\n order=" + order + ",\n family=" + family +
           ",\n genus=" + genus + ",\n species=" + species + ",\n subspecies=" + subspecies + ",\n latitude=" +
           latitude + ",\n longitude=" + longitude + ",\n latLongPrecision=" + latLongPrecision + ",\n geodeticDatum="
           + geodeticDatum + ",\n minAltitude=" +
           minAltitude + ",\n maxAltitude=" + maxAltitude + ",\n altitudePrecision=" + altitudePrecision +
           ",\n minDepth=" + minDepth + ",\n maxDepth=" + maxDepth + ",\n depthPrecision=" + depthPrecision +
           ",\n continentOrOcean=" + continentOrOcean + ",\n country=" + country + ",\n stateOrProvince=" +
           stateOrProvince + ",\n county=" + county + ",\n collectorName=" + collectorName
           + ",\n collectorsFieldNumber=" + collectorsFieldNumber + ",\n locality=" +  locality + ",\n occurrenceDate="
           + occurrenceDate + ",\n basisOfRecord=" + basisOfRecord + ",\n identifierName=" + identifierName
           + ",\n dateIdentified=" + dateIdentified + ",\n unitQualifier=" + unitQualifier + "]";
  }

}