net.sourceforge.nrl.parser.operators
Interface IOperators

All Known Implementing Classes:
Operators

public interface IOperators

A collection of operators, with operations to look them up by name. This needs a concrete implementation, for example to load and write definitions from and to XML.

Author:
Christian Nentwich

Nested Class Summary
static class IOperators.LoadedVersion
          Indicates the version of the operator file format from which operators were loaded.
 
Method Summary
 String getDocumentation()
          Return the operator documentation, may be null.
 IOperators.LoadedVersion getLoadedVersion()
          Gets the operator file format version that these operators were loaded from.
 List<String> getModelFileNames()
          The list of referenced models.
 IOperator getOperator(String name)
          Get an operator by name.
 List<IOperator> getOperators()
          Return all operators in this collection.
 List<NRLError> resolveModelReferences(IModelCollection models)
          Resolve all parameter type and return type references against models.
 

Method Detail

getDocumentation

String getDocumentation()
Return the operator documentation, may be null.

Returns:
the documentation

getModelFileNames

List<String> getModelFileNames()
The list of referenced models.

Returns:
the list

getOperators

List<IOperator> getOperators()
Return all operators in this collection.

Returns:
a list of IOperator.

getOperator

IOperator getOperator(String name)
Get an operator by name. Returns null if not found.

Parameters:
name - the name
Returns:
the operator or null

resolveModelReferences

List<NRLError> resolveModelReferences(IModelCollection models)
Resolve all parameter type and return type references against models.

Parameters:
models - the models
Returns:
any errors encountered

getLoadedVersion

IOperators.LoadedVersion getLoadedVersion()
Gets the operator file format version that these operators were loaded from.



Copyright © 2006-2013. All Rights Reserved.