de.xabsl.jxabsl.engine
Class Symbols

java.lang.Object
  extended by de.xabsl.jxabsl.engine.Symbols
Direct Known Subclasses:
Engine

public class Symbols
extends java.lang.Object

Handles the symbols of the engine.


Field Summary
protected  DebugMessages debug
           
 
Constructor Summary
Symbols(DebugMessages debug)
           
 
Method Summary
 BooleanInputSymbol getBooleanInputSymbol(java.lang.String name, java.util.Set<java.lang.String> decimalParameterNames, java.util.Set<java.lang.String> booleanParameterNames, java.util.Set<java.lang.String> enumeratedParameterNames)
          Returns a previously registered boolean input symbol
 java.util.Map<java.lang.String,BooleanInputSymbol> getBooleanInputSymbols()
          Returns a map of all registered boolean input symbols.
 BooleanOutputSymbol getBooleanOutputSymbol(java.lang.String name)
          Returns a previously registered boolean output symbol
 java.util.Map<java.lang.String,BooleanOutputSymbol> getBooleanOutputSymbols()
          Returns a map of all registered boolean output symbols.
 DecimalInputSymbol getDecimalInputSymbol(java.lang.String name, java.util.Set<java.lang.String> decimalParameterNames, java.util.Set<java.lang.String> booleanParameterNames, java.util.Set<java.lang.String> enumeratedParameterNames)
          Returns a previously registered decimal input symbol
 java.util.Map<java.lang.String,DecimalInputSymbol> getDecimalInputSymbols()
          Returns a map of all registered decimal input symbols.
 DecimalOutputSymbol getDecimalOutputSymbol(java.lang.String name)
          Returns a previously registered decimal output symbol
 java.util.Map<java.lang.String,DecimalOutputSymbol> getDecimalOutputSymbols()
          Returns a map of all registered decimal output symbols.
 EnumeratedInputSymbol getEnumeratedInputSymbol(java.lang.String name, java.util.Set<java.lang.String> decimalParameterNames, java.util.Set<java.lang.String> booleanParameterNames, java.util.Set<java.lang.String> enumeratedParameterNames)
          Returns a previously registered enumerated input symbol
 java.util.Map<java.lang.String,EnumeratedInputSymbol> getEnumeratedInputSymbols()
          Returns a map of all registered enumerated input symbols.
 EnumeratedOutputSymbol getEnumeratedOutputSymbol(java.lang.String name)
          Returns a previously registered enumerated output symbol
 java.util.Map<java.lang.String,EnumeratedOutputSymbol> getEnumeratedOutputSymbols()
          Returns a map of all registered enumerated output symbols.
 Enumeration getEnumeration(java.lang.String name)
          Returns a previously registered enumeration
 java.util.Map<java.lang.String,Enumeration> getEnumerations()
          Returns a map of all registered enumerations.
 void registerBooleanInputSymbol(java.lang.String name, BooleanInputSymbol inputSymbol)
          Register a boolean input symbol.
 void registerBooleanOutputSymbol(java.lang.String name, BooleanOutputSymbol outputSymbol)
          Register a boolean output symbol.
 void registerDecimalInputSymbol(java.lang.String name, DecimalInputSymbol inputSymbol)
          Register a decimal input symbol.
 void registerDecimalOutputSymbol(java.lang.String name, DecimalOutputSymbol outputSymbol)
          Register a decimal output symbol.
 void registerEnumeratedInputSymbol(java.lang.String name, EnumeratedInputSymbol inputSymbol)
          Register an enumerated input symbol.
 void registerEnumeratedOutputSymbol(java.lang.String name, EnumeratedOutputSymbol outputSymbol)
          Register an enumerated output symbol.
 void registerEnumeration(Enumeration enumeration)
          Register an enumeration
protected  void registerInternalEnumElement(java.lang.String enumName, java.lang.String name)
          Registers an enum element for an internal enumeration.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

debug

protected DebugMessages debug
Constructor Detail

Symbols

public Symbols(DebugMessages debug)
Parameters:
debug - A debug output stream
Method Detail

registerEnumeration

public void registerEnumeration(Enumeration enumeration)
Register an enumeration

Parameters:
enumeration -

registerEnumeratedInputSymbol

public void registerEnumeratedInputSymbol(java.lang.String name,
                                          EnumeratedInputSymbol inputSymbol)
Register an enumerated input symbol.

Parameters:
name - The name of the symbol
inputSymbol - The input symbol

registerDecimalInputSymbol

public void registerDecimalInputSymbol(java.lang.String name,
                                       DecimalInputSymbol inputSymbol)
Register a decimal input symbol.

Parameters:
name - The name of the symbol
inputSymbol - The input symbol

registerBooleanInputSymbol

public void registerBooleanInputSymbol(java.lang.String name,
                                       BooleanInputSymbol inputSymbol)
Register a boolean input symbol.

Parameters:
name - The name of the symbol
inputSymbol - The input symbol

registerEnumeratedOutputSymbol

public void registerEnumeratedOutputSymbol(java.lang.String name,
                                           EnumeratedOutputSymbol outputSymbol)
Register an enumerated output symbol.

Parameters:
name - The name of the symbol
inputSymbol - The input symbol

registerDecimalOutputSymbol

public void registerDecimalOutputSymbol(java.lang.String name,
                                        DecimalOutputSymbol outputSymbol)
Register a decimal output symbol.

Parameters:
name - The name of the symbol
inputSymbol - The input symbol

registerBooleanOutputSymbol

