de.uka.ipd.sdq.beagle.core

Class Blackboard

java.lang.Object

de.uka.ipd.sdq.beagle.core.Blackboard

All Implemented Interfaces:

Serializable

public class Blackboard
extends Object
implements Serializable

Central and only storage of all knowledge gained by Beagle. Implements, together with AnalysisController, the Blackboard pattern from POSA I. The Blackboard’s vocabularies are: ResourceDemandingInternalAction, SeffBranch, SeffLoop, ResourceDemandMeasurementResult, BranchDecisionMeasurementResult , LoopRepetitionCountMeasurementResult and EvaluableExpression. It further allows classes to store custom data.

The Blackboard is typically not accessed directly by its using classes, but through blackboard views (recognisable by having the BlackboardView suffix). These are surrogates for the blackboard. They don’t modify its contents but only restrict access to it.

See Also:

AnalysisController, Serialized Form

Constructor Summary

Constructors

Constructor and Description
Blackboard(Set<ResourceDemandingInternalAction> rdias, Set<SeffBranch> branches, Set<SeffLoop> loops, Set<ExternalCallParameter> externalCalls, EvaluableExpressionFitnessFunction fitnessFunction, ProjectInformation projectInformation) Creates a new blackboard that can be used to analyse the given elements.

Method Summary

Modifier and Type	Method and Description
void	addMeasurementResultFor(ExternalCallParameter parameter, ParameterChangeMeasurementResult results) Adds a measurement result for the provided loop.
void	addMeasurementResultFor(ResourceDemandingInternalAction rdia, ResourceDemandMeasurementResult results) Adds a measurement result for the provided rdia.
void	addMeasurementResultFor(SeffBranch branch, BranchDecisionMeasurementResult results) Adds a measurement result for the provided branch.
void	addMeasurementResultFor(SeffLoop loop, LoopRepetitionCountMeasurementResult results) Adds a measurement result for the provided loop.
void	addProposedExpressionFor(MeasurableSeffElement element, EvaluableExpression expression) Adds expression as a proposal.
void	addToBeMeasuredExternalCallParameters(Collection<ExternalCallParameter> parameters) Reports that parameters shall be measured.
void	addToBeMeasuredExternalCallParameters(ExternalCallParameter... parameters) Reports that parameters shall be measured.
void	addToBeMeasuredRdias(Collection<ResourceDemandingInternalAction> toMeasureRdias) Reports that rdias shall be measured for its resource demands.
void	addToBeMeasuredRdias(ResourceDemandingInternalAction... toMeasureRdias) Reports that rdias shall be measured for its resource demands.
void	addToBeMeasuredSeffBranches(Collection<SeffBranch> toMeasureBranches) Reports that branches shall be measured for its branch decisions.
void	addToBeMeasuredSeffBranches(SeffBranch... toMeasureBranches) Reports that branches shall be measured for its branch decisions.
void	addToBeMeasuredSeffLoops(Collection<SeffLoop> toMeasureLoops) Reports that loops shall be measured for its repetitions.
void	addToBeMeasuredSeffLoops(SeffLoop... toMeasureLoops) Reports that loops shall be measured for its repetitions.
void	clearToBeMeasuredBranches() Clears the list of branchesToBeMeasured.
void	clearToBeMeasuredExternalCalls() Clears the list of externalCallParameterToBeMeasured.
void	clearToBeMeasuredLoops() Clears the list of loopsToBeMeasured.
void	clearToBeMeasuredRdias() Clears the list of rdiasToBeMeasured.
Set<ExternalCallParameter>	getAllExternalCallParameters() Returns all external call parameters known to Beagle.
Set<ResourceDemandingInternalAction>	getAllRdias() All resource demanding internal actions known to Beagle.
Set<SeffBranch>	getAllSeffBranches() All SEFF branches known to Beagle.
Set<SeffLoop>	getAllSeffLoops() All SEFF loops known to Beagle.
Set<ExternalCallParameter>	getExternalCallParametersToBeMeasured() Returns all external call parameters which shall be measured.
EvaluableExpression	getFinalExpressionFor(MeasurableSeffElement element) Returns the final expression set for element.
EvaluableExpressionFitnessFunction	getFitnessFunction() Returns an object which holds and is responsible allows access to the fitness function grading evaluable expressions regarding their fitness.
Set<ParameterChangeMeasurementResult>	getMeasurementResultsFor(ExternalCallParameter externalCallParameter) Gets all results yet measured for the external parameter externalCallParameter.
Set<ResourceDemandMeasurementResult>	getMeasurementResultsFor(ResourceDemandingInternalAction rdia) Gets all results yet measured for the resource demands of rdia.
Set<BranchDecisionMeasurementResult>	getMeasurementResultsFor(SeffBranch branch) Gets all results yet measured for branch decisions of branch.
Set<LoopRepetitionCountMeasurementResult>	getMeasurementResultsFor(SeffLoop loop) Gets all results yet measured for the loop repetitions of loop.
ProjectInformation	getProjectInformation() Information about the project belonging to this blackboard.
Set<EvaluableExpression>	getProposedExpressionFor(MeasurableSeffElement element) Returns a set of all evaluable expressions proposed for element.
Set<ResourceDemandingInternalAction>	getRdiasToBeMeasured() RDIAs that shall be measured for their resource demands.
Set<SeffBranch>	getSeffBranchesToBeMeasured() SEFF branches that shall be measured for their branch decisions.
Set<SeffLoop>	getSeffLoopsToBeMeasured() SEFF loops that shall be measured for their repetitions.
<WRITTEN_TYPE extends Serializable> WRITTEN_TYPE	readFor(Class<? extends BlackboardStorer<WRITTEN_TYPE>> writer) Reads data previously written for writer through writeFor(Class, Serializable).
void	setFinalExpressionFor(MeasurableSeffElement element, EvaluableExpression expression) Sets expression as the final description of element’s measurement results.
<WRITTEN_TYPE extends Serializable> void	writeFor(Class<? extends BlackboardStorer<WRITTEN_TYPE>> writer, WRITTEN_TYPE written) Writes data for writer to the blackboard.

