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.offer.server.indexer;
018
019import com.echothree.model.control.index.common.IndexConstants;
020import com.echothree.model.control.index.common.IndexFieldVariations;
021import com.echothree.model.control.index.common.IndexFields;
022import com.echothree.model.control.index.server.analysis.UseAnalyzer;
023import com.echothree.model.control.index.server.indexer.BaseIndexer;
024import com.echothree.model.control.index.server.indexer.FieldTypes;
025import com.echothree.model.control.offer.server.control.UseControl;
026import com.echothree.model.data.core.server.entity.EntityInstance;
027import com.echothree.model.data.index.server.entity.Index;
028import com.echothree.model.data.offer.server.entity.Use;
029import com.echothree.model.data.offer.server.entity.UseDetail;
030import com.echothree.util.server.message.ExecutionErrorAccumulator;
031import com.echothree.util.server.persistence.Session;
032import org.apache.lucene.analysis.Analyzer;
033import org.apache.lucene.document.Document;
034import org.apache.lucene.document.Field;
035import org.apache.lucene.document.SortedDocValuesField;
036import org.apache.lucene.util.BytesRef;
037
038public class UseIndexer
039        extends BaseIndexer<Use> {
040
041    UseControl useControl = Session.getModelController(UseControl.class);
042
043    /** Creates a new instance of UseIndexer */
044    public UseIndexer(final ExecutionErrorAccumulator eea, final Index index) {
045        super(eea, index);
046    }
047
048    @Override
049    protected Analyzer getAnalyzer() {
050        return new UseAnalyzer(eea, language, entityType, entityAliasTypes, entityAttributes, tagScopes);
051    }
052    
053    @Override
054    protected Use getEntity(final EntityInstance entityInstance) {
055        return useControl.getUseByEntityInstance(entityInstance);
056    }
057    
058    @Override
059    protected Document convertToDocument(final EntityInstance entityInstance, final Use use) {
060        UseDetail useDetail = use.getLastDetail();
061        String description = useControl.getBestUseDescription(use, language);
062
063        var document = newDocumentWithEntityInstanceFields(entityInstance, use.getPrimaryKey());
064
065        document.add(new Field(IndexFields.useName.name(), useDetail.getUseName(), FieldTypes.NOT_STORED_TOKENIZED));
066        document.add(new SortedDocValuesField(IndexFields.useName.name() + IndexConstants.INDEX_FIELD_VARIATION_SEPARATOR + IndexFieldVariations.sortable.name(),
067                new BytesRef(useDetail.getUseName())));
068        
069        if(description != null) {
070            document.add(new Field(IndexFields.description.name(), description, FieldTypes.NOT_STORED_TOKENIZED));
071            document.add(new SortedDocValuesField(IndexFields.description.name() + IndexConstants.INDEX_FIELD_VARIATION_SEPARATOR + IndexFieldVariations.sortable.name(),
072                    new BytesRef(description)));
073        }
074
075        return document;
076    }
077
078}