001// --------------------------------------------------------------------------------
002// Copyright 2002-2024 Echo Three, LLC
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// --------------------------------------------------------------------------------
016
017package com.echothree.model.control.security.server.search;
018
019import com.echothree.model.control.core.common.ComponentVendors;
020import com.echothree.model.control.core.common.EntityTypes;
021import com.echothree.model.control.index.common.IndexConstants;
022import com.echothree.model.control.index.common.IndexFieldVariations;
023import com.echothree.model.control.index.common.IndexFields;
024import com.echothree.model.control.index.common.IndexTypes;
025import com.echothree.model.control.index.server.analysis.SecurityRoleAnalyzer;
026import com.echothree.model.control.search.common.SearchSortOrders;
027import com.echothree.model.control.search.common.SearchSortDirections;
028import com.echothree.model.control.search.server.search.BaseSearchEvaluator;
029import com.echothree.model.control.search.server.search.EntityInstancePKHolder;
030import com.echothree.model.data.party.server.entity.Language;
031import com.echothree.model.data.search.server.entity.SearchDefaultOperator;
032import com.echothree.model.data.search.server.entity.SearchSortDirection;
033import com.echothree.model.data.search.server.entity.SearchSortOrder;
034import com.echothree.model.data.search.server.entity.SearchType;
035import com.echothree.model.data.search.server.entity.SearchUseType;
036import com.echothree.model.data.user.server.entity.UserVisit;
037import com.echothree.util.server.message.ExecutionErrorAccumulator;
038import org.apache.lucene.analysis.Analyzer;
039import org.apache.lucene.search.SortField;
040
041public class SecurityRoleSearchEvaluator
042        extends BaseSearchEvaluator {
043    
044    /** Creates a new instance of SecurityRoleSearchEvaluator */
045    public SecurityRoleSearchEvaluator(UserVisit userVisit, Language language, SearchType searchType, SearchDefaultOperator searchDefaultOperator,
046            SearchSortOrder searchSortOrder, SearchSortDirection searchSortDirection, SearchUseType searchUseType) {
047        super(userVisit, searchDefaultOperator, searchType, searchSortOrder, searchSortDirection, searchUseType, ComponentVendors.ECHO_THREE.name(),
048                EntityTypes.SecurityRole.name(), IndexTypes.SECURITY_ROLE.name(), language, null);
049        
050        setField(IndexFields.description.name());
051    }
052
053    @Override
054    public SortField[] getSortFields(String searchSortOrderName) {
055        SortField[] sortFields = null;
056        boolean reverse = searchSortDirection.getLastDetail().getSearchSortDirectionName().equals(SearchSortDirections.DESCENDING.name());
057        
058        if(searchSortOrderName.equals(SearchSortOrders.SCORE.name())) {
059            sortFields = new SortField[]{
060                new SortField(null, SortField.Type.SCORE, reverse),
061                new SortField(IndexFields.description.name() + IndexConstants.INDEX_FIELD_VARIATION_SEPARATOR + IndexFieldVariations.sortable.name(), SortField.Type.STRING, reverse)
062            };
063        } else if(searchSortOrderName.equals(SearchSortOrders.DESCRIPTION.name())) {
064            sortFields = new SortField[]{new SortField(IndexFields.description.name() + IndexConstants.INDEX_FIELD_VARIATION_SEPARATOR + IndexFieldVariations.sortable.name(), SortField.Type.STRING, reverse)};
065        } else if(searchSortOrderName.equals(SearchSortOrders.SECURITY_ROLE_NAME.name())) {
066            sortFields = new SortField[]{
067                new SortField(IndexFields.securityRoleGroupName.name() + IndexConstants.INDEX_FIELD_VARIATION_SEPARATOR + IndexFieldVariations.sortable.name(), SortField.Type.STRING, reverse),
068                new SortField(IndexFields.securityRoleName.name() + IndexConstants.INDEX_FIELD_VARIATION_SEPARATOR + IndexFieldVariations.sortable.name(), SortField.Type.STRING, reverse)
069            };
070        } else if(searchSortOrderName.equals(SearchSortOrders.CREATED_TIME.name())) {
071            sortFields = new SortField[]{new SortField(IndexFields.createdTime.name(), SortField.Type.LONG, reverse)};
072        } else if(searchSortOrderName.equals(SearchSortOrders.MODIFIED_TIME.name())) {
073            sortFields = new SortField[]{new SortField(IndexFields.modifiedTime.name(), SortField.Type.LONG, reverse)};
074        }
075        
076        return sortFields;
077    }
078    
079    @Override
080    public Analyzer getAnalyzer(final ExecutionErrorAccumulator eea, final Language language) {
081        return new SecurityRoleAnalyzer(eea, language, entityType);
082    }
083    
084    protected EntityInstancePKHolder executeQSearch(final ExecutionErrorAccumulator eea, EntityInstancePKHolder resultSet) {
085        if(resultSet == null || resultSet.size() > 0) {
086            if(q != null) {
087                if(resultSet == null || resultSet.size() > 0) {
088                    EntityInstancePKHolder entityInstancePKHolder = executeQuery(eea);
089
090                    if(resultSet == null) {
091                        resultSet = entityInstancePKHolder;
092                    } else {
093                        resultSet.retainAll(entityInstancePKHolder);
094                    }
095                }
096            }
097        }
098        
099        return resultSet;
100    }
101    
102    @Override
103    protected EntityInstancePKHolder executeSearch(final ExecutionErrorAccumulator eea) {
104        EntityInstancePKHolder resultSet = super.executeSearch(eea);
105        
106        resultSet = executeQSearch(eea, resultSet);
107        
108        return resultSet;
109    }
110
111}