com.rapidminer.operator
Class OperatorDescription

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

All Implemented Interfaces:

java.lang.Comparable<OperatorDescription>

public 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

Constructor Summary

OperatorDescription(java.lang.ClassLoader classLoader, java.lang.String key, java.lang.String name, java.lang.String className, java.lang.String group, java.lang.String iconName, java.lang.String deprecationInfo, Plugin provider)
Deprecated. No I18N support.

OperatorDescription(java.lang.ClassLoader classLoader, java.lang.String key, java.lang.String name, java.lang.String className, java.lang.String shortDescription, java.lang.String longDescription, java.lang.String groupName, java.lang.String iconName, java.lang.String deprecationInfo, Plugin provider)
Deprecated. This constructor cannot provide an internationalization mechanism since description is not taken from operator documentation bundle.

OperatorDescription(GroupTree groupTree, org.w3c.dom.Element element, java.lang.ClassLoader classLoader, Plugin provider, OperatorDocBundle bundle)
Parses an operator in the RM 5.0 standard and assigns it to the given group.

OperatorDescription(java.lang.String key, java.lang.Class<? extends Operator> clazz, GroupTree groupTree, java.lang.ClassLoader classLoader, java.lang.String iconName, Plugin provider)
Constructor for programmatic (non-parsed) creation of OperatorDescriptions, e.g. by a GenericOperatorFactory.

OperatorDescription(java.lang.String key, java.lang.Class<? extends Operator> clazz, GroupTree groupTree, java.lang.ClassLoader classLoader, java.lang.String iconName, Plugin provider, OperatorDocBundle bundle)
Constructor for programmatic (non-parsed) creation of OperatorDescriptions, e.g. by a GenericOperatorFactory.

Method Summary

int	compareTo(OperatorDescription d)
Operator	createOperatorInstance() Creates a new operator based on the description.
void	disable()
boolean	equals(java.lang.Object o)
java.lang.String	getAbbreviatedClassName()
java.lang.String	getDeprecationInfo()
java.lang.String	getGroup()
java.lang.String	getGroupName()
GroupTree	getGroupTree()
javax.swing.ImageIcon	getIcon()
java.lang.String	getIconName()
java.lang.String	getKey()
javax.swing.ImageIcon	getLargeIcon()
java.lang.String	getLongDescriptionHTML()
java.lang.String	getName()
java.lang.Class<? extends Operator>	getOperatorClass()
OperatorDocumentation	getOperatorDocumentation()
Plugin	getProvider()
java.lang.String	getProviderName()
java.lang.String	getProviderNamespace() This defines the namespace of the provider.
java.util.List<java.lang.String>	getReplacedKeys() Returns keys of deprecated operators replaced by this operator.
java.lang.String	getShortDescription()
java.lang.String	getShortName()
javax.swing.ImageIcon	getSmallIcon()
int	hashCode()
boolean	isDeprecated()
boolean	isEnabled() Some operators may be disabled, e.g. because they cannot be applied inside an application server (file access etc.)
void	setIsReplacementFor(java.lang.String opName)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

OperatorDescription

public OperatorDescription(GroupTree groupTree,
                           org.w3c.dom.Element element,
                           java.lang.ClassLoader classLoader,
                           Plugin provider,
                           OperatorDocBundle bundle)
                    throws java.lang.ClassNotFoundException,
                           XMLException

Parses an operator in the RM 5.0 standard and assigns it to the given group.

Parameters:

bundle -

Throws:

java.lang.ClassNotFoundException

XMLException

OperatorDescription

public OperatorDescription(java.lang.String key,
                           java.lang.Class<? extends Operator> clazz,
                           GroupTree groupTree,
                           java.lang.ClassLoader classLoader,
                           java.lang.String iconName,
                           Plugin provider)

Constructor for programmatic (non-parsed) creation of OperatorDescriptions, e.g. by a GenericOperatorFactory.

OperatorDescription

public OperatorDescription(java.lang.String key,
                           java.lang.Class<? extends Operator> clazz,
                           GroupTree groupTree,
                           java.lang.ClassLoader classLoader,
                           java.lang.String iconName,
                           Plugin provider,
                           OperatorDocBundle bundle)

Constructor for programmatic (non-parsed) creation of OperatorDescriptions, e.g. by a GenericOperatorFactory. Additionally this allows to specify an operator documentation bundle where the docu is retrieved from.

OperatorDescription

@Deprecated
public OperatorDescription(java.lang.ClassLoader classLoader,
                                      java.lang.String key,
                                      java.lang.String name,
                                      java.lang.String className,
                                      java.lang.String group,
                                      java.lang.String iconName,
                                      java.lang.String deprecationInfo,
                                      Plugin provider)
                    throws java.lang.ClassNotFoundException

Deprecated. No I18N support.

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

OperatorDescription

@Deprecated
public OperatorDescription(java.lang.ClassLoader classLoader,
                                      java.lang.String key,
                                      java.lang.String name,
                                      java.lang.String className,
                                      java.lang.String shortDescription,
                                      java.lang.String longDescription,
                                      java.lang.String groupName,
                                      java.lang.String iconName,
                                      java.lang.String deprecationInfo,
                                      Plugin provider)
                    throws java.lang.ClassNotFoundException

Deprecated. This constructor cannot provide an internationalization mechanism since description is not taken from operator documentation bundle.

Creates an operator description with the given fields.

Throws:

java.lang.ClassNotFoundException

Method Detail

getName

public java.lang.String getName()

getShortName

public java.lang.String getShortName()

getOperatorClass

public java.lang.Class<? extends Operator> getOperatorClass()

getShortDescription

public java.lang.String getShortDescription()

getLongDescriptionHTML

public java.lang.String getLongDescriptionHTML()

getOperatorDocumentation

public OperatorDocumentation getOperatorDocumentation()

getGroup

public java.lang.String getGroup()

getGroupName

public java.lang.String getGroupName()

getIcon

public javax.swing.ImageIcon getIcon()

getSmallIcon

public javax.swing.ImageIcon getSmallIcon()

getLargeIcon

public javax.swing.ImageIcon getLargeIcon()

getAbbreviatedClassName

public java.lang.String getAbbreviatedClassName()

getDeprecationInfo

public java.lang.String getDeprecationInfo()

isDeprecated

public boolean isDeprecated()

getProviderName

public java.lang.String getProviderName()

getProviderNamespace

public java.lang.String getProviderNamespace()

This defines the namespace of the provider. If is core, OperatorService.RAPID_MINER_CORE_NAMESPACE is returned. Otherwise the namespace of the extension is returned as defined by the manifest.xml

Returns:

getKey

public java.lang.String getKey()

disable

public void disable()

isEnabled

public boolean isEnabled()

Some operators may be disabled, e.g. because they cannot be applied inside an application server (file access etc.)

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

setIsReplacementFor

public void setIsReplacementFor(java.lang.String opName)

getReplacedKeys

public java.util.List<java.lang.String> getReplacedKeys()

Returns keys of deprecated operators replaced by this operator.

getIconName

public java.lang.String getIconName()

getProvider

public Plugin getProvider()

getGroupTree

public GroupTree getGroupTree()