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.core.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.core.server.analyzer.EntityAttributeAnalyzer;
023import com.echothree.model.control.index.server.indexer.BaseIndexer;
024import com.echothree.model.control.index.server.indexer.FieldTypes;
025import com.echothree.model.data.core.server.entity.EntityAttribute;
026import com.echothree.model.data.core.server.entity.EntityInstance;
027import com.echothree.model.data.index.server.entity.Index;
028import com.echothree.util.server.message.ExecutionErrorAccumulator;
029import org.apache.lucene.analysis.Analyzer;
030import org.apache.lucene.document.Document;
031import org.apache.lucene.document.Field;
032import org.apache.lucene.document.SortedDocValuesField;
033import org.apache.lucene.util.BytesRef;
034
035public class EntityAttributeIndexer
036        extends BaseIndexer<EntityAttribute> {
037    
038    /** Creates a new instance of EntityAttributeIndexer */
039    public EntityAttributeIndexer(final ExecutionErrorAccumulator eea, final Index index) {
040        super(eea, index);
041    }
042
043    @Override
044    protected Analyzer getAnalyzer() {
045        return new EntityAttributeAnalyzer(eea, language, entityType, entityAliasTypes, entityAttributes, tagScopes);
046    }
047    
048    @Override
049    protected EntityAttribute getEntity(final EntityInstance entityInstance) {
050        return coreControl.getEntityAttributeByEntityInstance(entityInstance);
051    }
052    
053    @Override
054    protected Document convertToDocument(final EntityInstance entityInstance, final EntityAttribute entityAttribute) {
055        var entityAttributeDetail = entityAttribute.getLastDetail();
056        var entityTypeDetail = entityAttributeDetail.getEntityType().getLastDetail();
057        var description = coreControl.getBestEntityAttributeDescription(entityAttribute, language);
058
059        var document = newDocumentWithEntityInstanceFields(entityInstance, entityAttribute.getPrimaryKey());
060
061        document.add(new Field(IndexFields.componentVendorName.name(),
062                entityTypeDetail.getComponentVendor().getLastDetail().getComponentVendorName(), FieldTypes.NOT_STORED_TOKENIZED));
063        document.add(new SortedDocValuesField(IndexFields.componentVendorName.name() + IndexConstants.INDEX_FIELD_VARIATION_SEPARATOR + IndexFieldVariations.sortable.name(),
064                new BytesRef(entityTypeDetail.getComponentVendor().getLastDetail().getComponentVendorName())));
065        document.add(new Field(IndexFields.entityTypeName.name(),
066                entityTypeDetail.getEntityTypeName(), FieldTypes.NOT_STORED_TOKENIZED));
067        document.add(new SortedDocValuesField(IndexFields.entityTypeName.name() + IndexConstants.INDEX_FIELD_VARIATION_SEPARATOR + IndexFieldVariations.sortable.name(),
068                new BytesRef(entityTypeDetail.getEntityTypeName())));
069        document.add(new Field(IndexFields.entityAttributeName.name(),
070                entityAttributeDetail.getEntityAttribute().getLastDetail().getEntityAttributeName(), FieldTypes.NOT_STORED_TOKENIZED));
071        document.add(new SortedDocValuesField(IndexFields.entityAttributeName.name() + IndexConstants.INDEX_FIELD_VARIATION_SEPARATOR + IndexFieldVariations.sortable.name(),
072                new BytesRef(entityAttributeDetail.getEntityAttribute().getLastDetail().getEntityAttributeName())));
073        document.add(new Field(IndexFields.entityAttributeTypeName.name(),
074                entityAttributeDetail.getEntityAttributeType().getEntityAttributeTypeName(), FieldTypes.NOT_STORED_TOKENIZED));
075        document.add(new Field(IndexFields.trackRevisions.name(), entityAttributeDetail.getTrackRevisions().toString(), FieldTypes.NOT_STORED_NOT_TOKENIZED));
076
077        if(description != null) {
078            document.add(new Field(IndexFields.description.name(), description, FieldTypes.NOT_STORED_TOKENIZED));
079            document.add(new SortedDocValuesField(IndexFields.description.name() + IndexConstants.INDEX_FIELD_VARIATION_SEPARATOR + IndexFieldVariations.sortable.name(),
080                    new BytesRef(description)));
081        }
082
083        return document;
084    }
085
086}