public void registerBooleanOutputSymbol(java.lang.String name,
                                        BooleanOutputSymbol outputSymbol)
Register a boolean output symbol.

Parameters:
name - The name of the symbol
inputSymbol - The input symbol

getDecimalInputSymbol

public DecimalInputSymbol getDecimalInputSymbol(java.lang.String name,
                                                java.util.Set<java.lang.String> decimalParameterNames,
                                                java.util.Set<java.lang.String> booleanParameterNames,
                                                java.util.Set<java.lang.String> enumeratedParameterNames)
Returns a previously registered decimal input symbol

Parameters:
name - the name of the symbol
decimalParameterNames - names of the decimal parameters
booleanParameterNames - names of the boolean parameters
enumeratedParameterNames - names of the enumerated parameters
Returns:
the input symbol
Throws:
SymbolNotRegisteredException - if the symbol was not registered

getBooleanInputSymbol

public BooleanInputSymbol getBooleanInputSymbol(java.lang.String name,
                                                java.util.Set<java.lang.String> decimalParameterNames,
                                                java.util.Set<java.lang.String> booleanParameterNames,
                                                java.util.Set<java.lang.String> enumeratedParameterNames)
Returns a previously registered boolean input symbol

Parameters:
name - the name of the symbol
decimalParameterNames - names of the decimal parameters
booleanParameterNames - names of the boolean parameters
enumeratedParameterNames - names of the enumerated parameters
Returns:
the input symbol
Throws:
SymbolNotRegisteredException - if the symbol was not registered

getEnumeratedInputSymbol

public EnumeratedInputSymbol getEnumeratedInputSymbol(java.lang.String name,
                                                      java.util.Set<java.lang.String> decimalParameterNames,
                                                      java.util.Set<java.lang.String> booleanParameterNames,
                                                      java.util.Set<java.lang.String> enumeratedParameterNames)
Returns a previously registered enumerated input symbol

Parameters:
name - the name of the symbol
decimalParameterNames - names of the decimal parameters
booleanParameterNames - names of the boolean parameters
enumeratedParameterNames - names of the enumerated parameters
Returns:
the input symbol
Throws:
SymbolNotRegisteredException - if the symbol was not registered

getDecimalOutputSymbol

public DecimalOutputSymbol getDecimalOutputSymbol(java.lang.String name)
Returns a previously registered decimal output symbol

Parameters:
name - the name of the symbol
Returns:
the output symbol
Throws:
SymbolNotRegisteredException - if the symbol was not registered

getBooleanOutputSymbol

public BooleanOutputSymbol getBooleanOutputSymbol(java.lang.String name)
Returns a previously registered boolean output symbol

Parameters:
name - the name of the symbol
Returns:
the output symbol
Throws:
SymbolNotRegisteredException - if the symbol was not registered

getEnumeratedOutputSymbol

public EnumeratedOutputSymbol getEnumeratedOutputSymbol(java.lang.String name)
Returns a previously registered enumerated output symbol

Parameters:
name - the name of the symbol
Returns:
the output symbol
Throws:
SymbolNotRegisteredException - if the symbol was not registered

getEnumeration

public Enumeration getEnumeration(java.lang.String name)
Returns a previously registered enumeration

Parameters:
name - the name of the enumeration
Returns:
the enumeration

registerInternalEnumElement

protected void registerInternalEnumElement(java.lang.String enumName,
                                           java.lang.String name)
Registers an enum element for an internal enumeration. If the enumeration does not exist yet, it is created.


getEnumerations

public java.util.Map<java.lang.String,Enumeration> getEnumerations()
Returns a map of all registered enumerations. Intended for debugging purposes, use registerEnumeration() and getEnumeration() for all other purposes.


getDecimalInputSymbols

public java.util.Map<java.lang.String,DecimalInputSymbol> getDecimalInputSymbols()
Returns a map of all registered decimal input symbols. Intended for debugging purposes, use registerDecimalInputSymbol() and getDecimalInputSymbol() for all other purposes.


getBooleanInputSymbols

public java.util.Map<java.lang.String,BooleanInputSymbol> getBooleanInputSymbols()
Returns a map of all registered boolean input symbols. Intended for debugging purposes, use registerBooleanInputSymbol() and getBooleanInputSymbol() for all other purposes.


getEnumeratedInputSymbols

public java.util.Map<java.lang.String,EnumeratedInputSymbol> getEnumeratedInputSymbols()
Returns a map of all registered enumerated input symbols. Intended for debugging purposes, use registerEnumeratedInputSymbol() and getEnumeratedInputSymbol() for all other purposes.


getDecimalOutputSymbols

public java.util.Map<java.lang.String,DecimalOutputSymbol> getDecimalOutputSymbols()
Returns a map of all registered decimal output symbols. Intended for debugging purposes, use registerDecimalOutputSymbol() and getDecimalOutputSymbol() for all other purposes.


getBooleanOutputSymbols

public java.util.Map<java.lang.String,BooleanOutputSymbol> getBooleanOutputSymbols()
Returns a map of all registered boolean output symbols. Intended for debugging purposes, use registerBooleanOutputSymbol() and getBooleanOutputSymbol() for all other purposes.


getEnumeratedOutputSymbols

public java.util.Map<java.lang.String,EnumeratedOutputSymbol> getEnumeratedOutputSymbols()
Returns a map of all registered enumerated output symbols. Intended for debugging purposes, use registerEnumeratedOutputSymbol() and getEnumeratedOutputSymbol() for all other purposes.