edu.udo.cs.yale.tools
Class OperatorService

java.lang.Object
  edu.udo.cs.yale.tools.OperatorService

public class OperatorService
extends java.lang.Object

This class reads the description of the YALE operators. These descriptions are entries in a XML File like:

<operators>
<operator
name="OperatorName"
class="java.path.OperatorClass"
description="OperatorDescription"
deprecation="OperatorDeprecationInfo"
group="OperatorGroup"
icon="OperatorIcon"
/>











The values (and the whole tag) for deprecation and icon might be omitted. If no deprecation info was specified, the operator is simply not deprecated. If no icon is specified, YALE just used the icon of the parent group.

NOTE: This class should be used to create operators and is therefore an operator factory.

Version:

$Id: OperatorService.java,v 2.30 2006/10/02 22:35:50 ingomierswa Exp $

Author:

Ingo Mierswa, Simon Fischer

Field Summary

private static GroupTree	groupTree Map for group name <-> group (list).
private static java.util.Map<java.lang.String,java.lang.Class<IOObject>>	ioObjects The Map for all IO objects (maps short names on classes).
private static java.util.Map<java.lang.String,OperatorDescription>	names2descriptions Maps operator names of form classname|subclassname to operator descriptions.

Constructor Summary

OperatorService()

Method Summary

private static void	checkIOObjects(java.lang.Class[] objects) This method is only necessary since the operators deliver Class arrays (which cannot be instantiated with Generics) and can be removed after this was changed to collections.
private static void	checkIOObjects(java.util.Collection<java.lang.Class<IOObject>> objects) Checks if the given classes are already registered and adds them if not.
private static boolean	containsClass(java.lang.Class<?>[] types, java.lang.Class<?> type) Returns true if the given class array contains the given class itself or a subclass.
static Operator	createOperator(java.lang.Class clazz) ATTENTION: Use this method to create an operator from an operator class.
static Operator	createOperator(OperatorDescription description) Use this method to create an operator of a given description object.
static Operator	createOperator(java.lang.String className) Use this method to create an operator from the given class name (from operator description file operators.xml, not from the Java class name).
static GroupTree	getGroups() Returns the group hierarchy of all operators.
static java.lang.Class<IOObject>	getIOObjectClass(java.lang.String name) Returns the class for the short name of an IO object.
static java.util.Set<java.lang.String>	getIOObjectsNames() Returns a sorted set of all short IO object names.
static OperatorDescription	getOperatorDescription(java.lang.String completeName) Returns the operator description for a given class name from the operators.xml file, e.g.
static OperatorDescription[]	getOperatorDescriptions(java.lang.Class clazz) Returns the operator descriptions for the operators which uses the given class.
static java.util.Set<java.lang.String>	getOperatorNames() Returns a collection of all operator names.
static java.util.Set<OperatorDescription>	getOperatorsDelivering(java.lang.Class ioObject) Returns a collection of all operator descriptions of operators which return the desired IO object as output.
static java.util.Set<OperatorDescription>	getOperatorsRequiring(java.lang.Class ioObject) Returns a collection of all operator descriptions which requires the given IO object as input.
private static void	registerOperator(java.lang.ClassLoader classLoader, java.lang.String name, java.lang.String clazz, java.lang.String descr, java.lang.String group, java.lang.String icon, java.lang.String deprecationInfo) Registers an operator description from the given meta data.
private static void	registerOperator(org.w3c.dom.Element operatorTag, java.lang.ClassLoader classLoader) Registers an operator description from an XML tag (operator description file, mostly operators.xml).
static void	registerOperator(OperatorDescription description) Registers the given operator description.
static void	registerOperators(java.lang.String name, java.io.InputStream operatorsXML, java.lang.ClassLoader classLoader) Registers all operators from a given XML input stream.

Methods inherited from class java.lang.Object

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

Field Detail

names2descriptions

private static java.util.Map<java.lang.String,OperatorDescription> names2descriptions

Maps operator names of form classname|subclassname to operator descriptions.

groupTree

private static GroupTree groupTree

Map for group name <-> group (list).

ioObjects

private static java.util.Map<java.lang.String,java.lang.Class<IOObject>> ioObjects

