org.apache.solr.update.processor.FieldLengthUpdateProcessorFactory 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 static org.apache.solr.update.processor.FieldMutatingUpdateProcessor.SELECT_NO_FIELDS;
import static org.apache.solr.update.processor.FieldValueMutatingUpdateProcessor.valueMutator;

import org.apache.solr.common.util.NamedList;
import org.apache.solr.core.SolrCore;
import org.apache.solr.request.SolrQueryRequest;
import org.apache.solr.response.SolrQueryResponse;
import org.apache.solr.update.processor.FieldMutatingUpdateProcessor.FieldNameSelector;

/**
 * Replaces any CharSequence values found in fields matching the specified conditions with the
 * lengths of those CharSequences (as an Integer).
 *
 * By default, this processor matches no fields.
 *
 * 
For example, with the configuration listed below any documents containing String values (such
 * as "abcdef" or "xyz") in a field declared in the schema using 
 * IntPointField or LongPointField would have those Strings replaced with the
 * length of those fields as an Integer (ie: 6 and 3 respectively)
 *
 * 
 * <processor class="solr.FieldLengthUpdateProcessorFactory">
 *   <arr name="typeClass">
 *     <str>solr.IntPointField</str>
 *     <str>solr.LongPointField</str>
 *   </arr>
 * </processor>
 *
 * @since 4.0.0
 */
public final class FieldLengthUpdateProcessorFactory extends FieldMutatingUpdateProcessorFactory {

  @Override
  public void init(NamedList args) {
    // no length specific init args
    super.init(args);
  }

  @Override
  public FieldNameSelector getDefaultSelector(final SolrCore core) {
    return SELECT_NO_FIELDS;
  }

  @Override
  public UpdateRequestProcessor getInstance(
      SolrQueryRequest req, SolrQueryResponse rsp, UpdateRequestProcessor next) {
    return valueMutator(
        getSelector(),
        next,
        src -> {
          if (src instanceof CharSequence) {
            return ((CharSequence) src).length();
          }
          return src;
        });
  }
}