How to access a "Configurable" Parameter

janvanrijn

The document "How to Extend RapidMiner 5" describes how to create Configurables, for example to store Connections to certain servers (Chapter 8 ). I try to do so for a RapidMiner Studio, and as it turns out, many of the code is applicable for this version. However, I ran into some difficulties.

I have for my Operator overridden the getParameterTypes function:

public List<ParameterType> getParameterTypes() {
	List<ParameterType> types = super.getParameterTypes();
	types.add(new ParameterTypeConfigurable(PARAMETER_CONFIG, "Choose a Connection", "Config"));
	types.add(new ParameterTypeInt(PARAMETER_TASKID, "The Task that needs to be executed", 1, Integer.MAX_VALUE, false));
	return types;
}

Hence, I can see both the integer and configurable parameter fields.

Now, if I want to access the integer parameter, I can easily access it in the doWork function:

getParameterAsInt(PARAMETER_TASKID);

I would assume there is a similar way to obtain the Configurable? Yet, I can't find it, and it is not documented in the manual. Many thanks for helping out.

Marco_Boeck

Hi,

I have some example code from our own Amazon S3 configurable for you which should be helpful.

The parameter type defintion:

@Override
public List<ParameterType> getParameterTypes() {
       ParameterType type = new ParameterTypeConfigurable(PARAMETER_CONNECTION, "The Amazon S3 connection.",
			AmazonS3ConnectionConfigurator.TYPE_ID);
	type.setOptional(false);
	parameterTypes.add(type);
       //...
}

The doWork() method of the operator:

@Override
public void doWork() throws OperatorException {
	AmazonS3Connection connection = null;

	try {
		connection = (AmazonS3Connection) ConfigurationManager.getInstance().lookup(
				AmazonS3ConnectionConfigurator.TYPE_ID, getParameterAsString(PARAMETER_CONNECTION),
				getProcess().getRepositoryAccessor());
	} catch (ConfigurationException e) {
		throw new UserError(this, e, "amazon.configuration_read");
	}

       // access configurable settings
       String bucketName = connection.getBucketName(filePath);
       String fileName = connection.getFileName(filePath);


       AmazonS3 client = connection.createConnection();
       // do stuff with S3

}

Regards,
Marco