at.mug.iqm.api.operator

Interface IOperatorRegistry

All Known Implementing Classes:

OperatorRegistry

public interface IOperatorRegistry

The OperatorRegistry maintains a set of ArrayLists of Classes for

• names
• IOperatorDescriptor
• IOperator
• IOperatorGUI
• IOperatorValidator

The list of names contains the indices of all other lists' elements corresponding to the specified unique operator name.
E.g. if "Operator1" is added to the registry at index position 0, the IOperatorDescriptor of "Operator1" goes to the index position 0 of the IOperatorDescriptor list, and so on.

If a specific implementation’s class name is required, any instance can look up the class name e.g. of an operator’s descriptor in the OperatorRegistry using OperatorRegistry.getInstance().getDescriptor(String).

Author:

Philipp Kainz

Method Summary

Modifier and Type	Method and Description
Class<IOperatorDescriptor>	getDescriptor(String name) Gets the descriptor of an operator by name.
List<String>	getNames() Gets the list of registered names from the registry.
Class<IOperator>	getOperator(String name) Gets an operator by name.
Class<IOperatorGUI>	getOperatorGUI(String name) Gets the GUI of an operator by name.
Class<IOperatorValidator>	getOperatorValidator(String name) Gets the validator of an operator by name.
StackProcessingType	getStackProcessingType(String name) Gets the StackProcessingType of an operator by name.
OperatorType	getType(String name) Gets the type of an operator by name.
boolean	isRegistered(String name) Checks whether or not a given name is registered with this registry
void	register(String name, Class opDesc, Class op, Class opGUI, Class opVal, OperatorType type, StackProcessingType stackProcessingType) Adds a new operator to the registry using the unique name associated with the IOperatorDescriptor.
void	unRegister(String name) Removes an operator from the registry using the unique name.
void	updateRegistryEntry(String name) Updates a registry entry and re-registers the IOperatorDescriptor with the same name in the registry.

Method Detail

register

void register(String name,
              Class opDesc,
              Class op,
              Class opGUI,
              Class opVal,
              OperatorType type,
              StackProcessingType stackProcessingType)

Adds a new operator to the registry using the unique name associated with the IOperatorDescriptor.

Parameters:

name -

opDesc -

op -

opGUI -

opVal -

type -

stackProcessingType -

unRegister

void unRegister(String name)
         throws NoSuchElementException

Removes an operator from the registry using the unique name.

Parameters:

name -

Throws:

NoSuchElementException - if the provided name is not found in the registry

getDescriptor

Class<IOperatorDescriptor> getDescriptor(String name)
                                  throws NoSuchElementException

Gets the descriptor of an operator by name.

Parameters:

name - the operator name

Returns:

the Class of the descriptor

Throws:

NoSuchElementException - if the provided name is not found in the registry

getOperator

Class<IOperator> getOperator(String name)
                      throws NoSuchElementException

Gets an operator by name.

Parameters:

name - the operator name

Returns:

the Class of the operator

Throws:

NoSuchElementException - if the provided name is not found in the registry

getOperatorGUI

Class<IOperatorGUI> getOperatorGUI(String name)
                            throws NoSuchElementException

Gets the GUI of an operator by name.

Parameters:

name - the name of the operator

Returns:

the Class of the operator GUI

Throws:

NoSuchElementException - if the provided name is not found in the registry

getOperatorValidator

Class<IOperatorValidator> getOperatorValidator(String name)
                                        throws NoSuchElementException

Gets the validator of an operator by name.

Parameters:

name - the name of the operator

Returns:

the Class of the operator validator

Throws:

NoSuchElementException - if the provided name is not found in the registry

getType

OperatorType getType(String name)

Gets the type of an operator by name.

Parameters:

name -

Returns:

the OperatorType

getStackProcessingType

StackProcessingType getStackProcessingType(String name)

Gets the StackProcessingType of an operator by name.

Parameters:

name -

Returns:

the StackProcessingType

getNames

List<String> getNames()

Gets the list of registered names from the registry.

Returns:

the List of operator names

updateRegistryEntry

void updateRegistryEntry(String name)
                  throws NoSuchElementException

Updates a registry entry and re-registers the IOperatorDescriptor with the same name in the registry.

Parameters:

name - the operator name

Throws:

NoSuchElementException

isRegistered

boolean isRegistered(String name)

Checks whether or not a given name is registered with this registry

Parameters:

name - the operator name

Returns:

true, if the name is registered, false, if not