Methods inherited from class java.lang.Object

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

Constructor Detail

Blackboard

public Blackboard(Set<ResourceDemandingInternalAction> rdias,
                  Set<SeffBranch> branches,
                  Set<SeffLoop> loops,
                  Set<ExternalCallParameter> externalCalls,
                  EvaluableExpressionFitnessFunction fitnessFunction,
                  ProjectInformation projectInformation)

Creates a new blackboard that can be used to analyse the given elements.

Parameters:

rdias - All resource demanding internal action to be known to analysers.

branches - All SEFF branches to be known to analysers.

loops - All SEFF loops to be known to analysers.

externalCalls - All external call parameter to be known to analysers.

fitnessFunction - The function to get better evaluable expression results.

projectInformation - Information about the project belonging to this blackboard.

Method Detail

getAllRdias

public Set<ResourceDemandingInternalAction> getAllRdias()

All resource demanding internal actions known to Beagle.

Returns:

all resource demanding internal actions known to Beagle. Changes to the returned set will not modify the blackboard content. Is never null.

getAllSeffBranches

public Set<SeffBranch> getAllSeffBranches()

All SEFF branches known to Beagle.

Returns:

all SEFF branches known to Beagle. Changes to the returned set will not modify the blackboard content. Is never null.

getAllSeffLoops

public Set<SeffLoop> getAllSeffLoops()

All SEFF loops known to Beagle.

Returns:

all SEFF loops known to Beagle. Changes to the returned set will not modify the blackboard content. Is never null.

getAllExternalCallParameters

public Set<ExternalCallParameter> getAllExternalCallParameters()

Returns all external call parameters known to Beagle.

Returns:

All external call parameters known to Beagle. Is never null.

getRdiasToBeMeasured

public Set<ResourceDemandingInternalAction> getRdiasToBeMeasured()

RDIAs that shall be measured for their resource demands.

Returns:

All resource demanding internal actions to be measured. Changes to the returned set will not modify the blackboard content. Is never null.

getSeffBranchesToBeMeasured

public Set<SeffBranch> getSeffBranchesToBeMeasured()

SEFF branches that shall be measured for their branch decisions.

Returns:

All SEFF branches to be measured. Changes to the returned set will not modify the blackboard content. Is never null.

getSeffLoopsToBeMeasured

public Set<SeffLoop> getSeffLoopsToBeMeasured()

SEFF loops that shall be measured for their repetitions.

Returns:

All SEFF loops to be measured. Changes to the returned set will not modify the blackboard content. Is never null.

getExternalCallParametersToBeMeasured

public Set<ExternalCallParameter> getExternalCallParametersToBeMeasured()

Returns all external call parameters which shall be measured.

Returns:

All external call parameters which shall be measured. Is never null.

addToBeMeasuredRdias

public void addToBeMeasuredRdias(ResourceDemandingInternalAction... toMeasureRdias)

Reports that rdias shall be measured for its resource demands.

Parameters:

toMeasureRdias - Resource demanding internal actions that shall be measured. Must not be null and must be known to this blackboard.

