org.elasticsearch.hadoop.serialization.dto.mapping.MappingUtils Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of elasticsearch-spark-20_2.11 Show documentation
Show all versions of elasticsearch-spark-20_2.11 Show documentation
Elasticsearch Spark (for Spark 2.X)
/*
* Licensed to Elasticsearch under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch licenses this file to you 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 org.elasticsearch.hadoop.serialization.dto.mapping;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.HashSet;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Set;
import org.apache.commons.logging.Log;
import org.elasticsearch.hadoop.EsHadoopIllegalArgumentException;
import org.elasticsearch.hadoop.cfg.FieldPresenceValidation;
import org.elasticsearch.hadoop.cfg.Settings;
import org.elasticsearch.hadoop.serialization.FieldType;
import org.elasticsearch.hadoop.serialization.dto.mapping.GeoField.GeoType;
import org.elasticsearch.hadoop.util.StringUtils;
@SuppressWarnings("rawtypes")
public abstract class MappingUtils {
private static final Set BUILT_IN_FIELDS = new HashSet();
static {
BUILT_IN_FIELDS.addAll(Arrays.asList("_uid", "_id", "_type", "_source", "_all", "_analyzer", "_boost",
"_parent", "_routing", "_index", "_size", "_timestamp", "_ttl", "_field_names", "_meta"));
}
public static void validateMapping(String fields, Mapping mapping, FieldPresenceValidation validation, Log log) {
if (StringUtils.hasText(fields)) {
validateMapping(StringUtils.tokenize(fields), mapping, validation, log);
}
}
public static void validateMapping(Collection fields, Mapping mapping, FieldPresenceValidation validation, Log log) {
if (mapping == null || fields == null || fields.isEmpty() || validation == null || FieldPresenceValidation.IGNORE == validation) {
return;
}
List[] results = findTypos(fields, mapping);
if (results == null) {
return;
}
String message = String.format("Field(s) [%s] not found in the Elasticsearch mapping specified; did you mean [%s]?",
removeDoubleBrackets(results[0]), removeDoubleBrackets(results[1]));
if (validation == FieldPresenceValidation.WARN) {
log.warn(message);
}
else {
throw new EsHadoopIllegalArgumentException(message);
}
}
// return a tuple for proper messages
static List[] findTypos(Collection fields, Mapping mapping) {
Set keys = mapping.flatten().keySet();
// find missing
List missing = new ArrayList(fields.size());
for (String field : fields) {
if (!keys.contains(field) && !isBuiltIn(field)) {
missing.add(field);
}
}
if (missing.isEmpty()) {
return null;
}
Map unwrapped = new LinkedHashMap();
// find similar
for (String key : keys) {
int match = key.lastIndexOf(".");
if (match > 0) {
String leafField = key.substring(match + 1);
// leaf fields are secondary to top-level ones (in case of overwrite, the top level ones win)
if (!unwrapped.containsKey(leafField)) {
unwrapped.put(leafField, key);
}
}
unwrapped.put(key, key);
}
List typos = new ArrayList();
Set similar = unwrapped.keySet();
for (String string : missing) {
List matches = StringUtils.findSimiliar(string, similar);
for (String match : matches) {
// get actual field
typos.add(unwrapped.get(match));
}
}
return new List[] { missing, typos };
}
private static boolean isBuiltIn(String field) {
return BUILT_IN_FIELDS.contains(field);
}
private static String removeDoubleBrackets(List col) {
if (col.isEmpty()) {
return "";
}
if (col.size() == 1) {
return col.get(0).toString();
}
return col.toString();
}
public static Mapping filterMapping(Mapping mapping, Settings cfg) {
String readIncludeCfg = cfg.getReadFieldInclude();
String readExcludeCfg = cfg.getReadFieldExclude();
return mapping.filter(StringUtils.tokenize(readIncludeCfg), StringUtils.tokenize(readExcludeCfg));
}
public static Map geoFields(Mapping rootMapping) {
if (rootMapping == null) {
return Collections.emptyMap();
}
Map geoFields = new LinkedHashMap();
// ignore the root field
for (Field nestedField : rootMapping.getFields()) {
findGeo(nestedField, null, geoFields);
}
return geoFields;
}
private static void findGeo(Field field, String parentName, Map geoFields) {
String fieldName = (parentName != null ? parentName + "." + field.name() : field.name());
if (FieldType.GEO_POINT == field.type()) {
geoFields.put(fieldName, GeoType.GEO_POINT);
}
else if (FieldType.GEO_SHAPE == field.type()) {
geoFields.put(fieldName, GeoType.GEO_SHAPE);
}
else if (FieldType.isCompound(field.type())) {
for (Field nestedField : field.properties()) {
findGeo(nestedField, fieldName, geoFields);
}
}
}
public static GeoField parseGeoInfo(GeoType geoType, Object parsedContent) {
if (geoType == GeoType.GEO_POINT) {
return doParseGeoPointInfo(parsedContent);
}
if (geoType == GeoType.GEO_SHAPE) {
return doParseGeoShapeInfo(parsedContent);
}
throw new EsHadoopIllegalArgumentException(String.format(Locale.ROOT, "Unknown GeoType %s", geoType));
}
private static GeoField doParseGeoPointInfo(Object parsedContent) {
if (parsedContent instanceof List) {
Object content = ((List) parsedContent).get(0);
if (content instanceof Double) {
return GeoPointType.LON_LAT_ARRAY;
}
}
if (parsedContent instanceof String) {
// check whether it's lat/lon or geohash
return ((String) parsedContent).contains(",") ? GeoPointType.LAT_LON_STRING : GeoPointType.GEOHASH;
}
return GeoPointType.LAT_LON_OBJECT;
}
private static GeoField doParseGeoShapeInfo(Object parsedContent) {
if (parsedContent instanceof Map) {
Map geoShape = (Map) parsedContent;
Object typ = geoShape.get("type");
if (typ == null) {
throw new EsHadoopIllegalArgumentException(String.format(
Locale.ROOT, "Invalid GeoShape [%s]", parsedContent));
}
String type = typ.toString();
GeoShapeType found = GeoShapeType.parse(type);
if (found != null) {
return found;
}
}
throw new EsHadoopIllegalArgumentException(String.format(Locale.ROOT, "Unknown GeoShape [%s]", parsedContent));
}
/**
* If "es.mapping.join" is set, this returns the field name for the join field's parent sub-field.
* @param settings to pull info from
* @return the parent sub-field to pull routing information from.
*/
public static String joinParentField(Settings settings) {
if (StringUtils.hasText(settings.getMappingJoin())) {
return settings.getMappingJoin().concat(".parent");
}
return null;
}
}