jadex.bdiv3.runtime.impl

Class RParameterElement

java.lang.Object

jadex.bdiv3.runtime.impl.RElement

jadex.bdiv3.runtime.impl.RParameterElement

All Implemented Interfaces:

IElement, IParameterElement, jadex.javaparser.IMapAccess

Direct Known Subclasses:

RPlan, RProcessableElement

public abstract class RParameterElement
extends RElement
implements IParameterElement, jadex.javaparser.IMapAccess

Base element for elements with parameters such as: - message event - internal event - goal - plan

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	RParameterElement.RParameter
class	RParameterElement.RParameterSet

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,IParameter>	parameters The parameters.
protected java.util.Map<java.lang.String,IParameterSet>	parametersets The parameter sets.

Fields inherited from class jadex.bdiv3.runtime.impl.RElement

agent, cnt, id, modelelement

Constructor Summary

Constructors

Constructor and Description
RParameterElement(MParameterElement melement, jadex.bridge.IInternalAccess agent, java.util.Map<java.lang.String,java.lang.Object> vals, MConfigParameterElement config) Create a new parameter element.

Method Summary

Modifier and Type	Method and Description
void	addParameter(IParameter param) Add a parameter.
void	addParameterSet(IParameterSet paramset) Add a parameterset.
IParameter	createParameter(MParameter modelelement, java.lang.String name, jadex.bridge.IInternalAccess agent, java.lang.Object value)
IParameter	createParameter(MParameter modelelement, java.lang.String name, jadex.bridge.IInternalAccess agent, jadex.bridge.modelinfo.UnparsedExpression inival)
IParameterSet	createParameterSet(MParameter modelelement, java.lang.String name, jadex.bridge.IInternalAccess agent, java.util.List<jadex.bridge.modelinfo.UnparsedExpression> inivals)
IParameterSet	createParameterSet(MParameter modelelement, java.lang.String name, jadex.bridge.IInternalAccess agent, java.lang.Object values)
java.lang.Object	get(java.lang.Object key) Get an object from the map.
abstract java.lang.String	getFetcherName() Get the name of the element in the fetcher (e.g.
IParameter	getParameter(java.lang.String name) Get the parameter element.
IParameter[]	getParameters() Get all parameters.
IParameterSet	getParameterSet(java.lang.String name) Get the parameter set element.
IParameterSet[]	getParameterSets() Get all parameter sets.
java.lang.String	getType() Get the element type (i.e.
boolean	hasParameter(java.lang.String name) Has the element a parameter element.
boolean	hasParameterSet(java.lang.String name) Has the element a parameter set element.
void	initParameters(java.util.Map<java.lang.String,java.lang.Object> vals, MConfigParameterElement config) Create the parameters from model spec.
void	testWriteOK(MParameter mparam) Test if parameter writes are currently allowed.
jadex.javaparser.SimpleValueFetcher	wrapFetcher(jadex.commons.IValueFetcher fetcher) Wrap the fetcher to include the element itself.

Methods inherited from class jadex.bdiv3.runtime.impl.RElement

getAgent, getCapability, getId, getMCapability, getModelElement, getRuleSystem, setId, setModelElement, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface jadex.bdiv3x.runtime.IElement

getModelElement

Field Detail

parameters

protected java.util.Map<java.lang.String,IParameter> parameters

The parameters.

parametersets

protected java.util.Map<java.lang.String,IParameterSet> parametersets

The parameter sets.

Constructor Detail

RParameterElement

public RParameterElement(MParameterElement melement,
                         jadex.bridge.IInternalAccess agent,
                         java.util.Map<java.lang.String,java.lang.Object> vals,
                         MConfigParameterElement config)

Create a new parameter element.

Method Detail

initParameters

public void initParameters(java.util.Map<java.lang.String,java.lang.Object> vals,
                           MConfigParameterElement config)

Create the parameters from model spec.

wrapFetcher

public jadex.javaparser.SimpleValueFetcher wrapFetcher(jadex.commons.IValueFetcher fetcher)

Wrap the fetcher to include the element itself.

getFetcherName

public abstract java.lang.String getFetcherName()

Get the name of the element in the fetcher (e.g. $goal).

Returns:

The element name in the fetcher name.

testWriteOK

public void testWriteOK(MParameter mparam)

Test if parameter writes are currently allowed.

Throws:

java.lang.Exception - when write not ok.

createParameter

public IParameter createParameter(MParameter modelelement,
                                  java.lang.String name,
                                  jadex.bridge.IInternalAccess agent,
                                  jadex.bridge.modelinfo.UnparsedExpression inival)

createParameter

public IParameter createParameter(MParameter modelelement,
                                  java.lang.String name,
                                  jadex.bridge.IInternalAccess agent,
                                  java.lang.Object value)

createParameterSet

public IParameterSet createParameterSet(MParameter modelelement,
                                        java.lang.String name,
                                        jadex.bridge.IInternalAccess agent,
                                        java.util.List<jadex.bridge.modelinfo.UnparsedExpression> inivals)

createParameterSet

public IParameterSet createParameterSet(MParameter modelelement,
                                        java.lang.String name,
                                        jadex.bridge.IInternalAccess agent,
                                        java.lang.Object values)

addParameter

public void addParameter(IParameter param)

Add a parameter.

Parameters:

param - The parameter.

addParameterSet

public void addParameterSet(IParameterSet paramset)

Add a parameterset.

Parameters:

paramset - The parameterset.

getParameters

public IParameter[] getParameters()

Get all parameters.

Specified by:

getParameters in interface IParameterElement

Returns:

All parameters.

getParameterSets

public IParameterSet[] getParameterSets()

Get all parameter sets.

Specified by:

getParameterSets in interface IParameterElement

Returns:

All parameter sets.

getParameter

public IParameter getParameter(java.lang.String name)

Get the parameter element.

Specified by:

getParameter in interface IParameterElement

Parameters:

name - The name.

Returns:

The param.

getParameterSet

public IParameterSet getParameterSet(java.lang.String name)

Get the parameter set element.

Specified by:

getParameterSet in interface IParameterElement

Parameters:

name - The name.

Returns:

The param set.

hasParameter

public boolean hasParameter(java.lang.String name)

Has the element a parameter element.

Specified by:

hasParameter in interface IParameterElement

Parameters:

name - The name.

Returns:

True, if it has the parameter.

hasParameterSet

public boolean hasParameterSet(java.lang.String name)

Has the element a parameter set element.

Specified by:

hasParameterSet in interface IParameterElement

Parameters:

name - The name.

Returns:

True, if it has the parameter set.

get

public java.lang.Object get(java.lang.Object key)

Get an object from the map.

Specified by:

get in interface jadex.javaparser.IMapAccess

Parameters:

key - The key

Returns:

The value.

getType

public java.lang.String getType()

Get the element type (i.e. the name declared in the ADF).

Specified by:

getType in interface IParameterElement

Returns:

The element type.