A C D E F G H I J L M N O P R S T U V W X

A

abort() - Method in interface net.sf.pipet.api.ModuleInterface.ModuleInstance

This method is called to request that running operations are aborted.

AbstractModule - Class in net.sf.pipet.api

The purpose of this class is to improve version stability.

AbstractModule() - Constructor for class net.sf.pipet.api.AbstractModule

addChangeListener(ModuleAttributes.ChangeListener) - Method in class net.sf.pipet.api.ModuleAttributes

ANY - Static variable in class net.sf.pipet.MimeType

API - Class in net.sf.pipet.api

API() - Constructor for class net.sf.pipet.api.API

ATT_PIPELINE_NAME - Static variable in interface net.sf.pipet.api.ModuleInterface

C

CacheInterface - Interface in net.sf.pipet.api

CachePolicy - Interface in net.sf.pipet.api

changed() - Method in class net.sf.pipet.api.ModuleAttributes

changed(ModuleAttributes) - Method in interface net.sf.pipet.api.ModuleAttributes.ChangeListener

close(boolean) - Method in interface net.sf.pipet.api.ModuleData

Closes all streams.

compiled - Static variable in class net.sf.pipet.api.API

configure(ModuleAttributes, Collection<ModuleDefinition>, Messenger) - Method in interface net.sf.pipet.api.ModuleInterface.ModuleConfigurator

A call to this method configures the module by setting the configuration variables in the ModuleAttributes object which is passed as a parameter.

create(ModuleDefinition) - Static method in class net.sf.pipet.api.ModuleDefinition

create(ModuleDefinition, String, ModuleInterface, CachePolicy, Map<String, UntypedValue>) - Static method in class net.sf.pipet.api.ModuleDefinition

createCachedModuleJob(ModuleDefinition, ModuleData, Messenger) - Method in interface net.sf.pipet.api.CachePolicy

createInstance(ModuleData, Messenger) - Method in interface net.sf.pipet.api.ModuleInterface

Instantiates a module to be part of a pipeline instance.

createInstance(ModuleData, Messenger) - Method in class net.sf.pipet.api.SimpleInputOutputModule

createRoot(CachePolicy, Map<String, UntypedValue>) - Static method in class net.sf.pipet.api.ModuleDefinition

D

DefaultModuleInterface - Class in net.sf.pipet.api

A simple ModuleInterface, which provides a default implementation for most methods.

DefaultModuleInterface() - Constructor for class net.sf.pipet.api.DefaultModuleInterface

E

EMPTY - Static variable in class net.sf.pipet.api.ModuleAttributes

F

FAIL_CONFIGURATOR - Static variable in interface net.sf.pipet.api.ModuleInterface

G

getAPIVersionString() - Method in class net.sf.pipet.api.AbstractModule

getAPIVersionString() - Method in interface net.sf.pipet.api.ModuleInterface

getAPIVersionString() - Method in class net.sf.pipet.api.VersionedModule

getAttributes() - Method in interface net.sf.pipet.api.ModuleData

Returns the module's configuration.

getCachePolicy() - Method in class net.sf.pipet.api.ModuleDefinition

Returns the cache policy used by this module.

getCachePolicy(boolean) - Method in class net.sf.pipet.api.ModuleDefinition

getCompiled() - Method in class net.sf.pipet.api.API

getDefaultValue(String) - Method in class net.sf.pipet.api.ModuleAttributes

Returns the value which would have been returned by getValue(String) if this ModuleAttributes object has no value associated with key.

getDescription() - Method in class net.sf.pipet.api.ModuleDefinition

getDescription(ModuleAttributes) - Method in interface net.sf.pipet.api.ModuleInterface

Returns a description of the module.

getDescription(ModuleAttributes) - Method in class net.sf.pipet.api.SimpleInputOutputModule

getGlobalParameters(ModuleAttributes) - Method in class net.sf.pipet.api.AbstractModule

getGlobalParameters() - Method in class net.sf.pipet.api.ModuleDefinition

