CropTraitObservation.java

/*
 * Copyright 2019 Global Crop Diversity Trust
 *
 * 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.gringlobal.model;

import java.util.List;
import java.util.Objects;

import javax.persistence.Basic;
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.FetchType;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.JoinColumn;
import javax.persistence.Lob;
import javax.persistence.ManyToOne;
import javax.persistence.OneToMany;
import javax.persistence.PrePersist;
import javax.persistence.PreUpdate;
import javax.persistence.Table;

import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;
import org.genesys.blocks.model.Copyable;
import org.gringlobal.api.exception.InvalidApiUsageException;
import org.gringlobal.custom.validation.javax.CodeValueField;
import org.gringlobal.model.community.CommunityCodeValues;

import com.fasterxml.jackson.annotation.JsonIdentityInfo;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.annotation.ObjectIdGenerators;

import static org.gringlobal.model.community.CommunityCodeValues.CODE_VALUE_LENGTH;

/**
 * Auto-generated by:
 * org.apache.openjpa.jdbc.meta.ReverseMappingTool$AnnotatedCodeGenerator
 */
@Entity
@Table(name = "crop_trait_observation")
@JsonIdentityInfo(scope = CropTraitObservation.class, generator = ObjectIdGenerators.PropertyGenerator.class, property = "id")
@Getter
@Setter
@NoArgsConstructor
public class CropTraitObservation extends CooperatorOwnedModel implements Copyable<CropTraitObservation> {

	private static final long serialVersionUID = -1104474905202932765L;

	@Id
	@JsonProperty
	@GeneratedValue(strategy = GenerationType.IDENTITY)
	@Column(name = "crop_trait_observation_id", columnDefinition = "int")
	private Long id;

	@ManyToOne(fetch = FetchType.LAZY, cascade = {})
	@JoinColumn(name = "inventory_id", nullable = false)
	private Inventory inventory;

	@ManyToOne(fetch = FetchType.LAZY, cascade = {})
	@JoinColumn(name = "method_id", nullable = false)
	private Method method;

	@ManyToOne(fetch = FetchType.LAZY, cascade = {})
	@JoinColumn(name = "crop_trait_id", nullable = false)
	private CropTrait cropTrait;

	@ManyToOne(fetch = FetchType.LAZY, cascade = {})
	@JoinColumn(name = "crop_trait_code_id")
	private CropTraitCode cropTraitCode;

	@Basic
	@Column(name = "is_archived", nullable = false, length = 1)
	private String isArchived = "N";

	@Basic
	private Integer rank;

	@Basic
	private Double frequency;

	@Basic
	@Column(name = "data_quality_code", length = CODE_VALUE_LENGTH)
	@CodeValueField("OBSERVATION_DATA_QUALITY")
	private String dataQualityCode;

	@Basic
	@Column(name = "original_value", length = 30)
	private String originalValue;

	@Basic
	@Column(name = "string_value")
	private String stringValue;

	@Basic
	@Column(name = "numeric_value")
	private Double numericValue;

	@Basic
	@Column(name = "sample_size")
	private Integer sampleSize;

	@Basic
	@Column(name = "minimum_value")
	private Double minimumValue;

	@Basic
	@Column(name = "maximum_value")
	private Double maximumValue;

	@Basic
	@Column(name = "mean_value")
	private Double meanValue;

	@Basic
	@Column(name = "standard_deviation")
	private Double standardDeviation;

	@Basic
	@Column
	@Lob
	private String note;

	@OneToMany(cascade = {}, orphanRemoval = false, fetch = FetchType.LAZY, mappedBy = "cropTraitObservation")
	@JsonIgnore
	private List<CropTraitObservationData> observationData;

	@PrePersist
	@PreUpdate
	private void preupdate() {
		/*
		* Make sure to keep this in sync with CropTraitObservation#preupdate
		*/
		assert cropTrait != null;

		if ("Y".equals(cropTrait.getIsCoded())) {
			if (cropTraitCode != null && !cropTrait.getId().equals(cropTraitCode.getCropTrait().getId())) {
				throw new InvalidApiUsageException("cropTraitCode does not belong to cropTrait");
			}
			if (numericValue != null) {
				throw new InvalidApiUsageException("cropTrait is coded");
			} else if (stringValue != null) {
				throw new InvalidApiUsageException("cropTrait is coded");
			};
		} else {
			if (cropTraitCode != null) {
				throw new InvalidApiUsageException("cropTrait is not coded");
			}
			if (numericValue != null) {
				if (!Objects.equals(cropTrait.getDataTypeCode(), CommunityCodeValues.DATATYPE_NUMERIC)) {
					throw new InvalidApiUsageException("cropTrait is not numeric");
				}
				if (stringValue != null) {
					throw new InvalidApiUsageException("cropTrait is numeric");
				};
				if (cropTrait.getNumericMinimum() != null && numericValue < cropTrait.getNumericMinimum()) {
					throw new InvalidApiUsageException("Out of numeric range");
				}
				if (cropTrait.getNumericMaximum() != null && numericValue > cropTrait.getNumericMaximum()) {
					throw new InvalidApiUsageException("Out of numeric range");
				}
			}
			if (stringValue != null) {
				if (Objects.equals(cropTrait.getDataTypeCode(), CommunityCodeValues.DATATYPE_NUMERIC)) {
					throw new InvalidApiUsageException("cropTrait is numeric");
				}
				if (numericValue != null) {
					throw new InvalidApiUsageException("cropTrait is not numeric");
				}
				if (cropTrait.getMaxLength() != null && stringValue.length() > cropTrait.getMaxLength())
					throw new InvalidApiUsageException("stringValue longer than crop trait maxLength " + cropTrait.getMaxLength());
				numericValue = null;
			}
		}
	}

	public CropTraitObservation(final Long id) {
		this.id = id;
	}

	@Override
	public void lazyLoad() {
		super.lazyLoad();
		lazyLoad(this.method);
		lazyLoad(this.inventory);
		lazyLoad(this.cropTrait);
		lazyLoad(this.cropTraitCode);
	}

	@Override
	public boolean canEqual(Object other) {
		return other instanceof CropTraitObservation;
	}
}