net.sourceforge.nrl.parser.operators
Interface IParameter

All Known Implementing Classes:

Parameter

public interface IParameter

A definition parameter for an operator.

Method Summary

String	getImplementationDetail(String label) Get an implementation detail associated with the parameter, given its label.
Collection<IImplementationDetail>	getImplementationDetails() Return all implementation details associated with the parameter.
String	getName() Return the parameter name.
NRLDataType	getNRLDataType() Return the NRL type of the parameter.
IModelElement	getType() Return the parameter type.
String	getTypeName() Return the type name as shown in the definition
boolean	isTypeCollection() Return true if the parameter type is a collection.
List<NRLError>	resolveModelReferences(IModelCollection models) Resolve all parameter type and return type references against models.
void	setNRLDataType(NRLDataType type) Set the NRL type of the parameter.
void	setType(IModelElement type) Set the model type of the parameter.
void	setTypeIsCollection(boolean isCollection) Set a flag indicating whether the type is a collection type.
void	setTypeName(String name) Set the type name

Method Detail

getName

String getName()

Return the parameter name. This never returns null.

Returns:

the name

getType

IModelElement getType()

Return the parameter type. This can be null if the type was not specified. It will also return null before resolveModelReferences(IModelCollection) is called.

Returns:

the type

getNRLDataType

NRLDataType getNRLDataType()

Return the NRL type of the parameter. If it is not defined, this returns NRLDataType.UNKNOWN.

Returns:

the type

getImplementationDetail

String getImplementationDetail(String label)

Get an implementation detail associated with the parameter, given its label. This is used by mappings to targets like Java or rule engines to obtain supplementary mapping information.

See IImplementationDetail for more information.

Parameters:

label - the label

Returns:

the detail value or null if not found

getImplementationDetails

Collection<IImplementationDetail> getImplementationDetails()

Return all implementation details associated with the parameter. This is used for mappings, see IImplementationDetail for more information.

Returns:

a collection of IImplementationDetail objects

getTypeName

String getTypeName()

Return the type name as shown in the definition

Returns:

the name

isTypeCollection

boolean isTypeCollection()

Return true if the parameter type is a collection. Note: Currently always returns false, included for future use.

Returns:

collection indicator

setNRLDataType

void setNRLDataType(NRLDataType type)

Set the NRL type of the parameter. Mainly used by the type checker.

Parameters:

type - the new type

setType

void setType(IModelElement type)

Set the model type of the parameter.

Parameters:

type - the new type

setTypeName

void setTypeName(String name)

Set the type name

Parameters:

name - the name

setTypeIsCollection

void setTypeIsCollection(boolean isCollection)

Set a flag indicating whether the type is a collection type. Note: Currently ignored, included for future use.

Parameters:

isCollection - true if the type is a collection

resolveModelReferences

List<NRLError> resolveModelReferences(IModelCollection models)

Resolve all parameter type and return type references against models.

Parameters:

models - the models

Returns:

any errors encountered