getGlobalParameters(ModuleAttributes) - Method in interface net.sf.pipet.api.ModuleInterface

getInputPipeNames(ModuleAttributes) - Method in class net.sf.pipet.api.AbstractModule

Deprecated.

getInputPipeNames() - Method in class net.sf.pipet.api.ModuleDefinition

Deprecated.

getInputPipeNames(ModuleAttributes) - Method in interface net.sf.pipet.api.ModuleInterface

Deprecated.

getInputPipes() - Method in interface net.sf.pipet.api.ModuleData

Returns the accessible input pipes.

getInputPipeTypes(ModuleAttributes) - Method in class net.sf.pipet.api.DefaultModuleInterface

Returns an empty set.

getInputPipeTypes() - Method in class net.sf.pipet.api.ModuleDefinition

Returns the input ports of this module.

getInputPipeTypes(ModuleAttributes) - Method in interface net.sf.pipet.api.ModuleInterface

Returns a map with one entry for each input pipe.

getInputPipeTypes(ModuleAttributes) - Method in class net.sf.pipet.api.SimpleInputOutputModule

getInputType() - Method in class net.sf.pipet.api.SimpleInputOutputModule

getInstallationConfigurator(int) - Method in class net.sf.pipet.api.DefaultModuleInterface

Returns null.

getInstallationConfigurator(int) - Method in interface net.sf.pipet.api.ModuleInterface

Returns a configurator.

getInterface() - Method in interface net.sf.pipet.api.CachePolicy

getInterface() - Method in class net.sf.pipet.api.ModuleDefinition

Returns the ModuleInterface used by this module.

getInterfaceRoot() - Method in class net.sf.pipet.api.ModuleAttributes

getInterfaceRoot() - Method in class net.sf.pipet.api.ModuleDefinition

getInterfaceSpecification() - Method in interface net.sf.pipet.api.CachePolicy

getInterfaceSpecification() - Method in class net.sf.pipet.api.ModuleDefinition

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

getInterfaceSpecification(boolean) - Method in class net.sf.pipet.api.ModuleDefinition

getLeftOver(Map<String, ParameterType<?>>, ModuleAttributes) - Static method in class net.sf.pipet.api.AbstractModule

getName() - Method in interface net.sf.pipet.api.CachePolicy

getOutputPipeNames(ModuleAttributes) - Method in class net.sf.pipet.api.AbstractModule

Deprecated.

getOutputPipeNames() - Method in class net.sf.pipet.api.ModuleDefinition

Deprecated.

getOutputPipeNames(ModuleAttributes) - Method in interface net.sf.pipet.api.ModuleInterface

Deprecated.

getOutputPipes() - Method in interface net.sf.pipet.api.ModuleData

Returns the accessible output pipes.

getOutputPipeTypes(ModuleAttributes) - Method in class net.sf.pipet.api.DefaultModuleInterface

Returns an empty set.

getOutputPipeTypes() - Method in class net.sf.pipet.api.ModuleDefinition

Returns the output ports of this module.

getOutputPipeTypes(ModuleAttributes) - Method in interface net.sf.pipet.api.ModuleInterface

Returns a map with one entry for each output pipe.

getOutputPipeTypes(ModuleAttributes) - Method in class net.sf.pipet.api.SimpleInputOutputModule

getOutputType() - Method in class net.sf.pipet.api.SimpleInputOutputModule

getParent() - Method in class net.sf.pipet.api.ModuleAttributes

Returns the parent of this object (may be null).

getPipelineConfigurator(int) - Method in class net.sf.pipet.api.DefaultModuleInterface

Returns null.

getPipelineConfigurator(int) - Method in interface net.sf.pipet.api.ModuleInterface

Returns a configurator.

getPipelineModule() - Method in class net.sf.pipet.api.ModuleAttributes

getPipelineParameters(ModuleAttributes) - Method in class net.sf.pipet.api.AbstractModule

getPipelineParameters() - Method in class net.sf.pipet.api.ModuleDefinition

