edu.udo.cs.yale.operator
Class InputDescription

java.lang.Object
  edu.udo.cs.yale.operator.InputDescription

public class InputDescription
extends java.lang.Object

This class is used to describe the required input of an operator and the operator's behavior with respect to consumation of this input object. Input objects can be simply consumed (default) or the consumation behavior can be defined with help of an parameter (user decision).

Version:

$Id: InputDescription.java,v 2.8 2006/08/03 14:39:30 ingomierswa Exp $

Author:

Ingo Mierswa

Field Summary

private java.lang.Class	inputType The class of the input object.
private boolean	keepDefault The default value for consumation.
private boolean	parameter Indicates if the operator at hand should define a parameter so that the user can decide if the input should be consumed.
private java.lang.String	parameterName The parameter name.

Constructor Summary

InputDescription(java.lang.Class inputType)
Creates a new input description for the given class.

InputDescription(java.lang.Class inputType, boolean keepDefault)
Creates a new input description for the given class.

InputDescription(java.lang.Class inputType, boolean keepDefault, boolean parameter)
Creates a new input description for the given class.

InputDescription(java.lang.Class inputType, boolean keepDefault, boolean parameter, java.lang.String parameterName)
Creates a new input description for the given class.

Method Summary

private static java.lang.String	convertClass2ParameterName(java.lang.Class inputType) Converts the class name into a parameter name following Yale conventions (lower case, underscores for empty spaces).
java.lang.Class	getInputType() Returns the desired class of the input object.
boolean	getKeepDefault() Indicates if the input should be consumed.
java.lang.String	getParameterName() Returns the name of the user parameter.
boolean	showParameter() Indicates if a user parameter should be defined.
java.lang.String	toString() Returns a String representation of this input description.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

inputType

private java.lang.Class inputType

The class of the input object.

keepDefault

private boolean keepDefault

The default value for consumation.

parameter

private boolean parameter

Indicates if the operator at hand should define a parameter so that the user can decide if the input should be consumed.

parameterName

private java.lang.String parameterName

The parameter name.

Constructor Detail

InputDescription

public InputDescription(java.lang.Class inputType)

Creates a new input description for the given class. The input object is consumed.

InputDescription

public InputDescription(java.lang.Class inputType,
                        boolean keepDefault)

Creates a new input description for the given class. The parameter keepDefault defines if the input object is consumed.

InputDescription

public InputDescription(java.lang.Class inputType,
                        boolean keepDefault,
                        boolean parameter)

Creates a new input description for the given class. The parameter keepDefault defines if the input object is consumed per default. parameter defines if the operator should provide a user parameter.

InputDescription

public InputDescription(java.lang.Class inputType,
                        boolean keepDefault,
                        boolean parameter,
                        java.lang.String parameterName)

Creates a new input description for the given class. The parameter keepDefault defines if the input object is consumed per default. parameter defines if the operator should provide a user parameter. This parameter utilizes the given name.

Method Detail

getInputType

public java.lang.Class getInputType()

Returns the desired class of the input object.

getKeepDefault

public boolean getKeepDefault()

Indicates if the input should be consumed.

showParameter

public boolean showParameter()

Indicates if a user parameter should be defined.

getParameterName

public java.lang.String getParameterName()

Returns the name of the user parameter.

convertClass2ParameterName

private static java.lang.String convertClass2ParameterName(java.lang.Class inputType)

Converts the class name into a parameter name following Yale conventions (lower case, underscores for empty spaces).

toString

public java.lang.String toString()

Returns a String representation of this input description.

Overrides:

toString in class java.lang.Object