org.opencms.search.fields.CmsLuceneFieldConfiguration Maven / Gradle / Ivy
Show all versions of opencms-test Show documentation
/*
* This library is part of OpenCms -
* the Open Source Content Management System
*
* Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
*
* 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.
*
* For further information about Alkacon Software, please see the
* company website: http://www.alkacon.com
*
* For further information about OpenCms, please see the
* project website: http://www.opencms.org
*
* 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package org.opencms.search.fields;
import org.opencms.file.CmsPropertyDefinition;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Set;
import org.apache.lucene.analysis.Analyzer;
import org.apache.lucene.analysis.core.WhitespaceAnalyzer;
import org.apache.lucene.analysis.miscellaneous.PerFieldAnalyzerWrapper;
/**
* Describes a configuration of fields that are used in building a search index.
*
* @since 7.0.0
*/
public class CmsLuceneFieldConfiguration extends CmsSearchFieldConfiguration {
/**
* The default for the standard search configuration.
*
* This defines the default that is used in case no "standard" field configuration
* is defined in opencms-search.xml.
*/
public static final CmsLuceneFieldConfiguration DEFAULT_STANDARD = createStandardConfiguration();
/** The description for the standard field configuration. */
public static final String STR_STANDARD_DESCRIPTION = "The standard OpenCms search index field configuration.";
/** The fields that will be returned by a regular search (all stored and not lazy fields). */
private static Set m_returnFields = new HashSet();
static {
m_returnFields.add(CmsSearchField.FIELD_CATEGORY);
m_returnFields.add(CmsSearchField.FIELD_DATE_CONTENT);
m_returnFields.add(CmsSearchField.FIELD_DATE_CREATED);
m_returnFields.add(CmsSearchField.FIELD_DATE_EXPIRED);
m_returnFields.add(CmsSearchField.FIELD_DATE_LASTMODIFIED);
m_returnFields.add(CmsSearchField.FIELD_DATE_RELEASED);
m_returnFields.add(CmsSearchField.FIELD_PARENT_FOLDERS);
m_returnFields.add(CmsSearchField.FIELD_PATH);
m_returnFields.add(CmsSearchField.FIELD_SUFFIX);
m_returnFields.add(CmsSearchField.FIELD_TYPE);
}
/** Contains all names of the fields that are used in the excerpt. */
private List m_excerptFieldNames;
/** The field added flag. */
private boolean m_fieldAdded;
/**
* Creates the default standard search configuration.
*
* This defines the default that is used in case no "standard" field configuration
* is defined in opencms-search.xml.
*
* @return the default standard search configuration
*/
private static CmsLuceneFieldConfiguration createStandardConfiguration() {
CmsLuceneFieldConfiguration result = new CmsLuceneFieldConfiguration();
result.setName(STR_STANDARD);
result.setDescription(STR_STANDARD_DESCRIPTION);
CmsLuceneField field;
// content mapping, store as compressed value
field = new CmsLuceneField(
CmsSearchField.FIELD_CONTENT,
"%(key.field.content)",
true,
true,
true,
true,
true,
null,
CmsSearchField.BOOST_DEFAULT,
null);
field.addMapping(new CmsSearchFieldMapping(CmsSearchFieldMappingType.CONTENT, null, true));
result.addField(field);
// title mapping as a keyword
field = new CmsLuceneField(
CmsSearchField.FIELD_TITLE,
CmsLuceneField.IGNORE_DISPLAY_NAME,
true,
true,
false,
false,
0.0f,
null);
field.addMapping(
new CmsSearchFieldMapping(CmsSearchFieldMappingType.PROPERTY, CmsPropertyDefinition.PROPERTY_TITLE, true));
result.addField(field);
// title mapping as indexed field
field = new CmsLuceneField(CmsSearchField.FIELD_TITLE_UNSTORED, "%(key.field.title)", false, true);
field.addMapping(
new CmsSearchFieldMapping(CmsSearchFieldMappingType.PROPERTY, CmsPropertyDefinition.PROPERTY_TITLE, true));
result.addField(field);
// mapping of "Keywords" property to search field with the same name
field = new CmsLuceneField(CmsSearchField.FIELD_KEYWORDS, "%(key.field.keywords)", true, true);
field.addMapping(
new CmsSearchFieldMapping(
CmsSearchFieldMappingType.PROPERTY,
CmsPropertyDefinition.PROPERTY_KEYWORDS,
true));
result.addField(field);
// mapping of "Description" property to search field with the same name
field = new CmsLuceneField(CmsSearchField.FIELD_DESCRIPTION, "%(key.field.description)", true, true);
field.addMapping(
new CmsSearchFieldMapping(
CmsSearchFieldMappingType.PROPERTY,
CmsPropertyDefinition.PROPERTY_DESCRIPTION,
true));
result.addField(field);
// "meta" field is a combination of "Title", "Keywords" and "Description" properties
field = new CmsLuceneField(CmsSearchField.FIELD_META, "%(key.field.meta)", false, true);
field.addMapping(
new CmsSearchFieldMapping(CmsSearchFieldMappingType.PROPERTY, CmsPropertyDefinition.PROPERTY_TITLE, true));
field.addMapping(
new CmsSearchFieldMapping(
CmsSearchFieldMappingType.PROPERTY,
CmsPropertyDefinition.PROPERTY_KEYWORDS,
true));
field.addMapping(
new CmsSearchFieldMapping(
CmsSearchFieldMappingType.PROPERTY,
CmsPropertyDefinition.PROPERTY_DESCRIPTION,
true));
result.addField(field);
return result;
}
/**
*
* @see org.opencms.search.fields.CmsSearchFieldConfiguration#addField(org.opencms.search.fields.CmsSearchField)
*/
@Override
public void addField(CmsSearchField field) {
super.addField(field);
m_fieldAdded = true;
}
/**
* Returns an analyzer that wraps the given base analyzer with the analyzers of this individual field configuration.
*
* @param analyzer the base analyzer to wrap
*
* @return an analyzer that wraps the given base analyzer with the analyzers of this individual field configuration
*/
public Analyzer getAnalyzer(Analyzer analyzer) {
// parent folder and last modified lookup fields must use whitespace analyzer
WhitespaceAnalyzer ws = new WhitespaceAnalyzer();
Map analyzers = new HashMap();
// first make map the default hard coded fields
analyzers.put(CmsSearchField.FIELD_PARENT_FOLDERS, ws);
analyzers.put(CmsSearchField.FIELD_CATEGORY, ws);
analyzers.put(CmsSearchField.FIELD_DATE_LASTMODIFIED_LOOKUP, ws);
analyzers.put(CmsSearchField.FIELD_DATE_CREATED_LOOKUP, ws);
for (CmsLuceneField field : getLuceneFields()) {
Analyzer fieldAnalyzer = field.getAnalyzer();
if (fieldAnalyzer != null) {
// this field has an individual analyzer configured
analyzers.put(field.getName(), fieldAnalyzer);
}
}
// return the individual field configured analyzer
return new PerFieldAnalyzerWrapper(analyzer, analyzers);
}
/**
* Returns a list of all field names (Strings) that are used in generating the search excerpt.
*
* @return a list of all field names (Strings) that are used in generating the search excerpt
*/
public List getExcerptFieldNames() {
if (m_excerptFieldNames == null) {
// lazy initialize the field names
m_excerptFieldNames = new ArrayList();
Iterator i = getFields().iterator();
while (i.hasNext()) {
CmsLuceneField field = (CmsLuceneField)i.next();
if (field.isInExcerptAndStored()) {
m_excerptFieldNames.add(field.getName());
}
}
}
// create a copy of the list to prevent changes in other classes
return new ArrayList(m_excerptFieldNames);
}
/**
* Returns the field names used for the excerpt generation.
*
* @return the field names used for the excerpt generation
*/
public Set getExcerptFields() {
return new HashSet(getExcerptFieldNames());
}
/**
* Returns a list of the concrete Lucene search fields.
*
* @return a list of lucene search fields
*/
public List getLuceneFields() {
List result = new ArrayList();
for (CmsSearchField field : getFields()) {
if (field instanceof CmsLuceneField) {
result.add((CmsLuceneField)field);
}
}
return result;
}
/**
* Returns the field names used for a regular result.
*
* @return the field names used for a regular result
*/
public Set getReturnFields() {
if (m_fieldAdded) {
for (CmsSearchField field : getLuceneFields()) {
if (field.isStored() && !LAZY_FIELDS.contains(field.getName())) {
m_returnFields.add(field.getName());
}
}
}
m_fieldAdded = false;
return m_returnFields;
}
}