RandomLeftRightComponent Class Reference

Inheritance diagram for RandomLeftRightComponent:

Collaboration diagram for RandomLeftRightComponent:

List of all members.

Public Methods
Result	run () throws Exception
void	report (String message)
void	report (String category, String message, ExecutionReport.TYPE type)
void	report (String category, long n, ExecutionReport.TYPE type)
void	report (String category, double n, ExecutionReport.TYPE type)
File	getResource (String relativePath, boolean expandIfRequired) throws ServerEnvironmentNotConfiguredException
final synchronized void	initialize (ComponentEntity component, Experiment experiment)
File	getResourceDirectory () throws ServerEnvironmentNotConfiguredException
void	updateProgress (double progress, String message)
void	updateProgress (double progress)
void	setProgressName (String progressName)
void	setProgress (int progress)
String	getExperimentName ()
String	getComponentName ()
TabularReport	newReport (String title, String caption, int rows, int columns)
void	setExperimentId (int experimentId)
void	initMessaging (Level logLevel)
final void	setId (int id) throws IllegalStateException
final int	getId ()
void	releaseThreads ()
final void	onMessage (Message msg)
void	tryToCancel ()
CustomThreads	getCustomThreadExecutor () throws IllegalThreadModeException
void	setCustomThreadExecutor (CustomThreads executor)
Logger	newLogger (Class forClass)
Protected Methods
boolean	cancelled ()
void	cancel ()
Protected Attributes
Logger	logger = Logger.getLogger(this.getClass())
Properties	properties = new Properties()
int	experimentId
Package Functions
public< T > List< T >	asList (InputIterator< T > iterator)
public< T > Set< T >	asSet (InputIterator< T > iterator)

---

Method Details

public<T> List<T> asList

(

InputIterator< T >

iterator

)

[package, inherited]

public<T> Set<T> asSet

(

InputIterator< T >

iterator

)

[package, inherited]

void cancel

(

)

[protected, inherited]

Reimplemented in AbstractJythonComponent< T extends ITeslaJythonDelegate >.

boolean cancelled

(

)

[protected, inherited]

String getComponentName

(

)

[inherited]

CustomThreads getCustomThreadExecutor

(

)

throws IllegalThreadModeException [inherited]

Returns the CustomThreads of this component, such that Callable or Runnable objects can be executed in parallel. Will throw an IllegalThreadModeException if the ThreadMode of the component has not been defined as ThreadMode#CUSTOM.

Returns:

String getExperimentName

(

)

[inherited]

final int getId

(

)

[inherited]

File getResource	(	String	relativePath,
		boolean	expandIfRequired
	)		throws ServerEnvironmentNotConfiguredException [inherited]

This method returns a file object that represents a file in directory "resources" of a component.. If the resource doesn't exist and expandIfRequired is true, the file $component$/resources/$name$.zip will be unzipped to the directory $component$/resources/$name$.

Parameters:

name

Exceptions:

ServerEnvironmentNotConfiguredException

File getResourceDirectory

(

)

throws ServerEnvironmentNotConfiguredException [inherited]

final synchronized void initialize	(	ComponentEntity	component,
		Experiment	experiment
	)		[inherited]

void initMessaging

(

Level

logLevel

)

[inherited]

Tesla-internal method that must never be called by any client code. A JMS-Listener is set up that enables Tesla to send messages to this component. Currently, Messages are only used for sending a cancel command.

Exceptions:

NamingException
JMSException

Logger newLogger

(

Class

forClass

)

[inherited]

TabularReport newReport	(	String	title,
		String	caption,
		int	rows,
		int	columns
	)		[inherited]

final void onMessage

(

Message

msg

)

[inherited]

void releaseThreads

(

)

[inherited]

void report	(	String	category,
		double	n,
		ExecutionReport.TYPE	type
	)		[inherited]

void report	(	String	category,
		long	n,
		ExecutionReport.TYPE	type
	)		[inherited]

void report	(	String	category,
		String	message,
		ExecutionReport.TYPE	type
	)		[inherited]

void report

(

String

message

)

[inherited]

Result run

(

)

throws Exception

void setCustomThreadExecutor

(

CustomThreads

executor

)

[inherited]

void setExperimentId

(

int

experimentId

)

[inherited]

Parameters:

experimentId

final void setId

(

int

id

)

throws IllegalStateException [inherited]

This method is called internally by Tesla during the creation of an object of this class. Calling it a second time will result in an IllegalStateException.

Parameters:

stateAccessor

Exceptions:

IllegalStateException

when a uuid has already been set.

void setProgress

(

int

progress

)

[inherited]

void setProgressName

(

String

progressName

)

[inherited]

void tryToCancel

(

)

[inherited]

void updateProgress	(	double	progress,
		String	message
	)		[inherited]

Implements ProgressSource.

void updateProgress

(

double

progress

)

[inherited]

Implements ProgressSource.

---

Field Details

int experimentId [protected, inherited]

Logger logger = Logger.getLogger(this.getClass()) [protected, inherited]

A logger that shoud be used in subclasses.

Properties properties = new Properties() [protected, inherited]