org.apache.solr.handler.dataimport.TemplateTransformer Maven / Gradle / Ivy

/**
 * 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.handler.dataimport;

import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * 
 * A Transformer which can put values into a column by resolving an expression
 * containing other columns
 * 
 * 
 * 

 * For example:

 * <field column="name" template="${e.lastName}, ${e.firstName}
 * ${e.middleName}" /> will produce the name by combining values from
 * lastName, firstName and middleName fields as given in the template attribute.
 * 
 * 
 * 

 * Refer to http://wiki.apache.org/solr/DataImportHandler
 * for more details.
 * 
 * 
 * This API is experimental and may change in the future.
 *
 * @version $Id: TemplateTransformer.java 747664 2009-02-25 05:27:31Z shalin $
 * @since solr 1.3
 */
public class TemplateTransformer extends Transformer {

  private static final Logger LOG = LoggerFactory.getLogger(TemplateTransformer.class);

  @SuppressWarnings("unchecked")
  public Object transformRow(Map row, Context context) {

    VariableResolverImpl resolver = (VariableResolverImpl) context
            .getVariableResolver();
    // Add current row to the copy of resolver map
//    for (Map.Entry entry : row.entrySet())

    for (Map map : context.getAllEntityFields()) {
      String expr = map.get(TEMPLATE);
      if (expr == null)
        continue;

      String column = map.get(DataImporter.COLUMN);

      // Verify if all variables can be resolved or not
      boolean resolvable = true;
      List variables = TemplateString.getVariables(expr);
      for (String v : variables) {
        if (resolver.resolve(v) == null) {
          LOG.warn("Unable to resolve variable: " + v
                  + " while parsing expression: " + expr);
          resolvable = false;
        }
      }

      if (!resolvable)
        continue;

      row.put(column, resolver.replaceTokens(expr));
    }


    return row;
  }

  public static final String TEMPLATE = "template";
}