solr/contrib/dataimporthandler/src/java/org/apache/solr/handler/dataimport/config/Field.java

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

import static org.apache.solr.handler.dataimport.DataImportHandlerException.SEVERE;

import java.util.Collections;
import java.util.HashMap;
import java.util.Map;

import org.apache.solr.handler.dataimport.ConfigParseUtil;
import org.apache.solr.handler.dataimport.DataImportHandlerException;
import org.apache.solr.handler.dataimport.DataImporter;
import org.w3c.dom.Element;

public class Field {
  private final String column;
  private final String name;
  private final float boost;
  private final boolean toWrite;
  private final boolean multiValued;
  private final boolean dynamicName;
  private final Entity entity;
  private final Map<String, String> allAttributes;

  public Field(Builder b) {
    this.column = b.column;
    this.name = b.name;
    this.boost = b.boost;
    this.toWrite = b.toWrite;
    this.multiValued = b.multiValued;
    this.dynamicName = b.dynamicName;
    this.entity = b.entity;
    this.allAttributes = Collections.unmodifiableMap(new HashMap<>(b.allAttributes));
  }

  public String getName() {
    return name == null ? column : name;
  }

  public Entity getEntity() {
    return entity;
  }

  public String getColumn() {
    return column;
  }

  public float getBoost() {
    return boost;
  }

  public boolean isToWrite() {
    return toWrite;
  }

  public boolean isMultiValued() {
    return multiValued;
  }

  public boolean isDynamicName() {
    return dynamicName;
  }

  public Map<String,String> getAllAttributes() {
    return allAttributes;
  }
  
  public static class Builder {    
    public String column;
    public String name;
    public float boost;
    public boolean toWrite = true;
    public boolean multiValued = false;
    public boolean dynamicName;
    public Entity entity;
    public Map<String, String> allAttributes = new HashMap<>();
    
    public Builder(Element e) {
      this.name = ConfigParseUtil.getStringAttribute(e, DataImporter.NAME, null);
      this.column = ConfigParseUtil.getStringAttribute(e, DataImporter.COLUMN, null);
      if (column == null) {
        throw new DataImportHandlerException(SEVERE, "Field must have a column attribute");
      }
      this.boost = Float.parseFloat(ConfigParseUtil.getStringAttribute(e, "boost", "1.0f"));
      this.allAttributes = new HashMap<>(ConfigParseUtil.getAllAttributes(e));
    }
    
    public String getNameOrColumn() {
      return name==null ? column : name;
    }
  }

}