com.rapidminer.operator
Class OperatorDescription

java.lang.Object
  com.rapidminer.operator.OperatorDescription

All Implemented Interfaces:

java.lang.Comparable<OperatorDescription>

public final class OperatorDescription
extends java.lang.Object
implements java.lang.Comparable<OperatorDescription>

Data container for name, class, short name, path and the (very short) description of an operator. If the corresponding operator is not marked as deprecated the deprecation info string should be null. If the icon string is null, the group icon will be used.

Author:

Ingo Mierswa Exp $

Constructor Summary

OperatorDescription(java.lang.ClassLoader classLoader, java.lang.String name, java.lang.String className, java.lang.String shortDescription, java.lang.String longDescription, java.lang.String group, java.lang.String iconName, java.lang.String deprecationInfo)
Creates a new operator description object.

Method Summary

int	compareTo(OperatorDescription d)
Operator	createOperatorInstance() Creates a new operator based on the description.
boolean	equals(java.lang.Object o)
java.lang.String	getDeprecationInfo()
java.lang.String	getGroup()
javax.swing.ImageIcon	getIcon()
java.lang.String	getIconPath()
java.lang.String	getLongDescriptionHTML()
java.lang.String	getName()
java.lang.Class	getOperatorClass()
java.lang.String	getShortDescription()
int	hashCode()
void	reloadIcon(java.lang.String iconName)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

OperatorDescription

public OperatorDescription(java.lang.ClassLoader classLoader,
                           java.lang.String name,
                           java.lang.String className,
                           java.lang.String shortDescription,
                           java.lang.String longDescription,
                           java.lang.String group,
                           java.lang.String iconName,
                           java.lang.String deprecationInfo)
                    throws java.lang.ClassNotFoundException

Creates a new operator description object. If the corresponding operator is not marked as deprecated the deprecation info string should be null. If the icon string is null, the group icon will be used.

Throws:

java.lang.ClassNotFoundException

Method Detail

reloadIcon

public void reloadIcon(java.lang.String iconName)

getName

public java.lang.String getName()

getOperatorClass

public java.lang.Class getOperatorClass()

getShortDescription

public java.lang.String getShortDescription()

getLongDescriptionHTML

public java.lang.String getLongDescriptionHTML()

getGroup

public java.lang.String getGroup()

getIcon

public javax.swing.ImageIcon getIcon()

getIconPath

public java.lang.String getIconPath()

getDeprecationInfo

public java.lang.String getDeprecationInfo()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

compareTo

public int compareTo(OperatorDescription d)

Specified by:

compareTo in interface java.lang.Comparable<OperatorDescription>

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

createOperatorInstance

public Operator createOperatorInstance()
                                throws OperatorCreationException

Creates a new operator based on the description.

Throws:

OperatorCreationException