oms3
Class Compound

java.lang.Object
  oms3.Compound

Direct Known Subclasses:

Conditional

public class Compound
extends java.lang.Object

Abstract Compound Command.

Version:

$Id: Compound.java 20 2008-07-25 22:31:07Z od $

Author:

Olaf David (olaf.david@ars.usda.gov)

Constructor Summary

Compound()

Method Summary

void	addListener(Notification.Listener l) Add a ExecutionListener that tracks execution
protected void	check() Check for valid internals within the compound
void	connect(java.lang.Object from, java.lang.String from_out, java.lang.Object... tos) Deprecated.
void	connect(java.lang.Object from, java.lang.String from_out, java.lang.Object to, java.lang.String to_in) Deprecated.
void	execute()
void	feedback(java.lang.Object from, java.lang.String from_out, java.lang.Object... tos) Feedback connection between two components.
void	feedback(java.lang.Object from, java.lang.String from_out, java.lang.Object to, java.lang.String to_in) Feedback connection between two components.
void	field2in(java.lang.Object o, java.lang.String field, java.lang.Object to) Maps an object's field to a component's In field with the same name
void	field2in(java.lang.Object o, java.lang.String field, java.lang.Object to, java.lang.String to_in) Maps a object's field to an In field
void	field2inout(java.lang.Object o, java.lang.String field, java.lang.Object comp) Maps a field to an In and Out field
void	field2inout(java.lang.Object o, java.lang.String field, java.lang.Object comp, java.lang.String inout) Maps a field to an In and Out field
void	finalizeComponents()
void	in2in(java.lang.String in, java.lang.Object... to) Maps a compound input to an internal simple input field.
void	in2in(java.lang.String in, java.lang.Object to, java.lang.String to_in) Maps a Compound Input field to a internal simple input field.
void	initializeComponents()
protected void	internalExec() Internal execution.
void	mapIn(java.lang.String in, java.lang.Object... to) Deprecated.
void	mapIn(java.lang.String in, java.lang.Object to, java.lang.String to_in) Deprecated.
void	mapInField(java.lang.Object o, java.lang.String out, java.lang.Object from) Deprecated.
void	mapInField(java.lang.Object o, java.lang.String out, java.lang.Object from, java.lang.String from_out) Deprecated.
void	mapOut(java.lang.String out, java.lang.Object from) Deprecated.
void	mapOut(java.lang.String out, java.lang.Object from, java.lang.String from_out) Deprecated.
void	mapOutField(java.lang.Object o, java.lang.String out, java.lang.Object from) Deprecated.
void	mapOutField(java.lang.Object o, java.lang.String out, java.lang.Object from, java.lang.String from_out) Deprecated.
void	out2field(java.lang.Object from, java.lang.String from_out, java.lang.Object o) Maps a component Out field to an object's field.
void	out2field(java.lang.Object from, java.lang.String from_out, java.lang.Object o, java.lang.String field) Maps a component's Out field to an object field.
void	out2in(java.lang.Object from, java.lang.String from_out, java.lang.Object... tos) Connects field1 of cmd1 with the same named fields in cmds
void	out2in(java.lang.Object from, java.lang.String from_out, java.lang.Object to, java.lang.String to_in) Connencts two internal components with respect to their fields.
void	out2infb(java.lang.Object from, java.lang.String from_out, java.lang.Object to, java.lang.String to_in) Connencts two internal components with respect to their fields.
void	out2out(java.lang.String out, java.lang.Object to) Map output maps a compound output to an internal simple output field.
void	out2out(java.lang.String out, java.lang.Object to, java.lang.String to_out) Maps a Compound Output field to a internal simple output field.
static void	reload()
void	removeListerer(Notification.Listener l) Remove a ExecutionListener that tracks execution
static void	shutdown() Shutting down the execution service
void	val2in(boolean val, java.lang.Object to, java.lang.String field)
void	val2in(byte val, java.lang.Object to, java.lang.String field)
void	val2in(char val, java.lang.Object to, java.lang.String field)
void	val2in(double val, java.lang.Object to, java.lang.String field)
void	val2in(float val, java.lang.Object to, java.lang.String field)
void	val2in(int val, java.lang.Object to, java.lang.String field)
void	val2in(long val, java.lang.Object to, java.lang.String field)
void	val2in(java.lang.Object val, java.lang.Object to, java.lang.String field)
void	val2in(short val, java.lang.Object to, java.lang.String field)

Methods inherited from class java.lang.Object

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

Constructor Detail

Compound

public Compound()

Method Detail

initializeComponents

public void initializeComponents()

finalizeComponents

public void finalizeComponents()

execute

public void execute()
             throws ComponentException

Throws:

ComponentException

shutdown

public static void shutdown()

Shutting down the execution service

reload

public static void reload()

out2infb

public void out2infb(java.lang.Object from,
                     java.lang.String from_out,
                     java.lang.Object to,
                     java.lang.String to_in)

Connencts two internal components with respect to their fields. from/@Out -> to/@In

Parameters:

from - command object 1

from_out - output field of cmd1

to - command opbject 2

to_in - input field of cmd2

out2in

public void out2in(java.lang.Object from,
                   java.lang.String from_out,
                   java.lang.Object to,
                   java.lang.String to_in)

Connencts two internal components with respect to their fields. from/@Out -> to/@In

Parameters:

from - command object 1

from_out - output field of cmd1

to - command opbject 2

to_in - input field of cmd2

out2in

public void out2in(java.lang.Object from,
                   java.lang.String from_out,
                   java.lang.Object... tos)

Connects field1 of cmd1 with the same named fields in cmds

Parameters:

from - component1

from_out - field

