CropTraitObservationApiService.java

/*
 * Copyright 2024 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.api.v2.facade;

import org.gringlobal.api.model.CropTraitDTO;
import org.gringlobal.api.model.CropTraitObservationDTO;
import org.gringlobal.api.model.InventoryDTO;
import org.gringlobal.api.model.MethodDTO;
import org.gringlobal.api.model.TranslatedCropTraitDTO;
import org.gringlobal.api.model.TranslatedCropTraitObservationDTO;
import org.gringlobal.custom.elasticsearch.SearchException;
import org.gringlobal.model.CropTraitObservation;
import org.gringlobal.service.filter.CropTraitObservationFilter;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.transaction.annotation.Transactional;

import java.util.Objects;
import java.util.Set;

public interface CropTraitObservationApiService extends APIFilteredServiceFacade<CropTraitObservationDTO, CropTraitObservation, CropTraitObservationFilter> {
	
	@Transactional(readOnly = true)
	TranslatedCropTraitObservationDTO getTranslated(long id);
	
	@Transactional(readOnly = true)
	Page<TranslatedCropTraitObservationDTO> listTranslated(CropTraitObservationFilter filter, Pageable page) throws SearchException;

	Page<InventoryDTO> getObservationInventoriesByMethod(Long methodId, Pageable pageable);

	Page<CropTraitDTO> getObservationTraitsByMethod(Long methodId, Pageable pageable);

	int ensureObservations(EnsureObservationsRequest request);

	FilteredObservations search(CropTraitObservationFilter filter, Pageable pageable);

	class EnsureObservationsRequest {
		public Long methodId;
		public Set<Long> cropTraitId;
		public Set<Long> inventoryId;
	}

	class FilteredObservations {
		public Set<MethodDTO> methods;
		public Set<TranslatedCropTraitDTO> cropTraits;
		public Set<InventoryWithObservations> observations;

		/** The filter. */
		public CropTraitObservationFilter filter;
	}

	class InventoryWithObservations {
		public InventoryDTO i;
		public Set<CropTraitObservationDTO> o;

		public InventoryWithObservations(InventoryDTO i, Set<CropTraitObservationDTO> o) {
			this.i = i;
			this.o = o;
		}

		@Override
		public boolean equals(Object o1) {
			if (this == o1) return true;
			if (o1 == null || getClass() != o1.getClass()) return false;
			InventoryWithObservations that = (InventoryWithObservations) o1;
			return Objects.equals(i, that.i) && Objects.equals(o.size(), that.o.size());
		}

		@Override
		public int hashCode() {
			return Objects.hash(i, o);
		}
	}
}