marvin.plugin

Interface MarvinPlugin

All Known Subinterfaces:

MarvinAlgorithmPlugin, MarvinImagePlugin, MarvinToolPlugin

All Known Implementing Classes:

MarvinAbstractAlgorithmPlugin, MarvinAbstractImagePlugin, MarvinAbstractPlugin, MarvinAbstractToolPlugin

public interface MarvinPlugin

Generic Marvin Plug-in. All application plug-ins must be implement this interface. Currently, itīs empty because Marvin suports only one type of plug-in. Nevertheless, different types of plug-ins are expected.

Version:

1.0 02/13/08

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.Object	getAttribute(java.lang.String attrName)
MarvinAttributes	getAttributes()
void	invalidate() Invalidate this plug-in.
boolean	isValid() Determines whether this plug-in is valid.
void	load()
void	setAttribute(java.lang.String attrName, java.lang.Object value) Set an attribute
void	setAttributes(java.lang.Object... params) Set a list of attributes.
void	validate() Ensures that this plug-in is working consistently to its attributes.

Method Detail

load

void load()

validate

void validate()

Ensures that this plug-in is working consistently to its attributes.

invalidate

void invalidate()

Invalidate this plug-in. It means that the attributes were changed and the plug-in needs to check whether or not change its behavior.

isValid

boolean isValid()

Determines whether this plug-in is valid. A plug-in is valid when it is correctly configured given a set of attributes. When an attribute is changed, the plug-in becomes invalid until the method validate() is called.

Returns:

getAttributes

MarvinAttributes getAttributes()

Returns:

MarvinAttributes object associated with this plug-in

setAttribute

void setAttribute(java.lang.String attrName,
                java.lang.Object value)

Set an attribute

Parameters:

attrName - attribute name

value - attribute value

setAttributes

void setAttributes(java.lang.Object... params)

Set a list of attributes. Format: (String)name, (Object)value...

getAttribute

java.lang.Object getAttribute(java.lang.String attrName)

Parameters:

attrName - attribute name

Returns:

the attributeīs value