tos - other components

feedback

public void feedback(java.lang.Object from,
                     java.lang.String from_out,
                     java.lang.Object to,
                     java.lang.String to_in)

Feedback connection between two components.

Parameters:

from - the src component

from_out - output field

to - dest component

to_in - in field

feedback

public void feedback(java.lang.Object from,
                     java.lang.String from_out,
                     java.lang.Object... tos)

Feedback connection between two components.

Parameters:

from -

from_out -

tos -

in2in

public void in2in(java.lang.String in,
                  java.lang.Object to,
                  java.lang.String to_in)

Maps a Compound Input field to a internal simple input field.

Parameters:

in - Compound input field.

to - internal Component

to_in - Input field of the internal component

in2in

public void in2in(java.lang.String in,
                  java.lang.Object... to)

Maps a compound input to an internal simple input field. Both fields have the same name.

Parameters:

in - the name of the field

to - the commands to map to

field2inout

public void field2inout(java.lang.Object o,
                        java.lang.String field,
                        java.lang.Object comp,
                        java.lang.String inout)

Maps a field to an In and Out field

Parameters:

o - the object

field - the field name

comp - the component

inout - the field tagged with In and Out

field2inout

public void field2inout(java.lang.Object o,
                        java.lang.String field,
                        java.lang.Object comp)

Maps a field to an In and Out field

Parameters:

o - the object

field - the field name

comp - the component

field2in

public void field2in(java.lang.Object o,
                     java.lang.String field,
                     java.lang.Object to,
                     java.lang.String to_in)

Maps a object's field to an In field

Parameters:

o - the object

field - the field name

to - the component

to_in - the In field.

field2in

public void field2in(java.lang.Object o,
                     java.lang.String field,
                     java.lang.Object to)

Maps an object's field to a component's In field with the same name

Parameters:

o - the object

field - the field name

to - the component.

out2field

public void out2field(java.lang.Object from,
                      java.lang.String from_out,
                      java.lang.Object o,
                      java.lang.String field)

Maps a component's Out field to an object field.

Parameters:

from - the component

from_out - the component's out field

o - the object

field - the object's field

out2field

public void out2field(java.lang.Object from,
                      java.lang.String from_out,
                      java.lang.Object o)

Maps a component Out field to an object's field. Both field have the same name.

Parameters:

from - the component

from_out - the component's Out field.

o - the object

out2out

public void out2out(java.lang.String out,
                    java.lang.Object to,
                    java.lang.String to_out)

Maps a Compound Output field to a internal simple output field.

Parameters:

out - Compount output field.

to - internal Component

to_out - output field of the internal component

out2out

public void out2out(java.lang.String out,
                    java.lang.Object to)

Map output maps a compound output to an internal simple output field. Both fields have the same name.

Parameters:

out - tha name of the field

to - the component source.

val2in

public void val2in(boolean val,
                   java.lang.Object to,
                   java.lang.String field)

val2in

public void val2in(char val,
                   java.lang.Object to,
                   java.lang.String field)

val2in

public void val2in(byte val,
                   java.lang.Object to,
                   java.lang.String field)

val2in

public void val2in(short val,
                   java.lang.Object to,
                   java.lang.String field)

val2in

public void val2in(int val,
                   java.lang.Object to,
                   java.lang.String field)

val2in

public void val2in(long val,
                   java.lang.Object to,
                   java.lang.String field)

val2in

public void val2in(float val,
                   java.lang.Object to,
                   java.lang.String field)

val2in

public void val2in(double val,
                   java.lang.Object to,
                   java.lang.String field)

val2in

public void val2in(java.lang.Object val,
                   java.lang.Object to,
                   java.lang.String field)

connect

@Deprecated
public void connect(java.lang.Object from,
                               java.lang.String from_out,
                               java.lang.Object to,
                               java.lang.String to_in)

Deprecated.

connect

@Deprecated
public void connect(java.lang.Object from,
                               java.lang.String from_out,
                               java.lang.Object... tos)

Deprecated.

mapIn

@Deprecated
public void mapIn(java.lang.String in,
                             java.lang.Object to,
                             java.lang.String to_in)

Deprecated.

mapIn

@Deprecated
public void mapIn(java.lang.String in,
                             java.lang.Object... to)

Deprecated.

mapInField

@Deprecated
public void mapInField(java.lang.Object o,
                                  java.lang.String out,
                                  java.lang.Object from,
                                  java.lang.String from_out)

Deprecated.

mapInField

@Deprecated
public void mapInField(java.lang.Object o,
                                  java.lang.String out,
                                  java.lang.Object from)

Deprecated.

mapOutField

@Deprecated
public void mapOutField(java.lang.Object o,
                                   java.lang.String out,
                                   java.lang.Object from,
                                   java.lang.String from_out)

Deprecated.

mapOutField

@Deprecated
public void mapOutField(java.lang.Object o,
                                   java.lang.String out,
                                   java.lang.Object from)

Deprecated.

mapOut

@Deprecated
public void mapOut(java.lang.String out,
                              java.lang.Object from,
                              java.lang.String from_out)

Deprecated.

mapOut

@Deprecated
public void mapOut(java.lang.String out,
                              java.lang.Object from)

Deprecated.

check

protected void check()

Check for valid internals within the compound

internalExec

protected void internalExec()
                     throws ComponentException

Internal execution.

Throws:

ComponentException

addListener

public void addListener(Notification.Listener l)

Add a ExecutionListener that tracks execution

Parameters:

l - the Listener to add

removeListerer

public void removeListerer(Notification.Listener l)

Remove a ExecutionListener that tracks execution

Parameters:

l - the Listener to remove