001/*
002 *  Copyright 2019 Anyware Services
003 *
004 *  Licensed under the Apache License, Version 2.0 (the "License");
005 *  you may not use this file except in compliance with the License.
006 *  You may obtain a copy of the License at
007 *
008 *      http://www.apache.org/licenses/LICENSE-2.0
009 *
010 *  Unless required by applicable law or agreed to in writing, software
011 *  distributed under the License is distributed on an "AS IS" BASIS,
012 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 *  See the License for the specific language governing permissions and
014 *  limitations under the License.
015 */
016package org.ametys.web.frontoffice.search.metamodel;
017
018import java.util.List;
019import java.util.Map;
020import java.util.Optional;
021
022import org.ametys.runtime.i18n.I18nizableText;
023
024/**
025 * Represents some enumerated values returned by {@link SearchCriterionDefinition#getEnumeratedValues}
026 */
027public interface EnumeratedValues
028{
029    /**
030     * Gets all the values (with their label)
031     * @return all the values (with their label)
032     */
033    Map<Object, I18nizableText> getAllValues();
034    
035    /**
036     * Gets the enumerated value (with its label) from the given value
037     * @param value the value
038     * @return the enumerated value (with its label)
039     */
040    default Optional<Map.Entry<Object, I18nizableText>> getValue(Object value)
041    {
042        return getAllValues().entrySet()
043                             .stream()
044                             .filter(entry -> entry.getKey().equals(value))
045                             .findFirst();
046    }
047    
048    /**
049     * Gets the {@link RestrictedValues} object
050     * <br>The implementation must decide whether or not the given objs must be validated among {@link #getAllValues all values}, if they must be converted, etc.
051     * @param objs The desired objects
052     * @return the {@link RestrictedValues}
053     */
054    RestrictedValues getRestrictedValuesFor(List<Object> objs);
055    
056    /**
057     * Represents a subset of values (some 'restricted' values) of a given {@link EnumeratedValues}.
058     */
059    interface RestrictedValues
060    {
061        Map<Object, I18nizableText> values();
062    }
063}
064