The Map for all IO objects (maps short names on classes).

Constructor Detail

OperatorService

public OperatorService()

Method Detail

registerOperators

public static void registerOperators(java.lang.String name,
                                     java.io.InputStream operatorsXML,
                                     java.lang.ClassLoader classLoader)

Registers all operators from a given XML input stream.

registerOperator

private static void registerOperator(org.w3c.dom.Element operatorTag,
                                     java.lang.ClassLoader classLoader)
                              throws java.lang.Exception

Registers an operator description from an XML tag (operator description file, mostly operators.xml).

Throws:

java.lang.Exception

registerOperator

private static void registerOperator(java.lang.ClassLoader classLoader,
                                     java.lang.String name,
                                     java.lang.String clazz,
                                     java.lang.String descr,
                                     java.lang.String group,
                                     java.lang.String icon,
                                     java.lang.String deprecationInfo)
                              throws java.lang.Exception

Registers an operator description from the given meta data.

Throws:

java.lang.Exception

registerOperator

public static void registerOperator(OperatorDescription description)
                             throws java.lang.Exception

Registers the given operator description. Please note that two different descriptions must not have the same class AND subtype. Otherwise the second description overwrite the first in the description map.

Throws:

java.lang.Exception

checkIOObjects

private static void checkIOObjects(java.lang.Class[] objects)

This method is only necessary since the operators deliver Class arrays (which cannot be instantiated with Generics) and can be removed after this was changed to collections. TODO: remove this method after getInputClasses() and getOutputClasses() deliver collections and call checkIOObjects(Collection) directly.

checkIOObjects

private static void checkIOObjects(java.util.Collection<java.lang.Class<IOObject>> objects)

Checks if the given classes are already registered and adds them if not.

getIOObjectsNames

public static java.util.Set<java.lang.String> getIOObjectsNames()

Returns a sorted set of all short IO object names.

getOperatorsDelivering

public static java.util.Set<OperatorDescription> getOperatorsDelivering(java.lang.Class ioObject)

Returns a collection of all operator descriptions of operators which return the desired IO object as output.

getOperatorsRequiring

public static java.util.Set<OperatorDescription> getOperatorsRequiring(java.lang.Class ioObject)

Returns a collection of all operator descriptions which requires the given IO object as input.

containsClass

private static boolean containsClass(java.lang.Class<?>[] types,
                                     java.lang.Class<?> type)

Returns true if the given class array contains the given class itself or a subclass.

getIOObjectClass

public static java.lang.Class<IOObject> getIOObjectClass(java.lang.String name)

Returns the class for the short name of an IO object.

getOperatorNames

public static java.util.Set<java.lang.String> getOperatorNames()

Returns a collection of all operator names. A name has the structure classname|subclassname.

getGroups

public static GroupTree getGroups()

Returns the group hierarchy of all operators.

getOperatorDescriptions

public static OperatorDescription[] getOperatorDescriptions(java.lang.Class clazz)

Returns the operator descriptions for the operators which uses the given class. Performs a linear seach through all operator descriptions.

getOperatorDescription

public static OperatorDescription getOperatorDescription(java.lang.String completeName)

Returns the operator description for a given class name from the operators.xml file, e.g. "Experiment" for an ExperimentOperator.

createOperator

public static Operator createOperator(java.lang.String className)
                               throws OperatorCreationException

Use this method to create an operator from the given class name (from operator description file operators.xml, not from the Java class name).

Throws:

OperatorCreationException

createOperator

public static Operator createOperator(OperatorDescription description)
                               throws OperatorCreationException

Use this method to create an operator of a given description object.

Throws:

OperatorCreationException

createOperator

public static Operator createOperator(java.lang.Class clazz)
                               throws OperatorCreationException

ATTENTION: Use this method to create an operator from an operator class. Although this is the only method which ensures operator existence checking during compile time (and not during runtime) the usage of this method is not recommended for two reasons: first, the operator description which creates the operator and corresponds to the given class must be seach by iteration through all operator descriptions. Second, some operators are created from the same class. Therefore, the operator description must not be unique for the given class. In these cases an OperatorCreationException is thrown.

The recommended way for operator creation is to use the method createOperator(String).

Throws:

OperatorCreationException