TaxonomyController.java

/*
 * Copyright 2020 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.v1.impl;

import org.gringlobal.api.v1.ApiBaseController;
import org.gringlobal.api.v1.FilteredCRUDController;
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.TaxonomyFamilyCRUDService;
import org.gringlobal.service.TaxonomyGenusCRUDService;
import org.gringlobal.service.TaxonomySpeciesCRUDService;
import org.gringlobal.service.filter.TaxonomyFamilyFilter;
import org.gringlobal.service.filter.TaxonomyGenusFilter;
import org.gringlobal.service.filter.TaxonomySpeciesFilter;
import org.springframework.security.access.prepost.PreAuthorize;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import com.querydsl.core.types.OrderSpecifier;

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

/**
 * Taxonomy API v1
 *
 * @deprecated Will be removed in 2024.6
 */
@RestController("taxonomyApi1")
@RequestMapping(TaxonomyController.API_URL)
@PreAuthorize("isAuthenticated()")
@Tag(name = "Taxonomy")
@Deprecated
public class TaxonomyController extends ApiBaseController {

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

	/**
	 * @deprecated Will be removed in 2024.6
	 */
	@RestController("taxonomySpeciesApi1")
	@RequestMapping(SpeciesController.API_URL)
	@PreAuthorize("isAuthenticated()")
	@Tag(name = "Taxonomy")
	@Deprecated
	public static class SpeciesController extends FilteredCRUDController<TaxonomySpecies, TaxonomySpeciesCRUDService, TaxonomySpeciesFilter> {
		public static final String API_URL = TaxonomyController.API_URL + "/species";
		private final OrderSpecifier<?>[] DEFAULT_SORT = { QTaxonomySpecies.taxonomySpecies.taxonomyGenus().genusName.asc(), QTaxonomySpecies.taxonomySpecies.speciesName.asc() };

		@Override
		protected Class<TaxonomySpeciesFilter> filterType() {
			return TaxonomySpeciesFilter.class;
		}

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

	}

	/**
	 * @deprecated Will be removed in 2024.6
	 */
	@RestController("taxonomyGenusApi1")
	@RequestMapping(GenusController.API_URL)
	@PreAuthorize("isAuthenticated()")
	@Tag(name = "Taxonomy")
	@Deprecated
	public static class GenusController extends FilteredCRUDController<TaxonomyGenus, TaxonomyGenusCRUDService, TaxonomyGenusFilter> {
		public static final String API_URL = TaxonomyController.API_URL + "/genus";
		private final OrderSpecifier<?>[] DEFAULT_SORT = { QTaxonomyGenus.taxonomyGenus.genusName.asc() };

		@Override
		protected Class<TaxonomyGenusFilter> filterType() {
			return TaxonomyGenusFilter.class;
		}

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

	}

	/**
	 * @deprecated Will be removed in 2024.6
	 */
	@RestController("taxonomyFamilyApi1")
	@RequestMapping(FamilyController.API_URL)
	@PreAuthorize("isAuthenticated()")
	@Tag(name = "Taxonomy")
	@Deprecated
	public static class FamilyController extends FilteredCRUDController<TaxonomyFamily, TaxonomyFamilyCRUDService, TaxonomyFamilyFilter> {
		public static final String API_URL = TaxonomyController.API_URL + "/family";
		private final OrderSpecifier<?>[] DEFAULT_SORT = { QTaxonomyFamily.taxonomyFamily.familyName.asc() };

		@Override
		protected Class<TaxonomyFamilyFilter> filterType() {
			return TaxonomyFamilyFilter.class;
		}

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

	}
}