org.apache.solr.update.processor.ParseIntFieldUpdateProcessorFactory Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of solr-core Show documentation
Apache Solr (module: core)
There is a newer version: 9.7.0
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF 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.apache.solr.update.processor;

import java.lang.invoke.MethodHandles;
import java.text.NumberFormat;
import java.text.ParsePosition;
import java.util.Locale;
import org.apache.solr.request.SolrQueryRequest;
import org.apache.solr.response.SolrQueryResponse;
import org.apache.solr.schema.FieldType;
import org.apache.solr.schema.IntValueFieldType;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Attempts to mutate selected fields that have only CharSequence-typed values into Integer values.
 * Grouping separators (',' in the ROOT locale) are parsed.
 *
 * The default selection behavior is to mutate both those fields that don't match a schema field,
 * as well as those fields that match a schema field with an int field type.
 *
 * 
If all values are parseable as int (or are already Integer), then the field will be mutated,
 * replacing each value with its parsed Integer equivalent; otherwise, no mutation will occur.
 *
 * 
The locale to use when parsing field values, which will affect the recognized grouping
 * separator character, may optionally be specified. If no locale is configured, then {@link
 * Locale#ROOT} will be used. The following configuration specifies the Russian/Russia locale, which
 * will parse the string "12 345 899" as 12345899L (the grouping separator character is U+00AO
 * NO-BREAK SPACE).
 *
 * 
 * <processor class="solr.ParseIntFieldUpdateProcessorFactory">
 *   <str name="locale">ru_RU</str>
 * </processor>
 *
 * See {@link Locale} for a description of acceptable language, country (optional) and variant
 * (optional) values, joined with underscore(s).
 *
 * @since 4.4.0
 */
public class ParseIntFieldUpdateProcessorFactory extends ParseNumericFieldUpdateProcessorFactory {

  private static final Logger log = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());

  @Override
  public UpdateRequestProcessor getInstance(
      SolrQueryRequest req, SolrQueryResponse rsp, UpdateRequestProcessor next) {
    return new ParseIntFieldUpdateProcessor(getSelector(), locale, next);
  }

  private static final class ParseIntFieldUpdateProcessor
      extends AllValuesOrNoneFieldMutatingUpdateProcessor {
    private final Locale locale;

    // NumberFormat instances are not thread safe
    private final ThreadLocal numberFormat =
        new ThreadLocal<>() {
          @Override
          protected NumberFormat initialValue() {
            NumberFormat format = NumberFormat.getInstance(locale);
            format.setParseIntegerOnly(true);
            return format;
          }
        };

    ParseIntFieldUpdateProcessor(
        FieldNameSelector selector, Locale locale, UpdateRequestProcessor next) {
      super(selector, next);
      this.locale = locale;
    }

    @Override
    protected Object mutateValue(Object srcVal) {
      if (srcVal instanceof CharSequence) {
        String stringVal = srcVal.toString();
        ParsePosition pos = new ParsePosition(0);
        Number number = numberFormat.get().parse(stringVal, pos);
        if (pos.getIndex() != stringVal.length()) {
          if (log.isDebugEnabled()) {
            log.debug(
                "value '{}' is not parseable, thus not mutated; unparsed chars: '{}'",
                new Object[] {srcVal, stringVal.substring(pos.getIndex())});
          }
          return SKIP_FIELD_VALUE_LIST_SINGLETON;
        }
        int intValue = number.intValue();
        if (number.longValue() == (long) intValue) {
          // If the high bits don't get truncated by number.intValue()
          return intValue;
        }
        log.debug("value '{}' doesn't fit into an Integer, thus was not mutated", srcVal);
        return SKIP_FIELD_VALUE_LIST_SINGLETON;
      }
      if (srcVal instanceof Integer) {
        return srcVal;
      }
      return SKIP_FIELD_VALUE_LIST_SINGLETON;
    }
  }

  @Override
  protected boolean isSchemaFieldTypeCompatible(FieldType type) {
    return type instanceof IntValueFieldType;
  }
}