databionics.modules
Class Module

java.lang.Object
  databionics.modules.Module

public class Module
extends java.lang.Object

A group of tools with similar functions.

Field Summary

protected java.lang.String	description description of the module
protected java.lang.String	iconName name of the icon file
protected static org.apache.log4j.Logger	log log4j logging
protected java.lang.String	name name of the module
protected java.util.List	tools list of tools

Constructor Summary

Module()
Default constructor

Method Summary

java.lang.String	getDescription() Get the description
javax.swing.ImageIcon	getIcon() Get the icon or null if the path was invalid.
java.util.List	getInputTypes() Get a List with the union of all FileTypes needed as inputfiles for the tools in this module
java.lang.String	getName() Get the name
java.util.List	getOutputTypes() Get a List with the union of all FileTypes created as outputfiles by the tools in this module
java.util.List	getTools() Get the list of tools
java.util.List	getUsableTools(Project project) Given the types of the files existing in the project, returns a List containing all tools of this module, that can be started because they only need files as input that are already present in the project.
void	setDescription(java.lang.String s) Set the description
void	setIconName(java.lang.String s) Set the icon
void	setName(java.lang.String s) Set the name
static Module	valueOf(org.w3c.dom.Element el) Create a Module from an XML tag

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static org.apache.log4j.Logger log

log4j logging

name

protected java.lang.String name

name of the module

description

protected java.lang.String description

description of the module

tools

protected java.util.List tools

list of tools

iconName

protected java.lang.String iconName

name of the icon file

Constructor Detail

Module

public Module()

Default constructor

Method Detail

getName

public java.lang.String getName()

Get the name

getDescription

public java.lang.String getDescription()

Get the description

getIcon

public javax.swing.ImageIcon getIcon()

Get the icon or null if the path was invalid.

getTools

public java.util.List getTools()

Get the list of tools

getInputTypes

public java.util.List getInputTypes()

Get a List with the union of all FileTypes needed as inputfiles for the tools in this module

getOutputTypes

public java.util.List getOutputTypes()

Get a List with the union of all FileTypes created as outputfiles by the tools in this module

getUsableTools

public java.util.List getUsableTools(Project project)

Given the types of the files existing in the project, returns a List containing all tools of this module, that can be started because they only need files as input that are already present in the project.

Parameters:

p - the corresponding project

setName

public void setName(java.lang.String s)

Set the name

setDescription

public void setDescription(java.lang.String s)

Set the description

setIconName

public void setIconName(java.lang.String s)

Set the icon

valueOf

public static Module valueOf(org.w3c.dom.Element el)

Create a Module from an XML tag