See Also:

addToBeMeasuredRdias(Collection)

addToBeMeasuredRdias

public void addToBeMeasuredRdias(Collection<ResourceDemandingInternalAction> toMeasureRdias)

Reports that rdias shall be measured for its resource demands.

Parameters:

toMeasureRdias - Resource demanding internal actions that shall be measured. Must not be null and must be known to this blackboard.

See Also:

addToBeMeasuredRdias(ResourceDemandingInternalAction...)

addToBeMeasuredSeffBranches

public void addToBeMeasuredSeffBranches(SeffBranch... toMeasureBranches)

Reports that branches shall be measured for its branch decisions.

Parameters:

toMeasureBranches - SEFF branches that shall be measured. Must not be null and must be known to this blackboard.

See Also:

addToBeMeasuredSeffBranches(Collection)

addToBeMeasuredSeffBranches

public void addToBeMeasuredSeffBranches(Collection<SeffBranch> toMeasureBranches)

Reports that branches shall be measured for its branch decisions.

Parameters:

toMeasureBranches - SEFF branches that shall be measured. Must not be null and must be known to this blackboard.

See Also:

addToBeMeasuredSeffBranches(SeffBranch...)

addToBeMeasuredSeffLoops

public void addToBeMeasuredSeffLoops(SeffLoop... toMeasureLoops)

Reports that loops shall be measured for its repetitions.

Parameters:

toMeasureLoops - SEFF Loops that shall be measured. Must not be null and must be known to this blackboard.

See Also:

addToBeMeasuredSeffLoops(Collection)

addToBeMeasuredSeffLoops

public void addToBeMeasuredSeffLoops(Collection<SeffLoop> toMeasureLoops)

Reports that loops shall be measured for its repetitions.

Parameters:

toMeasureLoops - SEFF Loops that shall be measured. Must not be null and must be known to this blackboard.

See Also:

addToBeMeasuredSeffLoops(SeffLoop...)

addToBeMeasuredExternalCallParameters

public void addToBeMeasuredExternalCallParameters(ExternalCallParameter... parameters)

Reports that parameters shall be measured.

Parameters:

parameters - external call parameters that shall be measured. Must not be null and must be known to this blackboard.

See Also:

addToBeMeasuredExternalCallParameters(Collection)

addToBeMeasuredExternalCallParameters

public void addToBeMeasuredExternalCallParameters(Collection<ExternalCallParameter> parameters)

Reports that parameters shall be measured.

Parameters:

parameters - external call parameters that shall be measured. Must not be null and must be known to this blackboard.

See Also:

addToBeMeasuredExternalCallParameters(ExternalCallParameter...)

clearToBeMeasuredRdias

public void clearToBeMeasuredRdias()

Clears the list of rdiasToBeMeasured.

clearToBeMeasuredBranches

public void clearToBeMeasuredBranches()

Clears the list of branchesToBeMeasured.

clearToBeMeasuredLoops

public void clearToBeMeasuredLoops()

Clears the list of loopsToBeMeasured.

clearToBeMeasuredExternalCalls

public void clearToBeMeasuredExternalCalls()

Clears the list of externalCallParameterToBeMeasured.

getMeasurementResultsFor

public Set<ResourceDemandMeasurementResult> getMeasurementResultsFor(ResourceDemandingInternalAction rdia)

Gets all results yet measured for the resource demands of rdia.

Parameters:

rdia - An resource demanding internal action to get the measurement results of. Must not be null.

Returns:

All measurement results reported for rdia. Changes to the returned set will not modify the blackboard content. Is never null.

getMeasurementResultsFor

public Set<BranchDecisionMeasurementResult> getMeasurementResultsFor(SeffBranch branch)

Gets all results yet measured for branch decisions of branch.

Parameters:

branch - A SEFF Branch to get the measurement results of. Must not be null.

Returns:

All measurement results reported for branch. Changes to the returned set will not modify the blackboard content. Is never null.

getMeasurementResultsFor

public Set<LoopRepetitionCountMeasurementResult> getMeasurementResultsFor(SeffLoop loop)

Gets all results yet measured for the loop repetitions of loop.

Parameters:

loop - A SEFF Loop to get the measurement results of. Must not be null .

Returns:

All measurement results reported for loop. Changes to the returned set will not modify the blackboard content. Is never null.

getMeasurementResultsFor

public Set<ParameterChangeMeasurementResult> getMeasurementResultsFor(ExternalCallParameter externalCallParameter)

Gets all results yet measured for the external parameter externalCallParameter.

Parameters:

externalCallParameter - An external parameter to get the measurement results of. Must not be null.

