evolvedbinary / elemental / 982

Committed 29 Apr 2025 08:34PM UTC coverage: 56.409% (+0.007%) from 56.402%

Build # 982

Build Type

push

circleci

Committed by

adamretter

Commit Message

[feature] Improve README.md badges

Run Details

28451 of 55847 branches covered (50.94%)

Branch coverage included in aggregate %.

77468 of 131924 relevant lines covered (58.72%)

0.59 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

67.35

/extensions/indexes/lucene/src/main/java/org/exist/indexing/lucene/FieldType.java

/*
 * Elemental
 * Copyright (C) 2024, Evolved Binary Ltd
 *
 * admin@evolvedbinary.com
 * https://www.evolvedbinary.com | https://www.elemental.xyz
 *
 * Use of this software is governed by the Business Source License 1.1
 * included in the LICENSE file and at www.mariadb.com/bsl11.
 *
 * Change Date: 2028-04-27
 *
 * On the date above, in accordance with the Business Source License, use
 * of this software will be governed by the Apache License, Version 2.0.
 *
 * Additional Use Grant: Production use of the Licensed Work for a permitted
 * purpose. A Permitted Purpose is any purpose other than a Competing Use.
 * A Competing Use means making the Software available to others in a commercial
 * product or service that: substitutes for the Software; substitutes for any
 * other product or service we offer using the Software that exists as of the
 * date we make the Software available; or offers the same or substantially
 * similar functionality as the Software.
 *
 * NOTE: Parts of this file contain code from 'The eXist-db Authors'.
 *       The original license header is included below.
 *
 * =====================================================================
 *
 * eXist-db Open Source Native XML Database
 * Copyright (C) 2001 The eXist-db Authors
 *
 * info@exist-db.org
 * http://www.exist-db.org
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
package org.exist.indexing.lucene;

import org.apache.lucene.analysis.Analyzer;
import org.apache.lucene.document.Field;
import org.exist.indexing.lucene.analyzers.MetaAnalyzer;
import org.exist.util.DatabaseConfigurationException;
import org.w3c.dom.Element;

/**
 * Configures a field type: analyzers etc. used for indexing
 * a field.
 * 
 * @author wolf
 *
 */
public class FieldType {

        private final static String ID_ATTR = "id";
        private final static String ANALYZER_ID_ATTR = "analyzer";
        private final static String BOOST_ATTRIB = "boost";
        private final static String STORE_ATTRIB = "store";
        
        private String id = null;
        
        private String analyzerId = null;
        
    // save Analyzer for later use in LuceneMatchListener
    private final MetaAnalyzer analyzer;

        private float boost = -1;
    
        private Field.Store store = null;
        
    public FieldType(Element config, AnalyzerConfig analyzers) throws DatabaseConfigurationException {
        
            if (LuceneConfig.FIELD_TYPE_ELEMENT.equals(config.getLocalName())) {
                    id = config.getAttribute(ID_ATTR).trim();
            if (id.isEmpty())
                            throw new DatabaseConfigurationException("fieldType needs an attribute 'id'");
            }

            String aId = config.getAttribute(ANALYZER_ID_ATTR).trim();
            // save Analyzer for later use in LuceneMatchListener
        if (!aId.isEmpty()) {
                final Analyzer configuredAnalyzer = analyzers.getAnalyzerById(aId);
            if (configuredAnalyzer == null)
                throw new DatabaseConfigurationException("No analyzer configured for id " + aId);
            analyzerId = aId;
            analyzer = new MetaAnalyzer(configuredAnalyzer);
        } else {
                analyzer = new MetaAnalyzer(analyzers.getDefaultAnalyzer());
        }
        
        String boostAttr = config.getAttribute(BOOST_ATTRIB).trim();
        if (!boostAttr.isEmpty()) {
            try {
                boost = Float.parseFloat(boostAttr);
            } catch (NumberFormatException e) {
                throw new DatabaseConfigurationException("Invalid value for attribute 'boost'. Expected float, " +
                        "got: " + boostAttr);
            }
        }
        
        String storeAttr = config.getAttribute(STORE_ATTRIB).trim();
        if (!storeAttr.isEmpty()) {
                store = storeAttr.equalsIgnoreCase("yes") ? Field.Store.YES : Field.Store.NO;
        }
    }
    
    public String getId() {
                return id;
        }

        public String getAnalyzerId() {
                return analyzerId;
        }

        public Analyzer getAnalyzer() {
                return analyzer;
        }

        public void addAnalzer(String fieldName, Analyzer analyzer) {
                this.analyzer.addAnalyzer(fieldName, analyzer);
        }

        public float getBoost() {
                return boost;
        }
        
        public Field.Store getStore() {
                return store;
        }
}

