edu.udo.cs.yale.operator
Class OperatorDescription

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

All Implemented Interfaces:

java.lang.Comparable

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

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.

Version:

$Id: OperatorDescription.java,v 2.5 2006/03/21 15:35:42 ingomierswa Exp $

Author:

Ingo Mierswa

Field Summary

private java.lang.Class	clazz
private java.lang.String	deprecationInfo
private java.lang.String	description
private java.lang.String	group
private java.awt.Image	icon
private java.lang.String	iconName
private java.lang.String	name

Constructor Summary

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

Method Summary

int	compareTo(java.lang.Object o)
Operator	createOperatorInstance() Creates a new operator based on the description.
java.lang.String	getDeprecationInfo()
java.lang.String	getDescription()
java.lang.String	getGroup()
java.awt.Image	getIcon()
java.lang.String	getIconName()
java.lang.String	getName()
java.lang.Class	getOperatorClass()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

name

private java.lang.String name

clazz

private java.lang.Class clazz

description

private java.lang.String description

group

private java.lang.String group

icon

private java.awt.Image icon

iconName

private java.lang.String iconName

deprecationInfo

private java.lang.String deprecationInfo

Constructor Detail

OperatorDescription

public OperatorDescription(java.lang.ClassLoader classLoader,
                           java.lang.String name,
                           java.lang.String className,
                           java.lang.String description,
                           java.lang.String group,
                           java.lang.String icon,
                           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

getName

public java.lang.String getName()

getOperatorClass

public java.lang.Class getOperatorClass()

getDescription

public java.lang.String getDescription()

getGroup

public java.lang.String getGroup()

getIcon

public java.awt.Image getIcon()

getIconName

public java.lang.String getIconName()

getDeprecationInfo

public java.lang.String getDeprecationInfo()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

createOperatorInstance

public Operator createOperatorInstance()
                                throws OperatorCreationException

Creates a new operator based on the description.

Throws:

OperatorCreationException

compareTo

public int compareTo(java.lang.Object o)

Specified by:

compareTo in interface java.lang.Comparable