com.stratio.cassandra.lucene.schema.Schema Maven / Gradle / Ivy
/*
* Copyright (C) 2014 Stratio (http://stratio.com)
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.stratio.cassandra.lucene.schema;
import com.google.common.base.MoreObjects;
import com.stratio.cassandra.lucene.IndexException;
import com.stratio.cassandra.lucene.column.Column;
import com.stratio.cassandra.lucene.column.Columns;
import com.stratio.cassandra.lucene.schema.mapping.Mapper;
import com.stratio.cassandra.lucene.search.Search;
import org.apache.cassandra.config.ColumnDefinition;
import org.apache.lucene.analysis.Analyzer;
import org.apache.lucene.index.IndexableField;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.io.Closeable;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.stream.Collectors;
/**
* The user-defined mapping from Cassandra columns to Lucene documents.
*
* @author Andres de la Pena {@literal }
*/
public class Schema implements Closeable {
private static final Logger logger = LoggerFactory.getLogger(Schema.class);
/** The {@link Columns} {@link Mapper}s. */
public final Map mappers;
/** The wrapping all-in-one {@link Analyzer}. */
private final SchemaAnalyzer analyzer;
/** The names of the mapped cells. */
private final Set mappedCells;
/**
* Returns a new {@code Schema} for the specified {@link Mapper}s and {@link Analyzer}s.
*
* @param defaultAnalyzer the default {@link Analyzer} to be used
* @param mappers the per field {@link Mapper}s builders to be used
* @param analyzers the per field {@link Analyzer}s to be used
*/
public Schema(Analyzer defaultAnalyzer, Map mappers, Map analyzers) {
this.mappers = mappers;
this.analyzer = new SchemaAnalyzer(defaultAnalyzer, analyzers, mappers);
mappedCells = mappers.values()
.stream()
.flatMap(x -> x.mappedColumns.stream())
.map(x -> Column.parse(x).cellName())
.collect(Collectors.toSet());
}
/**
* Returns the used {@link Analyzer}.
*
* @return the used {@link Analyzer}
*/
public Analyzer analyzer() {
return analyzer;
}
/**
* Returns the default {@link Analyzer}.
*
* @return the default {@link Analyzer}
*/
public Analyzer defaultAnalyzer() {
return analyzer.getDefaultAnalyzer().getAnalyzer();
}
/**
* Returns the {@link Analyzer} identified by the specified field name.
*
* @param fieldName a field name
* @return an {@link Analyzer}
*/
public Analyzer analyzer(String fieldName) {
return analyzer.getAnalyzer(fieldName).getAnalyzer();
}
/**
* Returns the {@link Mapper} identified by the specified field name, or {@code null} if not found.
*
* @param field a field name
* @return the mapper, or {@code null} if not found.
*/
public Mapper mapper(String field) {
String mapperName = Column.parse(field).mapperName();
return mappers.get(mapperName);
}
/**
* Returns the names of the cells mapped by the mappers.
*
* @return the names of the mapped cells
*/
public Set mappedCells() {
return mappedCells;
}
/**
* Validates the specified {@link Columns} for mapping.
*
* @param columns the {@link Columns} to be validated
*/
public void validate(Columns columns) {
for (Mapper mapper : mappers.values()) {
mapper.validate(columns);
}
}
/**
* Returns the Lucene {@link IndexableField}s resulting from the mapping of the specified {@link Columns}. This
* is done in a best-effort way, so each mapper errors are logged and ignored.
*
* @param columns the {@link Columns} to be added
* @return a list of indexable fields
*/
public List indexableFields(Columns columns) {
List fields = new LinkedList<>();
for (Mapper mapper : mappers.values()) {
try {
fields.addAll(mapper.indexableFields(columns));
} catch (IndexException e) {
logger.warn("Error in Lucene index:\n\t" +
"while mapping : {}\n\t" +
"with mapper : {}\n\t" +
"caused by : {}", columns, mapper, e.getMessage());
}
}
return fields;
}
/**
* Returns the Lucene {@link IndexableField}s resulting from the mapping of the specified {@link Columns} only if
* they are required by the post processing phase of the specified {@link Search}.
*
* @param columns the {@link Columns} to be added
* @param search a search
* @return a list of indexable fields
*/
public List postProcessingIndexableFields(Columns columns, Search search) {
List fields = new LinkedList<>();
search.postProcessingFields().forEach(field -> {
Mapper mapper = mapper(field);
if (mapper != null) {
fields.addAll(mapper.indexableFields(columns));
}
});
return fields;
}
/**
* Returns if this has any mapping for the specified column definition.
*
* @param columnDefinition the column definition
* @return {@code true} if there is any mapping for the column, {@code false} otherwise
*/
public boolean maps(ColumnDefinition columnDefinition) {
String columnName = columnDefinition.name.toString();
return mappers.values().stream().anyMatch(mapper -> mapper.maps(columnName));
}
/** {@inheritDoc} */
@Override
public void close() {
analyzer.close();
}
/** {@inheritDoc} */
@Override
public String toString() {
return MoreObjects.toStringHelper(this).add("mappers", mappers).add("analyzer", analyzer).toString();
}
}