/*! ******************************************************************************
*
* Pentaho Data Integration
*
* Copyright (C) 2002-2013 by Pentaho : http://www.pentaho.com
*
*******************************************************************************
*
* Licensed 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.pentaho.di.core.parameters;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;
import java.util.Set;
/**
* This class is an implementation of NamedParams.
*
* @author Sven Boden
*/
public class NamedParamsDefault implements NamedParams {
/**
* Map to store named parameters in.
*/
protected Map<String, OneNamedParam> params = new HashMap<>();
/**
* Target class for the parameter keys.
*/
class OneNamedParam {
/**
* key of this parameter
*/
public String key;
/**
* Description of the parameter
*/
public String description;
/**
* Default value for this parameter
*/
public String defaultValue;
/**
* Actual value of the parameter.
*/
public String value;
}
/**
* Default constructor.
*/
public NamedParamsDefault() {
}
@Override
public void addParameterDefinition( String key, String defValue, String description ) throws DuplicateParamException {
if ( params.get( key ) == null ) {
OneNamedParam oneParam = new OneNamedParam();
oneParam.key = key;
oneParam.defaultValue = defValue;
oneParam.description = description;
oneParam.value = "";
params.put( key, oneParam );
} else {
throw new DuplicateParamException( "Duplicate parameter '" + key + "' detected." );
}
}
@Override
public String getParameterDescription( String key ) throws UnknownParamException {
String description = null;
OneNamedParam theParam = params.get( key );
if ( theParam != null ) {
description = theParam.description;
}
return description;
}
@Override
public String getParameterValue( String key ) throws UnknownParamException {
String value = null;
OneNamedParam theParam = params.get( key );
if ( theParam != null ) {
value = theParam.value;
}
return value;
}
@Override
public String getParameterDefault( String key ) throws UnknownParamException {
String value = null;
OneNamedParam theParam = params.get( key );
if ( theParam != null ) {
value = theParam.defaultValue;
}
return value;
}
@Override
public String[] listParameters() {
Set<String> keySet = params.keySet();
String[] paramArray = keySet.toArray( new String[0] );
Arrays.sort( paramArray );
return paramArray;
}
@Override
public void setParameterValue( String key, String value ) {
OneNamedParam theParam = params.get( key );
if ( theParam != null ) {
theParam.value = value;
}
}
@Override
public void eraseParameters() {
params.clear();
}
@Override
public void clearParameters() {
String[] keys = listParameters();
for ( int idx = 0; idx < keys.length; idx++ ) {
OneNamedParam theParam = params.get( keys[idx] );
if ( theParam != null ) {
theParam.value = "";
}
}
}
@Override
public void activateParameters() {
// Do nothing here.
}
@Override
public void copyParametersFrom( NamedParams aParam ) {
if ( params != null && aParam != null ) {
params.clear();
String[] keys = aParam.listParameters();
for ( int idx = 0; idx < keys.length; idx++ ) {
String desc;
try {
desc = aParam.getParameterDescription( keys[idx] );
} catch ( UnknownParamException e ) {
desc = "";
}
String defValue;
try {
defValue = aParam.getParameterDefault( keys[idx] );
} catch ( UnknownParamException e ) {
defValue = "";
}
String value;
try {
value = aParam.getParameterValue( keys[idx] );
} catch ( UnknownParamException e ) {
value = "";
}
try {
addParameterDefinition( keys[idx], defValue, desc );
} catch ( DuplicateParamException e ) {
// Do nothing, just overwrite.
}
setParameterValue( keys[idx], value );
}
}
}
}