001/*
002 *  Copyright 2025 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.odf.content.code;
017
018import java.util.Optional;
019
020import org.apache.avalon.framework.service.ServiceException;
021import org.apache.avalon.framework.service.ServiceManager;
022
023import org.ametys.cms.data.type.indexing.IndexableElementType;
024import org.ametys.cms.model.CMSDataContext;
025import org.ametys.cms.model.properties.AbstractProperty;
026import org.ametys.cms.model.properties.Property;
027import org.ametys.cms.repository.Content;
028import org.ametys.cms.search.model.CriterionDefinitionAwareElementDefinition;
029import org.ametys.cms.search.model.CriterionDefinitionHelper;
030import org.ametys.cms.search.model.IndexationAwareElementDefinition;
031import org.ametys.cms.search.model.IndexationAwareElementDefinitionHelper;
032import org.ametys.odf.ProgramItem;
033import org.ametys.runtime.config.Config;
034import org.ametys.runtime.model.type.ModelItemTypeConstants;
035
036/**
037 * {@link Property} for the computed display code of a {@link ProgramItem}.
038 */
039public class DisplayCodeProperty extends AbstractProperty<String, Content> implements CriterionDefinitionAwareElementDefinition<String>, IndexationAwareElementDefinition<String, Content>
040{
041    /** The property name for display code */
042    public static final String PROPERTY_NAME = "displayCode";
043    
044    private static final String __CONFIG_PARAM_DISPLAY_CODE_PROVIDER = "odf.display.code.provider";
045    
046    private DisplayCodeProviderExtensionPoint _displayCodeEP;
047
048    private CriterionDefinitionHelper _criterionDefinitionHelper;
049
050    private IndexationAwareElementDefinitionHelper _indexationAwareElementDefinitionHelper;
051
052    @Override
053    public void service(ServiceManager smanager) throws ServiceException
054    {
055        super.service(smanager);
056        _displayCodeEP = (DisplayCodeProviderExtensionPoint) smanager.lookup(DisplayCodeProviderExtensionPoint.ROLE);
057        _criterionDefinitionHelper = (CriterionDefinitionHelper) smanager.lookup(CriterionDefinitionHelper.ROLE);
058        _indexationAwareElementDefinitionHelper = (IndexationAwareElementDefinitionHelper) smanager.lookup(IndexationAwareElementDefinitionHelper.ROLE);
059    }
060    
061    public Object getValue(Content content)
062    {
063        String dcpId = Config.getInstance().getValue(__CONFIG_PARAM_DISPLAY_CODE_PROVIDER, true, AmetysDisplayCodeProvider.ID);
064        
065        DisplayCodeProvider dcProvider = _displayCodeEP.getExtension(dcpId);
066        if (dcProvider.supports(content))
067        {
068            Optional<String> displayCode = dcProvider.getDisplayCode(content);
069            if (displayCode.isPresent())
070            {
071                return displayCode.get();
072            }
073        }
074        
075        // Return value of default provider
076        DisplayCodeProvider defaultProvider = _displayCodeEP.getExtension(AmetysDisplayCodeProvider.ID);
077        return defaultProvider.getDisplayCode(content).orElse(null);
078    }
079
080    @Override
081    protected String getTypeId()
082    {
083        return ModelItemTypeConstants.STRING_TYPE_ID;
084    }
085
086    public IndexableElementType getDefaultCriterionType()
087    {
088        CMSDataContext context = CMSDataContext.newInstance()
089                                               .withModelItem(this);
090        
091        String typeId = getType().getDefaultCriterionTypeId(context);
092        return _criterionDefinitionHelper.getCriterionDefinitionType(typeId);
093    }
094    
095    public String getSolrSortFieldName()
096    {
097        return _indexationAwareElementDefinitionHelper.getDefaultSolrSortFieldName(this);
098    }
099}