001/*
002 *  Copyright 2018 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.impl;
017
018import org.ametys.cms.search.Sort;
019import org.ametys.runtime.i18n.I18nizableText;
020import org.ametys.web.frontoffice.search.metamodel.SortDefinition;
021
022/**
023 * {@link SortDefinition} implementation for a sort on pertinence (Solr pseudo-field "score").
024 */
025public class CommonPertinenceSortDefinition extends DefaultSortDefinition
026{
027    /** The id of the sort definition */
028    protected static final String __ID = "common$pertinence";
029    
030    /**
031     * Default constructor with default label
032     */
033    public CommonPertinenceSortDefinition()
034    {
035        this(new I18nizableText("plugin.web", "PLUGINS_WEB_SERVICE_SEARCH_COMMON_SORT_PERTINENCE"));
036    }
037    
038    /**
039     * Constructor with a label
040     * @param label The label
041     */
042    public CommonPertinenceSortDefinition(I18nizableText label)
043    {
044        super(__ID, label, "score");
045    }
046    
047    @Override
048    public Sort.Order[] orders()
049    {
050        // only descending sort order as ascending is useless
051        return new Sort.Order[] {Sort.Order.DESC};
052    }
053}