getPipelineParameters(ModuleAttributes) - Method in interface net.sf.pipet.api.ModuleInterface

getPipeTypes(Collection<String>) - Static method in class net.sf.pipet.api.AbstractModule

Deprecated.

getResource(String) - Method in interface net.sf.pipet.api.ResourceLoader

Returns an input stream for a given resource location.

getResourceURL(String) - Method in interface net.sf.pipet.api.ResourceLoader

Returns a URL for a given resource location.

getRoot() - Method in class net.sf.pipet.api.ModuleAttributes

Returns the root of this object, which is this, if this has no parent; or the root of the parent, otherwise.

getRuntimeConfigurator(int) - Method in class net.sf.pipet.api.DefaultModuleInterface

Returns null.

getRuntimeConfigurator(int) - Method in interface net.sf.pipet.api.ModuleInterface

Returns a configurator.

getRuntimeParameters(ModuleAttributes) - Method in class net.sf.pipet.api.AbstractModule

getRuntimeParameters() - Method in class net.sf.pipet.api.ModuleDefinition

getRuntimeParameters(ModuleAttributes) - Method in interface net.sf.pipet.api.ModuleInterface

getTitle(ModuleAttributes) - Method in class net.sf.pipet.api.AbstractModule

getTitle() - Method in class net.sf.pipet.api.ModuleDefinition

getTitle(ModuleAttributes) - Method in interface net.sf.pipet.api.ModuleInterface

Returns the title (a short description) of the module.

getTitle(ModuleAttributes) - Method in class net.sf.pipet.api.SimpleInputOutputModule

getUniqueId() - Method in interface net.sf.pipet.api.ModuleData

Creates an identifier which is unique within the current pipeline instance.

getValue(String) - Method in class net.sf.pipet.api.ModuleAttributes

Convenience method for ModuleAttributes.getValue(String,boolean)

getValue(String, boolean) - Method in class net.sf.pipet.api.ModuleAttributes

Returns the value associated with key.

getVersion() - Method in class net.sf.pipet.api.API

H

hashCode() - Method in class net.sf.pipet.api.ModuleAttributes

hasValue(String) - Method in class net.sf.pipet.api.ModuleAttributes

hasValue(String, boolean) - Method in class net.sf.pipet.api.ModuleAttributes

haveCache(String, long, Messenger) - Method in interface net.sf.pipet.api.CacheInterface

HTML - Static variable in class net.sf.pipet.MimeType

I

INPUT_NAME - Static variable in class net.sf.pipet.api.SimpleInputOutputModule

InputOutputModule - Class in net.sf.pipet.api

Abstract base class for a PipeT module.

InputOutputModule(String, String) - Constructor for class net.sf.pipet.api.InputOutputModule

InputOutputModule(String, String, String, String) - Constructor for class net.sf.pipet.api.InputOutputModule

isAncestorOrSelf(ModuleDefinition) - Method in class net.sf.pipet.api.ModuleDefinition

isAvailable() - Method in class net.sf.pipet.api.AbstractModule

isAvailable() - Method in interface net.sf.pipet.api.ModuleInterface

isSatisfied(Collection<String>) - Method in class net.sf.pipet.api.ModuleDefinition

J

JSON - Static variable in class net.sf.pipet.MimeType

L

LONG - Static variable in interface net.sf.pipet.param.ParameterType

LongClass - Class in net.sf.pipet.param

M

MimeType - Class in net.sf.pipet

MimeType() - Constructor for class net.sf.pipet.MimeType

ModuleAttributes - Class in net.sf.pipet.api

An object holding the module's configuration.

ModuleAttributes() - Constructor for class net.sf.pipet.api.ModuleAttributes

ModuleAttributes(ModuleAttributes) - Constructor for class net.sf.pipet.api.ModuleAttributes

ModuleAttributes(Map<String, UntypedValue>) - Constructor for class net.sf.pipet.api.ModuleAttributes

ModuleAttributes(ModuleAttributes, Map<String, UntypedValue>) - Constructor for class net.sf.pipet.api.ModuleAttributes

ModuleAttributes.ChangeListener - Interface in net.sf.pipet.api

ModuleData - Interface in net.sf.pipet.api

A ModuleData object provides runtime access to a module's environment.

ModuleDefinition - Class in net.sf.pipet.api

A module definition which can be part of a pipeline setup.

ModuleDefinition(ModuleDefinition, String, ModuleInterface, CachePolicy, Map<String, UntypedValue>) - Constructor for class net.sf.pipet.api.ModuleDefinition

ModuleInterface - Interface in net.sf.pipet.api

The interface of a module implementation - the entry class of a PipeT module must implement this interface.

ModuleInterface.ModuleConfigurator - Interface in net.sf.pipet.api

Interface for module configuration.

ModuleInterface.ModuleInstance - Interface in net.sf.pipet.api

Interface of a module instance.

N

net.sf.pipet - package net.sf.pipet

net.sf.pipet.api - package net.sf.pipet.api

net.sf.pipet.param - package net.sf.pipet.param

net.sf.pipet.resources - package net.sf.pipet.resources

O

OUTPUT_NAME - Static variable in class net.sf.pipet.api.SimpleInputOutputModule

P

ParameterClass<T> - Class in net.sf.pipet.param

ParameterClass(String) - Constructor for class net.sf.pipet.param.ParameterClass

ParameterClass.ValidationException - Exception in net.sf.pipet.param

ParameterClass.ValidationException(String, Throwable) - Constructor for exception net.sf.pipet.param.ParameterClass.ValidationException

ParameterClass.ValidationException(String) - Constructor for exception net.sf.pipet.param.ParameterClass.ValidationException

ParameterClass.ValidationException(Throwable) - Constructor for exception net.sf.pipet.param.ParameterClass.ValidationException

ParameterType<T> - Interface in net.sf.pipet.param

parseSubclassType(String) - Method in class net.sf.pipet.param.LongClass

parseSubclassType(String) - Method in class net.sf.pipet.param.ParameterClass

parseSubclassType(String) - Method in class net.sf.pipet.param.TextClass

parseType(String) - Static method in class net.sf.pipet.param.ParameterClass

R

readCache(String, long, ModuleData, Messenger) - Method in interface net.sf.pipet.api.CacheInterface

ResourceAccessException - Exception in net.sf.pipet.resources

ResourceAccessException(String) - Constructor for exception net.sf.pipet.resources.ResourceAccessException

ResourceAccessException(Throwable) - Constructor for exception net.sf.pipet.resources.ResourceAccessException

ResourceAccessException(String, Throwable) - Constructor for exception net.sf.pipet.resources.ResourceAccessException

ResourceException - Exception in net.sf.pipet.resources

ResourceException() - Constructor for exception net.sf.pipet.resources.ResourceException

ResourceException(String) - Constructor for exception net.sf.pipet.resources.ResourceException

ResourceException(Throwable) - Constructor for exception net.sf.pipet.resources.ResourceException

ResourceException(String, Throwable) - Constructor for exception net.sf.pipet.resources.ResourceException

ResourceLoader - Interface in net.sf.pipet.api

ResourceNotFoundException - Exception in net.sf.pipet.resources

ResourceNotFoundException() - Constructor for exception net.sf.pipet.resources.ResourceNotFoundException

ResourceNotFoundException(String) - Constructor for exception net.sf.pipet.resources.ResourceNotFoundException

ResourceNotFoundException(Throwable) - Constructor for exception net.sf.pipet.resources.ResourceNotFoundException

ResourceNotFoundException(String, Throwable) - Constructor for exception net.sf.pipet.resources.ResourceNotFoundException

ResourceNotPermittedException - Exception in net.sf.pipet.resources

ResourceNotPermittedException(String) - Constructor for exception net.sf.pipet.resources.ResourceNotPermittedException

ResourceNotPermittedException(Throwable) - Constructor for exception net.sf.pipet.resources.ResourceNotPermittedException

