001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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.item.server.indexer;
018
019import com.echothree.model.control.core.common.EntityAttributeTypes;
020import com.echothree.model.control.index.common.IndexConstants;
021import com.echothree.model.control.index.common.IndexFieldVariations;
022import com.echothree.model.control.index.common.IndexFields;
023import com.echothree.model.control.item.server.analyzer.HarmonizedTariffScheduleCodeAnalyzer;
024import com.echothree.model.control.index.server.indexer.BaseIndexer;
025import com.echothree.model.control.index.server.indexer.FieldTypes;
026import com.echothree.model.control.item.server.control.ItemControl;
027import com.echothree.model.data.core.server.entity.EntityInstance;
028import com.echothree.model.data.index.server.entity.Index;
029import com.echothree.model.data.item.server.entity.HarmonizedTariffScheduleCode;
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 HarmonizedTariffScheduleCodeIndexer
039        extends BaseIndexer<HarmonizedTariffScheduleCode> {
040    
041    ItemControl itemControl = Session.getModelController(ItemControl.class);
042
043    /** Creates a new instance of HarmonizedTariffScheduleCodeIndexer */
044    public HarmonizedTariffScheduleCodeIndexer(final ExecutionErrorAccumulator eea, final Index index) {
045        super(eea, index);
046    }
047
048    @Override
049    protected Analyzer getAnalyzer() {
050        return new HarmonizedTariffScheduleCodeAnalyzer(eea, language, entityType, entityAliasTypes, entityAttributes, tagScopes);
051    }
052    
053    @Override
054    protected HarmonizedTariffScheduleCode getEntity(final EntityInstance entityInstance) {
055        return itemControl.getHarmonizedTariffScheduleCodeByEntityInstance(entityInstance);
056    }
057    
058    @Override
059    protected Document convertToDocument(final EntityInstance entityInstance, final HarmonizedTariffScheduleCode harmonizedTariffScheduleCode) {
060        var harmonizedTariffScheduleCodeDetail = harmonizedTariffScheduleCode.getLastDetail();
061        var harmonizedTariffScheduleCodeTranslation = itemControl.getBestHarmonizedTariffScheduleCodeTranslation(harmonizedTariffScheduleCode, language);
062
063        var document = newDocumentWithEntityInstanceFields(entityInstance, harmonizedTariffScheduleCode.getPrimaryKey());
064
065        document.add(new Field(IndexFields.countryGeoCodeName.name(), harmonizedTariffScheduleCodeDetail.getCountryGeoCode().getLastDetail().getGeoCodeName(), FieldTypes.NOT_STORED_TOKENIZED));
066        
067        document.add(new Field(IndexFields.harmonizedTariffScheduleCodeName.name(), harmonizedTariffScheduleCodeDetail.getHarmonizedTariffScheduleCodeName(), FieldTypes.NOT_STORED_TOKENIZED));
068        document.add(new SortedDocValuesField(IndexFields.harmonizedTariffScheduleCodeName.name() + IndexConstants.INDEX_FIELD_VARIATION_SEPARATOR + IndexFieldVariations.sortable.name(),
069                new BytesRef(harmonizedTariffScheduleCodeDetail.getHarmonizedTariffScheduleCodeName())));
070
071        if(harmonizedTariffScheduleCodeTranslation != null) {
072            var description = harmonizedTariffScheduleCodeTranslation.getDescription();
073            var overview = harmonizedTariffScheduleCodeTranslation.getOverview();
074            
075            document.add(new Field(IndexFields.description.name(), description, FieldTypes.NOT_STORED_TOKENIZED));
076            document.add(new SortedDocValuesField(IndexFields.description.name() + IndexConstants.INDEX_FIELD_VARIATION_SEPARATOR + IndexFieldVariations.sortable.name(),
077                    new BytesRef(description)));
078            
079            if(overview != null) {
080                if(harmonizedTariffScheduleCodeTranslation.getOverviewMimeType().getLastDetail().getEntityAttributeType().getEntityAttributeTypeName().equals(EntityAttributeTypes.CLOB.name())) {
081                    // TODO: mime type conversion to text/plain happens here
082                    document.add(new Field(IndexFields.overview.name(), overview, FieldTypes.NOT_STORED_TOKENIZED));
083                }
084            }
085        }
086
087        return document;
088    }
089
090}