1	/*
2	* Elemental
3	* Copyright (C) 2024, Evolved Binary Ltd
4	*
5	* admin@evolvedbinary.com
6	* https://www.evolvedbinary.com \| https://www.elemental.xyz
7	*
8	* Use of this software is governed by the Business Source License 1.1
9	* included in the LICENSE file and at www.mariadb.com/bsl11.
10	*
11	* Change Date: 2028-04-27
12	*
13	* On the date above, in accordance with the Business Source License, use
14	* of this software will be governed by the Apache License, Version 2.0.
15	*
16	* Additional Use Grant: Production use of the Licensed Work for a permitted
17	* purpose. A Permitted Purpose is any purpose other than a Competing Use.
18	* A Competing Use means making the Software available to others in a commercial
19	* product or service that: substitutes for the Software; substitutes for any
20	* other product or service we offer using the Software that exists as of the
21	* date we make the Software available; or offers the same or substantially
22	* similar functionality as the Software.
23	*
24	* NOTE: Parts of this file contain code from 'The eXist-db Authors'.
25	* The original license header is included below.
26	*
27	* =====================================================================
28	*
29	* eXist-db Open Source Native XML Database
30	* Copyright (C) 2001 The eXist-db Authors
31	*
32	* info@exist-db.org
33	* http://www.exist-db.org
34	*
35	* This library is free software; you can redistribute it and/or
36	* modify it under the terms of the GNU Lesser General Public
37	* License as published by the Free Software Foundation; either
38	* version 2.1 of the License, or (at your option) any later version.
39	*
40	* This library is distributed in the hope that it will be useful,
41	* but WITHOUT ANY WARRANTY; without even the implied warranty of
42	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
43	* Lesser General Public License for more details.
44	*
45	* You should have received a copy of the GNU Lesser General Public
46	* License along with this library; if not, write to the Free Software
47	* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
48	*/
49	package org.exist.indexing.lucene;
50
51	import org.apache.lucene.analysis.Analyzer;
52	import org.apache.lucene.document.Field;
53	import org.exist.indexing.lucene.analyzers.MetaAnalyzer;
54	import org.exist.util.DatabaseConfigurationException;
55	import org.w3c.dom.Element;
56
57	/**
58	* Configures a field type: analyzers etc. used for indexing
59	* a field.
60	*
61	* @author wolf
62	*
63	*/
64	public class FieldType {
65
66	private final static String ID_ATTR = "id";
67	private final static String ANALYZER_ID_ATTR = "analyzer";
68	private final static String BOOST_ATTRIB = "boost";
69	private final static String STORE_ATTRIB = "store";
70
71	private String id = null;	1✔
72
73	private String analyzerId = null;	1✔
74
75	// save Analyzer for later use in LuceneMatchListener
76	private final MetaAnalyzer analyzer;
77
78	private float boost = -1;	1✔
79
80	private Field.Store store = null;	1✔
81
82	public FieldType(Element config, AnalyzerConfig analyzers) throws DatabaseConfigurationException {	1✔
83
84	if (LuceneConfig.FIELD_TYPE_ELEMENT.equals(config.getLocalName())) {	1!
85	id = config.getAttribute(ID_ATTR).trim();	×
86	if (id.isEmpty())	×
87	throw new DatabaseConfigurationException("fieldType needs an attribute 'id'");	×
88	}
89
90	String aId = config.getAttribute(ANALYZER_ID_ATTR).trim();	1✔
91	// save Analyzer for later use in LuceneMatchListener
92	if (!aId.isEmpty()) {	1✔
93	final Analyzer configuredAnalyzer = analyzers.getAnalyzerById(aId);	1✔
94	if (configuredAnalyzer == null)	1!
95	throw new DatabaseConfigurationException("No analyzer configured for id " + aId);	×
96	analyzerId = aId;	1✔
97	analyzer = new MetaAnalyzer(configuredAnalyzer);	1✔
98	} else {	1✔
99	analyzer = new MetaAnalyzer(analyzers.getDefaultAnalyzer());	1✔
100	}
101
102	String boostAttr = config.getAttribute(BOOST_ATTRIB).trim();	1✔
103	if (!boostAttr.isEmpty()) {	1✔
104	try {
105	boost = Float.parseFloat(boostAttr);	1✔
106	} catch (NumberFormatException e) {	×
107	throw new DatabaseConfigurationException("Invalid value for attribute 'boost'. Expected float, " +	×
108	"got: " + boostAttr);
109	}	1✔
110	}
111
112	String storeAttr = config.getAttribute(STORE_ATTRIB).trim();	1✔
113	if (!storeAttr.isEmpty()) {	1!
114	store = storeAttr.equalsIgnoreCase("yes") ? Field.Store.YES : Field.Store.NO;	×
115	}
116	}	1✔
117
118	public String getId() {
119	return id;	×
120	}
121
122	public String getAnalyzerId() {
123	return analyzerId;	1✔
124	}
125
126	public Analyzer getAnalyzer() {
127	return analyzer;	1✔
128	}
129
130	public void addAnalzer(String fieldName, Analyzer analyzer) {
131	this.analyzer.addAnalyzer(fieldName, analyzer);	1✔
132	}	1✔
133
134	public float getBoost() {
135	return boost;	1✔
136	}
137
138	public Field.Store getStore() {
139	return store;	×
140	}
141	}

evolvedbinary / elemental / 982

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous