A B C D E F G H I M O P R S T W

A

AbstractCopyGlobalActor - Class in adams.flow.core
Ancestor for actors that use a copy of a global actor.
AbstractCopyGlobalActor() - Constructor for class adams.flow.core.AbstractCopyGlobalActor
 
AbstractFlowGenerator<T extends AbstractActor> - Class in adams.flow.generator
Ancestor for generators that use model setups to generate flows.
AbstractFlowGenerator() - Constructor for class adams.flow.generator.AbstractFlowGenerator
 
AbstractTemplate - Class in adams.flow.core
Abstract ancestor for all actors that use a template to generate the actual actor/sub-flow to be executed.
AbstractTemplate() - Constructor for class adams.flow.core.AbstractTemplate
 
accepts() - Method in class adams.flow.sink.CopyGlobalSink
Returns the class that the consumer accepts.
accepts() - Method in class adams.flow.sink.TemplateSink
Returns the class that the consumer accepts.
accepts() - Method in class adams.flow.transformer.CopyGlobalTransformer
Returns the class that the consumer accepts.
accepts() - Method in class adams.flow.transformer.TemplateTransformer
Returns the class that the consumer accepts.
adams.flow.core - package adams.flow.core
 
adams.flow.generator - package adams.flow.generator
 
adams.flow.sink - package adams.flow.sink
 
adams.flow.source - package adams.flow.source
 
adams.flow.standalone - package adams.flow.standalone
 
adams.flow.transformer - package adams.flow.transformer
 

B

BACKUP_ACTOR - Static variable in class adams.flow.core.AbstractTemplate
the key for storing the current actor in the backup.
BACKUP_CURRENT - Static variable in class adams.flow.sink.CopyGlobalSink
the key for storing the current counter in the backup.
BACKUP_CURRENT - Static variable in class adams.flow.sink.TemplateSink
the key for storing the current counter in the backup.
BACKUP_INPUT - Static variable in class adams.flow.transformer.CopyGlobalTransformer
the key for storing the current input token in the backup.
BACKUP_INPUT - Static variable in class adams.flow.transformer.TemplateTransformer
the key for storing the current input token in the backup.
backupState() - Method in class adams.flow.core.AbstractTemplate
Backs up the current state of the actor before update the variables.
backupState() - Method in class adams.flow.sink.CopyGlobalSink
Backs up the current state of the actor before update the variables.
backupState() - Method in class adams.flow.sink.TemplateSink
Backs up the current state of the actor before update the variables.
backupState() - Method in class adams.flow.transformer.CopyGlobalTransformer
Backs up the current state of the actor before update the variables.
backupState() - Method in class adams.flow.transformer.TemplateTransformer
Backs up the current state of the actor before update the variables.

C

check() - Method in class adams.flow.generator.AbstractFlowGenerator
Hook method for checks before generating the flow.
cleanUp() - Method in class adams.flow.core.AbstractCopyGlobalActor
Cleans up after the execution has finished.
cleanUp() - Method in class adams.flow.core.AbstractTemplate
Cleans up after the execution has finished.
CopyGlobalSink - Class in adams.flow.sink
Copies a global sink to consume the tokens.
CopyGlobalSink() - Constructor for class adams.flow.sink.CopyGlobalSink
 
CopyGlobalSource - Class in adams.flow.source
Broadcasts the generated output tokens from the copied global source.
CopyGlobalSource() - Constructor for class adams.flow.source.CopyGlobalSource
 
CopyGlobalStandalone - Class in adams.flow.standalone
Executes the copied global standalone.
CopyGlobalStandalone() - Constructor for class adams.flow.standalone.CopyGlobalStandalone
 
CopyGlobalTransformer - Class in adams.flow.transformer
Feeds tokens into the copy of a global transformer and broadcasts the generated output tokens.
CopyGlobalTransformer() - Constructor for class adams.flow.transformer.CopyGlobalTransformer
 

D

defineOptions() - Method in class adams.flow.core.AbstractCopyGlobalActor
Adds options to the internal list of options.
defineOptions() - Method in class adams.flow.core.AbstractTemplate
Adds options to the internal list of options.
defineOptions() - Method in class adams.flow.generator.Template
Adds options to the internal list of options.
doExecute() - Method in class adams.flow.core.AbstractCopyGlobalActor
Executes the flow item.
doExecute() - Method in class adams.flow.sink.TemplateSink
Executes the flow item.
doExecute() - Method in class adams.flow.source.TemplateSource
Executes the flow item.
doExecute() - Method in class adams.flow.standalone.TemplateStandalone
Executes the flow item.
doExecute() - Method in class adams.flow.transformer.TemplateTransformer
Executes the flow item.
doGenerate() - Method in class adams.flow.generator.AbstractFlowGenerator
Generates the flow.
doGenerate() - Method in class adams.flow.generator.Template
Generates the flow.

E

executeGlobalActor() - Method in class adams.flow.core.AbstractCopyGlobalActor
Executes the global actor.
executeGlobalActor() - Method in class adams.flow.sink.CopyGlobalSink
Executes the global actor.
executeGlobalActor() - Method in class adams.flow.source.CopyGlobalSource
Executes the global actor.
executeGlobalActor() - Method in class adams.flow.standalone.CopyGlobalStandalone
Executes the global actor.
executeGlobalActor() - Method in class adams.flow.transformer.CopyGlobalTransformer
Executes the global actor.

F

findGlobalActor() - Method in class adams.flow.core.AbstractCopyGlobalActor
Tries to find the global actor referenced by its global name.
findGlobalActor() - Method in class adams.flow.sink.CopyGlobalSink
Tries to find the global actor referenced by its global name.
findGlobalActor() - Method in class adams.flow.source.CopyGlobalSource
Tries to find the global actor referenced by its global name.
findGlobalActor() - Method in class adams.flow.standalone.CopyGlobalStandalone
Tries to find the global actor referenced by its global name.
findGlobalActor() - Method in class adams.flow.transformer.CopyGlobalTransformer
Tries to find the global actor referenced by its global name.
forceVariables(Variables) - Method in class adams.flow.core.AbstractCopyGlobalActor
Updates the Variables instance in use.

G

generate() - Method in class adams.flow.generator.AbstractFlowGenerator
Generates the flow and returns it.
generate() - Method in interface adams.flow.generator.Generator
Generates the flow and returns it.
generates() - Method in class adams.flow.source.CopyGlobalSource
Returns the class of objects that it generates.
generates() - Method in class adams.flow.source.TemplateSource
Returns the class of objects that it generates.
generates() - Method in class adams.flow.transformer.CopyGlobalTransformer
Returns the class of objects that it generates.
generates() - Method in class adams.flow.transformer.TemplateTransformer
Returns the class of objects that it generates.
Generator<T extends AbstractActor> - Interface in adams.flow.generator
Generator interface for flow generators.
getActualActor() - Method in class adams.flow.core.AbstractTemplate
Returns the actual actor that was generated from the template.
getDefaultTemplate() - Method in class adams.flow.core.AbstractTemplate
Returns the default template to use.
getDefaultTemplate() - Method in class adams.flow.generator.Template
Returns the default template to use.
getDefaultTemplate() - Method in class adams.flow.sink.TemplateSink
Returns the default template to use.
getDefaultTemplate() - Method in class adams.flow.source.TemplateSource
Returns the default template to use.
getDefaultTemplate() - Method in class adams.flow.standalone.TemplateStandalone
Returns the default template to use.
getDefaultTemplate() - Method in class adams.flow.transformer.TemplateTransformer
Returns the default template to use.
getGlobalActor() - Method in class adams.flow.core.AbstractCopyGlobalActor
Returns the currently set global actor.
getGlobalName() - Method in class adams.flow.core.AbstractCopyGlobalActor
Returns the name of the global actor in use.
getOwner() - Method in class adams.flow.generator.AbstractFlowGenerator
Returns the owner.
getOwner() - Method in interface adams.flow.generator.Generator
Returns the owner.
getQuickInfo() - Method in class adams.flow.core.AbstractCopyGlobalActor
Returns a quick info about the actor, which will be displayed in the GUI.
getQuickInfo() - Method in class adams.flow.core.AbstractTemplate
Returns a quick info about the actor, which will be displayed in the GUI.
getTemplate() - Method in class adams.flow.core.AbstractTemplate
Returns the name of the global actor in use.
getTemplate() - Method in class adams.flow.generator.Template
Returns the name of the global actor in use.
globalInfo() - Method in class adams.flow.generator.Template
Returns a string describing the object.
globalInfo() - Method in class adams.flow.sink.CopyGlobalSink
Returns a string describing the object.
globalInfo() - Method in class adams.flow.sink.TemplateSink
Returns a string describing the object.
globalInfo() - Method in class adams.flow.source.CopyGlobalSource
Returns a string describing the object.
globalInfo() - Method in class adams.flow.source.TemplateSource
Returns a string describing the object.
globalInfo() - Method in class adams.flow.standalone.CopyGlobalStandalone
Returns a string describing the object.
globalInfo() - Method in class adams.flow.standalone.TemplateStandalone
Returns a string describing the object.
globalInfo() - Method in class adams.flow.transformer.CopyGlobalTransformer
Returns a string describing the object.
globalInfo() - Method in class adams.flow.transformer.TemplateTransformer
Returns a string describing the object.
globalNameTipText() - Method in class adams.flow.core.AbstractCopyGlobalActor
Returns the tip text for this property.

H

hasGlobalActor() - Method in class adams.flow.core.AbstractCopyGlobalActor
Checks whether a reference to the global actor is currently available.
hasPendingOutput() - Method in class adams.flow.source.CopyGlobalSource
Checks whether there is pending output to be collected after executing the flow item.
hasPendingOutput() - Method in class adams.flow.source.TemplateSource
Checks whether there is pending output to be collected after executing the flow item.
hasPendingOutput() - Method in class adams.flow.transformer.CopyGlobalTransformer
Checks whether there is pending output to be collected after executing the flow item.
hasPendingOutput() - Method in class adams.flow.transformer.TemplateTransformer
Checks whether there is pending output to be collected after executing the flow item.

I

initialize() - Method in class adams.flow.core.AbstractCopyGlobalActor
Initializes the members.
input(Token) - Method in class adams.flow.sink.CopyGlobalSink
The method that accepts the input token and then processes it.
input(Token) - Method in class adams.flow.sink.TemplateSink
The method that accepts the input token and then processes it.
input(Token) - Method in class adams.flow.transformer.CopyGlobalTransformer
The method that accepts the input token and then processes it.
input(Token) - Method in class adams.flow.transformer.TemplateTransformer
The method that accepts the input token and then processes it.
isFinished() - Method in class adams.flow.core.AbstractCopyGlobalActor
Returns whether the actor has finished.
isFinished() - Method in class adams.flow.core.AbstractTemplate
Returns whether the actor has finished.

M

m_Actor - Variable in class adams.flow.core.AbstractTemplate
the generated actor.
m_CurrentInput - Variable in class adams.flow.sink.CopyGlobalSink
the token that is to be fed to the global sink.
m_CurrentInput - Variable in class adams.flow.sink.TemplateSink
the token that is to be fed to the global sink.
m_GlobalActor - Variable in class adams.flow.core.AbstractCopyGlobalActor
the global actor.
m_GlobalName - Variable in class adams.flow.core.AbstractCopyGlobalActor
the global name.
m_Helper - Variable in class adams.flow.core.AbstractCopyGlobalActor
the helper class.
m_InputToken - Variable in class adams.flow.transformer.CopyGlobalTransformer
the token that is to be fed into the global transformer.
m_InputToken - Variable in class adams.flow.transformer.TemplateTransformer
the token that is to be fed into the global transformer.
m_Owner - Variable in class adams.flow.generator.AbstractFlowGenerator
the owner.
m_Template - Variable in class adams.flow.core.AbstractTemplate
the template.
m_Template - Variable in class adams.flow.generator.Template
the template.

O

output() - Method in class adams.flow.source.CopyGlobalSource
Returns the generated token.
output() - Method in class adams.flow.source.TemplateSource
Returns the generated token.
output() - Method in class adams.flow.transformer.CopyGlobalTransformer
Returns the generated token.
output() - Method in class adams.flow.transformer.TemplateTransformer
Returns the generated token.

P

pruneBackup() - Method in class adams.flow.core.AbstractTemplate
Removes entries from the backup.
pruneBackup() - Method in class adams.flow.transformer.CopyGlobalTransformer
Removes entries from the backup.

R

reset() - Method in class adams.flow.core.AbstractTemplate
Resets the scheme.
reset() - Method in class adams.flow.sink.CopyGlobalSink
Resets the scheme.
reset() - Method in class adams.flow.sink.TemplateSink
Resets the scheme.
reset() - Method in class adams.flow.transformer.CopyGlobalTransformer
Resets the scheme.
reset() - Method in class adams.flow.transformer.TemplateTransformer
Resets the scheme.
restoreState(Hashtable<String, Object>) - Method in class adams.flow.core.AbstractTemplate
Restores the state of the actor before the variables got updated.
restoreState(Hashtable<String, Object>) - Method in class adams.flow.sink.CopyGlobalSink
Restores the state of the actor before the variables got updated.
restoreState(Hashtable<String, Object>) - Method in class adams.flow.sink.TemplateSink
Restores the state of the actor before the variables got updated.
restoreState(Hashtable<String, Object>) - Method in class adams.flow.transformer.CopyGlobalTransformer
Restores the state of the actor before the variables got updated.
restoreState(Hashtable<String, Object>) - Method in class adams.flow.transformer.TemplateTransformer
Restores the state of the actor before the variables got updated.

S

setGlobalName(GlobalActorReference) - Method in class adams.flow.core.AbstractCopyGlobalActor
Sets the name of the global actor to use.
setOwner(T) - Method in class adams.flow.generator.AbstractFlowGenerator
Sets the owner.
setOwner(T) - Method in interface adams.flow.generator.Generator
Sets the owner.
setTemplate(AbstractActorTemplate) - Method in class adams.flow.core.AbstractTemplate
Sets the name of the global actor to use.
setTemplate(AbstractActorTemplate) - Method in class adams.flow.generator.Template
Sets the name of the global actor to use.
setUp() - Method in class adams.flow.core.AbstractCopyGlobalActor
Initializes the item for flow execution.
setUpTemplate() - Method in class adams.flow.core.AbstractTemplate
Initializes the template for flow execution.
setUpTemplate() - Method in class adams.flow.sink.TemplateSink
Initializes the template for flow execution.
setUpTemplate() - Method in class adams.flow.source.TemplateSource
Initializes the template for flow execution.
setUpTemplate() - Method in class adams.flow.standalone.TemplateStandalone
Initializes the template for flow execution.
setUpTemplate() - Method in class adams.flow.transformer.TemplateTransformer
Initializes the template for flow execution.
stopExecution() - Method in class adams.flow.core.AbstractCopyGlobalActor
Stops the execution.
stopExecution() - Method in class adams.flow.core.AbstractTemplate
Stops the execution.

T

Template - Class in adams.flow.generator
Uses the specified flow template to generate the sub-flow.
Template() - Constructor for class adams.flow.generator.Template
 
TemplateSink - Class in adams.flow.sink
Lets a sink generated from a template consume the input tokens.
TemplateSink() - Constructor for class adams.flow.sink.TemplateSink
 
TemplateSource - Class in adams.flow.source
Broadcasts the generated output tokens from the (template) source.
TemplateSource() - Constructor for class adams.flow.source.TemplateSource
 
TemplateStandalone - Class in adams.flow.standalone
Generates a standalone actor/sub-flow from a template.
TemplateStandalone() - Constructor for class adams.flow.standalone.TemplateStandalone
 
templateTipText() - Method in class adams.flow.core.AbstractTemplate
Returns the tip text for this property.
templateTipText() - Method in class adams.flow.generator.Template
Returns the tip text for this property.
TemplateTransformer - Class in adams.flow.transformer
Feeds tokens into an actor generated from a template and broadcasts the generated output tokens.
TemplateTransformer() - Constructor for class adams.flow.transformer.TemplateTransformer
 

W

wrapUp() - Method in class adams.flow.core.AbstractCopyGlobalActor
Cleans up after the execution has finished.
wrapUp() - Method in class adams.flow.core.AbstractTemplate
Cleans up after the execution has finished.

A B C D E F G H I M O P R S T W

Copyright © 2013 University of Waikato, Hamilton, NZ. All Rights Reserved.