ShortFilterService.java

/*
 * Copyright 2026 Global Crop Diversity Trust
 * Licensed under the Apache License, Version 2.0
 * See LICENSE file in project root folder or http://www.apache.org/licenses/LICENSE-2.0
 */

package org.gringlobal.service;

import java.io.IOException;

import org.genesys.blocks.model.filters.SuperModelFilter;

import org.gringlobal.model.ShortFilter;

/**
 * The Interface ShortFilterService.
 *
 * @author Maxym Borodenko
 */
public interface ShortFilterService {

	/**
	 * Normalize the filter.
	 *
	 * @param filter object to be normalized
	 * @return string with normalized filter
	 * @throws IOException Signals that an I/O exception has occurred.
	 */
	<T extends SuperModelFilter<T, ?, ?>> String normalizeFilter(T filter) throws IOException;

	/**
	 * Normalize the filter.
	 *
	 * @param filter object to be normalized
	 * @param clazz the clazz
	 * @throws IOException Signals that an I/O exception has occurred.
	 */
	<T extends SuperModelFilter<T, ?, ?>> T normalizeFilter(T filter, Class<T> clazz) throws IOException;

	/**
	 * Load short filter or create a new code.
	 *
	 * @param filter original filter object
	 * @return found or created name of the shortened filter object
	 * @throws IOException
	 */
	<T extends SuperModelFilter<T, ?, ?>> String getCode(T filter) throws IOException;

	/**
	 * Load ShortFilter by short name.
	 *
	 * @param code short name of ShortFilter
	 * @return found ShortFilter
	 */
	ShortFilter loadByCode(String code);

	/**
	 * Load ShortFilter by json filters.
	 *
	 * @param json json filters of ShortFilter
	 * @return found ShortFilter
	 */
	ShortFilter loadByJSON(String json);

	/**
	 * Returns the Java filter object by short name.
	 *
	 * @param <T> the generic type
	 * @param code the filter code
	 * @param clazz the clazz
	 * @return the Instance of type T with data from JSON
	 * @throws IOException Signals that an I/O exception has occurred.
	 */
	<T extends SuperModelFilter<T, ?, ?>> T filterByCode(String code, Class<T> clazz) throws IOException;

	public static class FilterInfo<T> {
		public T filter;
		public String filterCode;
	}

	/**
	 * Upgrade a {@link ShortFilter} to the current version of the short code.
	 *
	 * Maintains the original JSON + registers a new entry!
	 *
	 * @param shortFilter the filter
	 * @return filterCode by current standards
	 */
	ShortFilter upgradeFilterCode(ShortFilter shortFilter);

	/**
	 * Parse JSON to filter type
	 *
	 * @param json
	 * @param clazz
	 * @return
	 * @throws IOException
	 */
	<T extends SuperModelFilter<T, ?, ?>> T readFilter(String json, Class<T> clazz) throws IOException;

	/**
	 * Handles incoming filterCode and filter object for specified target class
	 *
	 * @param filterCode the filterCode
	 * @param filter the filter
	 * @param clazz the class
	 * @return processed filter
	 * @throws IOException
	 */
	<T extends SuperModelFilter<T, ?, ?>> FilterInfo<T> processFilter(String filterCode, T filter, Class<T> clazz) throws IOException;

}