ResourceNotPermittedException(String, Throwable) - Constructor for exception net.sf.pipet.resources.ResourceNotPermittedException

ResourceSpecificationException - Exception in net.sf.pipet.resources

ResourceSpecificationException(String) - Constructor for exception net.sf.pipet.resources.ResourceSpecificationException

ResourceSpecificationException(Throwable) - Constructor for exception net.sf.pipet.resources.ResourceSpecificationException

ResourceSpecificationException(String, Throwable) - Constructor for exception net.sf.pipet.resources.ResourceSpecificationException

ResourceValidationException - Exception in net.sf.pipet.resources

ResourceValidationException(String) - Constructor for exception net.sf.pipet.resources.ResourceValidationException

ResourceValidationException(Throwable) - Constructor for exception net.sf.pipet.resources.ResourceValidationException

ResourceValidationException(String, Throwable) - Constructor for exception net.sf.pipet.resources.ResourceValidationException

run(InputStream[], OutputStream, ModuleAttributes, Messenger) - Method in class net.sf.pipet.api.InputOutputModule

run(InputStream, OutputStream, ModuleAttributes, Messenger) - Method in class net.sf.pipet.api.InputOutputModule

run() - Method in interface net.sf.pipet.api.ModuleInterface.ModuleInstance

This method is called during pipeline execution to run a module.

run(InputStream[], OutputStream, ModuleAttributes, Messenger) - Method in class net.sf.pipet.api.SimpleInputOutputModule

Runs the module in a pipeline.

S

setCachePolicy(CachePolicy) - Method in class net.sf.pipet.api.ModuleDefinition

setValue(String, UntypedValue) - Method in class net.sf.pipet.api.ModuleAttributes

Assigns a value to a key.

SimpleInputOutputModule - Class in net.sf.pipet.api

Abstract base class for a PipeT module.

SimpleInputOutputModule(String, String) - Constructor for class net.sf.pipet.api.SimpleInputOutputModule

Constructs a module with default input and output types.

SimpleInputOutputModule(String, String, String, String) - Constructor for class net.sf.pipet.api.SimpleInputOutputModule

Constructs a module.

T

TEXT - Static variable in class net.sf.pipet.MimeType

TEXT - Static variable in interface net.sf.pipet.param.ParameterType

TextClass - Class in net.sf.pipet.param

toMap(boolean) - Method in class net.sf.pipet.api.ModuleAttributes

Returns a Map representation of this ModuleAttributes object.

toString() - Method in class net.sf.pipet.api.ModuleDefinition

toString() - Method in class net.sf.pipet.param.ParameterClass

TYPE - Static variable in class net.sf.pipet.param.LongClass

TYPE - Static variable in class net.sf.pipet.param.TextClass

U

UI_GUI - Static variable in interface net.sf.pipet.api.ModuleInterface

UI_NONINTERACTIVE - Static variable in interface net.sf.pipet.api.ModuleInterface

UNKNOWN - Static variable in class net.sf.pipet.MimeType

V

validate(Object) - Method in class net.sf.pipet.param.LongClass

validate(Object) - Method in interface net.sf.pipet.param.ParameterType

validate(Object) - Method in class net.sf.pipet.param.TextClass

valueHash() - Method in class net.sf.pipet.api.ModuleAttributes

valueHash() - Method in class net.sf.pipet.api.ModuleDefinition

version - Static variable in class net.sf.pipet.api.API

VersionedModule - Class in net.sf.pipet.api

VersionedModule() - Constructor for class net.sf.pipet.api.VersionedModule

W

waitForPipeline(boolean) - Method in interface net.sf.pipet.api.ModuleData

This method may be called by the module after all processing is completed if the final success status of the pipeline is relevant to the module.

writeCache(String, long, Map<String, byte[]>, Messenger) - Method in interface net.sf.pipet.api.CacheInterface

X

XML - Static variable in class net.sf.pipet.MimeType

A C D E F G H I J L M N O P R S T U V W X