org.apache.mahout.common.parameters.AbstractParameter 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.mahout.common.parameters;

import java.util.Collection;
import java.util.Collections;

import org.apache.hadoop.conf.Configuration;

public abstract class AbstractParameter implements Parameter {
  
  private T value;
  private final String prefix;
  private final String name;
  private final String description;
  private final Class type;
  private final String defaultValue;

  protected AbstractParameter(Class type,
                              String prefix,
                              String name,
                              Configuration jobConf,
                              T defaultValue,
                              String description) {
    this.type = type;
    this.name = name;
    this.description = description;

    this.value = defaultValue;
    this.defaultValue = getStringValue();

    this.prefix = prefix;
    String jobConfValue = jobConf.get(prefix + name);
    if (jobConfValue != null) {
      setStringValue(jobConfValue);
    }

  }
  
  @Override
  public void configure(Configuration jobConf) {
  // nothing to do
  }
  
  @Override
  public void createParameters(String prefix, Configuration jobConf) { }
  
  @Override
  public String getStringValue() {
    if (value == null) {
      return null;
    }
    return value.toString();
  }
  
  @Override
  public Collection> getParameters() {
    return Collections.emptyList();
  }
  
  @Override
  public String prefix() {
    return prefix;
  }
  
  @Override
  public String name() {
    return name;
  }
  
  @Override
  public String description() {
    return description;
  }
  
  @Override
  public Class type() {
    return type;
  }
  
  @Override
  public String defaultValue() {
    return defaultValue;
  }
  
  @Override
  public T get() {
    return value;
  }
  
  @Override
  public void set(T value) {
    this.value = value;
  }
  
  @Override
  public String toString() {
    if (value != null) {
      return value.toString();
    } else {
      return super.toString();
    }
  }
  
}