001/*
002 *  Copyright 2024 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.cms.search.model.impl;
017
018import java.util.Map;
019import java.util.Optional;
020
021import org.apache.cocoon.xml.XMLUtils;
022import org.xml.sax.ContentHandler;
023import org.xml.sax.SAXException;
024
025import org.ametys.cms.model.CMSDataContext;
026import org.ametys.cms.search.model.SearchModel;
027import org.ametys.cms.search.model.SearchModelCriterionDefinition;
028import org.ametys.cms.search.query.Query;
029import org.ametys.cms.search.query.Query.LogicalOperator;
030import org.ametys.cms.search.query.Query.Operator;
031import org.ametys.runtime.model.DefinitionContext;
032
033/**
034 * Default implementation for {@link SearchModelCriterionDefinition}
035 * @param <T> Type of the criterion value
036 */
037public class DefaultSearchModelCriterionDefinition<T> extends AbstractCriterionDefinition<T> implements SearchModelCriterionDefinition<T>
038{
039    /** The criteria operator */
040    protected Operator _operator;
041    
042    public Operator getOperator()
043    {
044        return Optional.ofNullable(_operator)
045                       .orElseGet(this::_getDefaultOperator);
046    }
047    
048    /**
049     * Retrieves the default operator for the criterion 
050     * @return the default operator for the criterion
051     */
052    protected Operator _getDefaultOperator()
053    {
054        return getType().getDefaultCriterionOperator(CMSDataContext.newInstance()
055                                                                   .withModelItem(this));
056    }
057    
058    public void setOperator(Operator operator)
059    {
060        _operator = operator;
061    }
062    
063    public void setMultipleOperandOperator(LogicalOperator multipleOperand)
064    {
065        _multipleOperandOperator = multipleOperand;
066    }
067    
068    @Override
069    protected Map<String, Object> _toJSON(DefinitionContext context)
070    {
071        Map<String, Object> json = super._toJSON(context);
072
073        Operator operator = getOperator();
074        if (operator != null)
075        {
076            // TODO use operator.getName()?
077            json.put("criterionOperator", operator.toString().toLowerCase());
078        }
079        
080        json.put("criterionMultipleOperand", getMultipleOperandOperator().name());
081        return json;
082    }
083    
084    @Override
085    public void toSAX(ContentHandler contentHandler, DefinitionContext context) throws SAXException
086    {
087        super.toSAX(contentHandler, context);
088        
089        Operator operator = getOperator();
090        if (operator != null)
091        {
092            // TODO use operator.getName()?
093            XMLUtils.createElement(contentHandler, "test-operator", operator.toString().toLowerCase());
094        }
095        
096        XMLUtils.createElement(contentHandler, "multiple-operand", getMultipleOperandOperator().name());
097    }
098
099    @Override
100    public Query getQuery(Object value, Operator operator, Map<String, Object> allValues, String language, Map<String, Object> contextualParameters)
101    {
102        return super.getQuery(value,  operator != null ? operator : getOperator(), allValues, language, contextualParameters);
103    }
104    
105    @SuppressWarnings("unchecked")
106    public void copyTo(SearchModelCriterionDefinition<T> criterion, Map<String, Object> contextualParameters)
107    {
108        criterion.setModel(getModel());
109        
110        criterion.setName(getName());
111        criterion.setPluginName(getPluginName());
112        criterion.setLabel(getLabel());
113        criterion.setDescription(getDescription());
114        criterion.setWidget(getWidget());
115        criterion.setWidgetParameters(getWidgetParameters());
116        
117        criterion.setType(getType());
118        criterion.setMultiple(isMultiple());
119        
120        criterion.setEnumerator(getEnumerator());
121        criterion.setCustomEnumerator(getCustomEnumerator());
122        criterion.setEnumeratorConfiguration(getEnumeratorConfiguration());
123        
124        criterion.setValidator(getValidator());
125        criterion.setCustomValidator(getCustomValidator());
126        criterion.setValidatorConfiguration(getValidatorConfiguration());
127        
128        criterion.setParsedDefaultValues(getParsedDefaultValues());
129        
130        criterion.setOperator(getOperator());
131        criterion.setMultipleOperandOperator(getMultipleOperandOperator());
132        
133        if (criterion instanceof DefaultSearchModelCriterionDefinition defaultCriterion)
134        {
135            defaultCriterion.setSolrFacetFieldName(getSolrFacetFieldName(contextualParameters));
136            defaultCriterion.setJoinedPaths(getJoinedPaths(contextualParameters));
137        }
138    }
139    
140    @Override
141    public SearchModel getModel()
142    {
143        return (SearchModel) super.getModel();
144    }
145}