Returns:

All measurement results reported for externalCallParameter. Changes to the returned set will not modify the blackboard content. Is never null.

addMeasurementResultFor

public void addMeasurementResultFor(ResourceDemandingInternalAction rdia,
                                    ResourceDemandMeasurementResult results)

Adds a measurement result for the provided rdia.

Parameters:

rdia - A resource demanding internal action that was measured. Must not be null .

results - The result of that measurement. Must not be null.

addMeasurementResultFor

public void addMeasurementResultFor(SeffBranch branch,
                                    BranchDecisionMeasurementResult results)

Adds a measurement result for the provided branch.

Parameters:

branch - A SEFF Branch which was measured. Must not be null.

results - The result of that measurement. Must not be null.

addMeasurementResultFor

public void addMeasurementResultFor(SeffLoop loop,
                                    LoopRepetitionCountMeasurementResult results)

Adds a measurement result for the provided loop.

Parameters:

loop - A SEFF Loop which was measured. Must not be null.

results - The result of that measurement. Must not be null.

addMeasurementResultFor

public void addMeasurementResultFor(ExternalCallParameter parameter,
                                    ParameterChangeMeasurementResult results)

Adds a measurement result for the provided loop.

Parameters:

parameter - An external call parameter which was measured. Must not be null.

results - The result of that measurement. Must not be null.

getProposedExpressionFor

public Set<EvaluableExpression> getProposedExpressionFor(MeasurableSeffElement element)

Returns a set of all evaluable expressions proposed for element.

Parameters:

element - A SEFF element. Must not be null.

Returns:

A set of all evaluable expressions proposed for element.

addProposedExpressionFor

public void addProposedExpressionFor(MeasurableSeffElement element,
                                     EvaluableExpression expression)

Adds expression as a proposal.

Parameters:

element - A SEFF element. Must not be null.

expression - An evaluable expression proposed to describe element’s measurement results. Must not be null.

getFinalExpressionFor

public EvaluableExpression getFinalExpressionFor(MeasurableSeffElement element)

Returns the final expression set for element. The return value of this method may change if setFinalExpressionFor(MeasurableSeffElement, EvaluableExpression) is called with the same element between calls to addProposedExpressionFor with this element as parameter.

Parameters:

element - A SEFF element. Must not be null.

Returns:

The expression momentarily marked to be the final for element. null if no expression has been marked yet.

setFinalExpressionFor

public void setFinalExpressionFor(MeasurableSeffElement element,
                                  EvaluableExpression expression)

Sets expression as the final description of element’s measurement results. Consecutive calls to this method with the same element will override previous settings.

Parameters:

element - A SEFF element Must not be null.

expression - An evaluable expression describing element’s measurement results. May be null to describe that no suitable expression was found.

getFitnessFunction

public EvaluableExpressionFitnessFunction getFitnessFunction()

Returns an object which holds and is responsible allows access to the fitness function grading evaluable expressions regarding their fitness.

Returns:

An object which holds and is responsible allows access to the fitness function grading evaluable expressions regarding their fitness.

writeFor

public <WRITTEN_TYPE extends Serializable> void writeFor(Class<? extends BlackboardStorer<WRITTEN_TYPE>> writer,
                                                         WRITTEN_TYPE written)

Writes data for writer to the blackboard. This method serves as a type safe mean for tools to store data that is not part of their results. Values stored here will never contribute to Beagle’s results. Any class calling this method should always pass its own Class instance as writer. writer has to implement BlackboardStorer and thereby declare the type of values they write. Calling this method will override any data potentially stored previously for the given writer.

Type Parameters:

WRITTEN_TYPE - written’s type.

Parameters:

writer - The class the data should be written for. Must not be null.

written - The data to write.

See Also:

readFor(Class)

readFor

public <WRITTEN_TYPE extends Serializable> WRITTEN_TYPE readFor(Class<? extends BlackboardStorer<WRITTEN_TYPE>> writer)

Reads data previously written for writer through writeFor(Class, Serializable).

Type Parameters:

WRITTEN_TYPE - The type of the data to be read.

Parameters:

writer - The class the desired data was written for. Must not be null.

Returns:

The data written in the last call to writeFor(java.lang.Class<? extends de.uka.ipd.sdq.beagle.core.BlackboardStorer<WRITTEN_TYPE>>, WRITTEN_TYPE) for writer. null if no data has been written for writer yet.

See Also:

writeFor(Class, Serializable)

getProjectInformation

public ProjectInformation getProjectInformation()

Information about the project belonging to this blackboard.

Returns:

Information about the project belonging to this blackboard.