net.sf.pipet.api
Class ModuleDefinition

java.lang.Object
  net.sf.pipet.api.ModuleAttributes
      net.sf.pipet.api.ModuleDefinition

public class ModuleDefinition
extends ModuleAttributes

A module definition which can be part of a pipeline setup. A module definition object represents a global definition of a PipeT module which uses

• a ModuleInterface to access the module;
• a CachePolicy to prevent subsequent repetitive calls to the ModuleInterface, and
• export paths to say how the module can be accessed remotely.

In addition, a ModuleDefinition has attributes which represent the module's custom parameter values.

Nested Class Summary

Nested classes/interfaces inherited from class net.sf.pipet.api.ModuleAttributes

ModuleAttributes.ChangeListener

Field Summary

Fields inherited from class net.sf.pipet.api.ModuleAttributes

EMPTY

Constructor Summary

protected

ModuleDefinition(ModuleDefinition parent, String iface_spec, ModuleInterface iface, CachePolicy cache_policy, Map<String,net.sf.qxs.types.UntypedValue> props)

Method Summary

static ModuleDefinition	create(ModuleDefinition parent)
static ModuleDefinition	create(ModuleDefinition parent, String iface_spec, ModuleInterface iface, CachePolicy cache_policy, Map<String,net.sf.qxs.types.UntypedValue> props)
static ModuleDefinition	createRoot(CachePolicy cache_policy, Map<String,net.sf.qxs.types.UntypedValue> props)
CachePolicy	getCachePolicy() Returns the cache policy used by this module.
CachePolicy	getCachePolicy(boolean cascade)
String	getDescription()
Map<String,ParameterType<?>>	getGlobalParameters()
Collection<String>	getInputPipeNames() Deprecated.
Map<String,String>	getInputPipeTypes() Returns the input ports of this module.
ModuleInterface	getInterface() Returns the ModuleInterface used by this module.
ModuleAttributes	getInterfaceRoot()
String	getInterfaceSpecification() Returns the unique identifier of the interface used by this module.
String	getInterfaceSpecification(boolean cascade)
Collection<String>	getOutputPipeNames() Deprecated.
Map<String,String>	getOutputPipeTypes() Returns the output ports of this module.
Map<String,ParameterType<?>>	getPipelineParameters()
Map<String,ParameterType<?>>	getRuntimeParameters()
String	getTitle()
boolean	isAncestorOrSelf(ModuleDefinition mod)
boolean	isSatisfied(Collection<String> provided_data)
void	setCachePolicy(CachePolicy policy)
String	toString()
int	valueHash()

Methods inherited from class net.sf.pipet.api.ModuleAttributes

addChangeListener, changed, getDefaultValue, getParent, getPipelineModule, getRoot, getValue, getValue, hashCode, hasValue, hasValue, setValue, toMap

Methods inherited from class java.lang.Object

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

Constructor Detail

ModuleDefinition

protected ModuleDefinition(ModuleDefinition parent,
                           String iface_spec,
                           ModuleInterface iface,
                           CachePolicy cache_policy,
                           Map<String,net.sf.qxs.types.UntypedValue> props)

Method Detail

valueHash

public int valueHash()

Overrides:

valueHash in class ModuleAttributes

getInterfaceRoot

public ModuleAttributes getInterfaceRoot()

Overrides:

getInterfaceRoot in class ModuleAttributes

createRoot

public static ModuleDefinition createRoot(CachePolicy cache_policy,
                                          Map<String,net.sf.qxs.types.UntypedValue> props)

create

public static ModuleDefinition create(ModuleDefinition parent)

create

public static ModuleDefinition create(ModuleDefinition parent,
                                      String iface_spec,
                                      ModuleInterface iface,
                                      CachePolicy cache_policy,
                                      Map<String,net.sf.qxs.types.UntypedValue> props)

isAncestorOrSelf

public boolean isAncestorOrSelf(ModuleDefinition mod)

getTitle

public String getTitle()

getDescription

public String getDescription()
                      throws ResourceException

Throws:

ResourceException

getOutputPipeNames

@Deprecated
public Collection<String> getOutputPipeNames()
                                      throws ResourceException

Deprecated.

Throws:

ResourceException

getInputPipeNames

@Deprecated
public Collection<String> getInputPipeNames()
                                     throws ResourceException

Deprecated.

Throws:

ResourceException

getOutputPipeTypes

public Map<String,String> getOutputPipeTypes()
                                      throws ResourceException

Returns the output ports of this module. The returned object is a Map with name/type value pairs, with:

• name - the name of the output port; and
• type - the content type of the data produced by the port.

Returns:

a Map with name/type pairs.

Throws:

ResourceException

getInputPipeTypes

public Map<String,String> getInputPipeTypes()
                                     throws ResourceException

Returns the input ports of this module. The returned object is a Map with name/type value pairs, with:

• name - the name of the input port; and
• type - the content type of the data accepted by the port.

Returns:

a Map with name/type pairs.

Throws:

ResourceException

getGlobalParameters

public Map<String,ParameterType<?>> getGlobalParameters()
                                                 throws ResourceException

Throws:

ResourceException

getPipelineParameters

public Map<String,ParameterType<?>> getPipelineParameters()
                                                   throws ResourceException

Throws:

ResourceException

getRuntimeParameters

public Map<String,ParameterType<?>> getRuntimeParameters()
                                                  throws ResourceException

Throws:

ResourceException

isSatisfied

public boolean isSatisfied(Collection<String> provided_data)
                    throws ResourceException

Throws:

ResourceException

getInterface

public ModuleInterface getInterface()

Returns the ModuleInterface used by this module.

getInterfaceSpecification

public String getInterfaceSpecification()

Returns the unique identifier of the interface used by this module.

getInterfaceSpecification

public String getInterfaceSpecification(boolean cascade)

setCachePolicy

public void setCachePolicy(CachePolicy policy)

getCachePolicy

public CachePolicy getCachePolicy()

Returns the cache policy used by this module.

getCachePolicy

public CachePolicy getCachePolicy(boolean cascade)

toString

public String toString()

Overrides:

toString in class Object