TaxonomyController.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.impl;

import io.swagger.v3.oas.annotations.tags.Tag;

import org.apache.commons.lang3.StringUtils;
import org.gringlobal.api.model.TaxonomyFamilyDTO;
import org.gringlobal.api.model.TaxonomyGenusDTO;
import org.gringlobal.api.model.TaxonomySpeciesDTO;
import org.gringlobal.api.model.TaxonomySpeciesInfo;
import org.gringlobal.api.v1.ApiBaseController;
import org.gringlobal.api.v2.FilteredCRUDController;
import org.gringlobal.api.v2.facade.TaxonomyFamilyApiService;
import org.gringlobal.api.v2.facade.TaxonomyGenusApiService;
import org.gringlobal.api.v2.facade.TaxonomySpeciesApiService;
import org.gringlobal.custom.elasticsearch.SearchException;
import org.gringlobal.model.QTaxonomyFamily;
import org.gringlobal.model.QTaxonomyGenus;
import org.gringlobal.model.QTaxonomySpecies;
import org.gringlobal.model.TaxonomyFamily;
import org.gringlobal.model.TaxonomyGenus;
import org.gringlobal.model.TaxonomySpecies;
import org.gringlobal.service.filter.TaxonomyFamilyFilter;
import org.gringlobal.service.filter.TaxonomyGenusFilter;
import org.gringlobal.service.filter.TaxonomySpeciesFilter;
import org.springframework.http.MediaType;
import org.springframework.security.access.prepost.PreAuthorize;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

import com.querydsl.core.types.OrderSpecifier;

import java.util.Collections;
import java.util.List;

/**
 * The Taxonomy APIs.
 */
@RestController("taxonomyApi2")
@RequestMapping(TaxonomyController.API_URL)
@PreAuthorize("isAuthenticated()")
@Tag(name = "Taxonomy")
public class TaxonomyController {

	/** The Constant API_URL. */
	public static final String API_URL = ApiBaseController.APIv2_BASE + "/t";

	@RestController("taxonomySpeciesApi2")
	@RequestMapping(TaxonomySpeciesController.API_URL)
	@PreAuthorize("isAuthenticated()")
	@Tag(name = "Taxonomy")
	public static class TaxonomySpeciesController extends FilteredCRUDController<TaxonomySpeciesDTO, TaxonomySpecies, TaxonomySpeciesApiService, TaxonomySpeciesFilter> {

		public static final String API_URL = TaxonomyController.API_URL + "/species";
		private final OrderSpecifier<?>[] DEFAULT_SORT = { QTaxonomySpecies.taxonomySpecies.name.asc() };

		@Override
		protected OrderSpecifier<?>[] defaultSort() {
			return DEFAULT_SORT;
		}

		/**
		 * Auto-complete species.
		 *
		 * @param term the search term
		 */
		@GetMapping(value = "/autocomplete", produces = MediaType.APPLICATION_JSON_VALUE)
		public List<TaxonomySpeciesInfo> autocomplete(@RequestParam("term") final String term) throws SearchException {
			if (StringUtils.isBlank(term) || term.length() < 1) {
				return Collections.emptyList();
			}
			return serviceFacade.autocomplete(term);
		}
	}

	@RestController("taxonomyGenusApi2")
	@RequestMapping(TaxonomyGenusController.API_URL)
	@PreAuthorize("isAuthenticated()")
	@Tag(name = "Taxonomy")
	public static class TaxonomyGenusController extends FilteredCRUDController<TaxonomyGenusDTO, TaxonomyGenus, TaxonomyGenusApiService, TaxonomyGenusFilter> {

		public static final String API_URL = TaxonomyController.API_URL + "/genus";
		private final OrderSpecifier<?>[] DEFAULT_SORT = { QTaxonomyGenus.taxonomyGenus.genusName.asc() };

		@Override
		protected OrderSpecifier<?>[] defaultSort() {
			return DEFAULT_SORT;
		}

	}

	@RestController("taxonomyFamilyApi2")
	@RequestMapping(TaxonomyFamilyController.API_URL)
	@PreAuthorize("isAuthenticated()")
	@Tag(name = "Taxonomy")
	public static class TaxonomyFamilyController extends FilteredCRUDController<TaxonomyFamilyDTO, TaxonomyFamily, TaxonomyFamilyApiService, TaxonomyFamilyFilter> {

		public static final String API_URL = TaxonomyController.API_URL + "/family";
		private final OrderSpecifier<?>[] DEFAULT_SORT = { QTaxonomyFamily.taxonomyFamily.familyName.asc() };

		@Override
		protected OrderSpecifier<?>[] defaultSort() {
			return DEFAULT_SORT;
		}

	}

}