SymbolTable

java.lang.Object
- edu.ksu.cis.santos.mdcf.dml.symbol.SymbolTable

```
public final class SymbolTable
extends Object
```
Provides API to retrieve DML entities such as basic types, features, attributes, and invariants in the models or by their fully-qualified name.

Author:

Robby

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SymbolTable.Kind
Represents Declaration kind.

Nested Classes
Modifier and Type	Class and Description
`static class`	`SymbolTable.Kind` Represents `Declaration` kind.

Field Summary

Fields
Modifier and Type Field and Description

List<Model> models
The list of models used to construct this symbol table.

Fields
Modifier and Type	Field and Description
`List<Model>`	`models` The list of models used to construct this symbol table.

Method Summary

Methods
Modifier and Type	Method and Description
`Map<String,Pair<Feature,Attribute>>`	`allAttributeMap(Iterable<String> featureNames)` Retrieves an immutable `Map` of `Member.name` to `Attribute` with its declaring `Feature` that contains all declared and closest (least) inherited attributes of the provided features.
`Map<String,Pair<Feature,Attribute>>`	`allAttributeMap(List<NamedType> namedTypes)` Retrieves an immutable `Map` of `Member.name` to `Attribute` with its declaring `Feature` that contains all declared and closest (least) inherited attributes of the provided named types.
`Map<String,Pair<Feature,Attribute>>`	`allAttributeMap(String featureName)` Retrieves an immutable `Map` of `Member.name` to `Attribute` with its declaring `Feature` that contains all declared and closest (least) inherited attributes of the provided feature.
`Set<Pair<Feature,Attribute>>`	`allAttributes(Iterable<String> featureNames, String attributeName, boolean isOverriden)` Retrieves an immutable `Set` of `Attribute` with its declaring `Feature` that contains all overriden/overriding attributes of the provided features and attribute name.
`Set<Pair<Feature,Attribute>>`	`allAttributes(List<NamedType> namedTypes, String attributeName, boolean isOverriden)` Retrieves an immutable `Set` of `Attribute` with its declaring `Feature` that contains all overriden/overriding attributes of the provided named types and attribute name.
`Set<Pair<Feature,Attribute>>`	`allAttributes(String featureName, String attributeName, boolean isOverriden)` Retrieves an immutable `Set` of `Attribute` with its declaring `Feature` that contains all overriden/overriding attributes of the provided named types and attribute name.
`Map<String,Pair<Feature,Invariant>>`	`allInvariantMap(Iterable<String> featureNames)` Retrieves an immutable `Map` of `Member.name` to `Invariant` with its declaring `Feature` that contains all declared and inherited invariants of the provided features.
`Map<String,Pair<Feature,Invariant>>`	`allInvariantMap(List<NamedType> namedTypes)` Retrieves an immutable `Map` of `Member.name` to `Invariant` with its declaring `Feature` that contains all declared and inherited invariants of the provided named types.
`Map<String,Pair<Feature,Invariant>>`	`allInvariantMap(String featureName)` Retrieves an immutable `Map` of `Member.name` to `Invariant` with its declaring `Feature` that contains all declared and inherited invariants of the provided feature.
`Map<String,Pair<Feature,Member>>`	`allMemberMap(Iterable<String> featureNames)` Retrieves an immutable `Map` of `Member.name` to `Member` with its declaring `Feature` that contains all declared and closest (least) inherited members of the provided features.
`Map<String,Pair<Feature,Member>>`	`allMemberMap(List<NamedType> namedTypes)` Retrieves an immutable `Map` of `Member.name` to `Member` with its declaring `Feature` that contains all declared and inherited closest (least) members of the provided named types.
`Map<String,Pair<Feature,Member>>`	`allMemberMap(String featureName)` Retrieves an immutable `Map` of `Member.name` to `Invariant` with its declaring `Feature` that contains all declared and closest (least) inherited members of the provided feature.
`BasicType`	`basicType(String name)` Retrieves a `BasicType` from its fully-qualified name ( `Declaration.name`).
`Optional<BasicType>`	`basicTypeOpt(String name)` Retrieves a `BasicType` from its fully-qualified name ( `Declaration.name`), if any.
`List<BasicType>`	`basicTypes()` Retrieves all `BasicType`s declared in the `models`.
`Map<String,Declaration>`	`declarationMap()` Retrieves an immutable `Map` of `Declaration.name` to `Declaration` that contains all declarations in the `models`.
`Set<String>`	`declarationNames()` Retrieves an immutable `Set` of `Declaration.name` declared in the `models`.
`Map<String,Attribute>`	`declaredAttributeMap(String featureName)` Retrieves an immutable `Map` of `Member.name` to `Attribute` that contains all declared attributes of the provided feature.
`Collection<Attribute>`	`declaredAttributes(String featureName)` Retrieves an immutable `Collection` of all declared `Attribute` s of the provided feature.
`Map<String,Invariant>`	`declaredInvariantMap(String featureName)` Retrieves an immutable `Map` of `Member.name` to `Invariant` that contains all declared invariants of the provided feature.
`Collection<Invariant>`	`declaredInvariants(String featureName)` Retrieves an immutable `Collection` of all declared `Invariant` s of the provided feature.
`Map<String,Member>`	`declaredMemberMap(String featureName)` Retrieves an immutable `Map` of `Member.name` to `Member` that contains all declared members of the provided feature.
`Collection<Member>`	`declaredMembers(String featureName)` Retrieves an immutable `Collection` of all declared `Member`s of the provided feature.
`Feature`	`feature(String name)` Retrieves a `Feature` from its fully-qualified name ( `Declaration.name`).
`List<FeatureInit>`	`featureInits()` Retrieves all `FeatureInit`s declared in the `models`.
`Map<String,Map<String,Pair<Feature,Member>>>`	`featureMemberMap()` Retrieves an immutable `Map` of `Declaration.name` to `Map` of `Member.name` to `Member` with its declaring `Feature` that contains all features' and their declared and closest (least) inherited members.
`Optional<Feature>`	`featureOpt(String name)` Retrieves a `Feature` from its fully-qualified name ( `Declaration.name`), if any.
`List<Feature>`	`features()` Retrieves all `Feature`s declared in the `models`.
`<V,T> Map<String,T>`	`filter(Map<String,V> m, Class<T> clazz)` Retrieves an immutable map `Map` whose entries come from the provided map where the entries' value is an instance of the provided `Class`.
`<V,T> Map<String,Pair<Feature,T>>`	`filterp(Map<String,Pair<Feature,V>> m, Class<T> clazz)` Retrieves an immutable map `Map` whose entries come from the provided map where the entries' value's second element is an instance of the provided `Class`.
`boolean`	`isBasicType(String name)` Determines whether a `Declaration` fully-qualified name ( `Declaration.name`) is of a `BasicType`.
`boolean`	`isFeature(String name)` Determines whether a `Declaration` fully-qualified name ( `Declaration.name`) is of a `Feature`.
`boolean`	`isRequirement(String name)` Determines whether a `Declaration` fully-qualified name ( `Declaration.name`) is of a `Requirement`.
`boolean`	`isSubTypeOf(String typeName, String name)` Determines whether a fully-qualified name of a `BasicType` or a `Feature` is a sub type of another `BasicType` or a `Feature`.
`boolean`	`isSuperTypeOf(String typeName, String name)` Determines whether a fully-qualified name of a `BasicType` or a `Feature` is a super type of another `BasicType` or a `Feature`.
`SymbolTable.Kind`	`kind(String declarationName)` Retrieves the kind of a `Declaration`.
`Optional<SymbolTable.Kind>`	`kindOpt(String declarationName)` Retrieves the kind of a `Declaration`, if any.
`static SymbolTable`	`of(Model... models)` Creates a symbol table of the provided models.
`List<RefinedType>`	`refinedTypes()` Retrieves all `RefinedType`s declared in the `models`.
`Requirement`	`requirement(String name)` Retrieves a `Requirement` from its fully-qualified name ( `Declaration.name`).
`Optional<Requirement>`	`requirementOpt(String name)` Retrieves a `Requirement` from its fully-qualified name ( `Declaration.name`), if any.
`List<Requirement>`	`requirements()` Retrieves all `Requirement`s declared in the `models`.
`Multimap<String,String>`	`subTransitiveMap()` Retrieves a `Multimap` that relates a super type's fully-qualified name (either of `Declaration.name` or `Declaration.name`) to its sub type's fully-qualified name (either of `Declaration.name` or `Declaration.name`).
`Multimap<String,String>`	`superTransitiveMap()` Retrieves a `Multimap` that relates a sub type's fully-qualified name (either of `Declaration.name` or `Declaration.name`) to its super type's fully-qualified name (either of `Declaration.name` or `Declaration.name`).
`String`	`toString()` Returns the `String` representation of this symbol table.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - models
```
public final List<Model> models
```
    The list of models used to construct this symbol table.
- Method Detail
  - of
```
public static SymbolTable of(Model... models)
```
    Creates a symbol table of the provided models.
    
    Parameters:
    models - The models whose symbol table to be created.
    
    Returns:
    A symbol table.
  - allAttributeMap
```
public Map<String,Pair<Feature,Attribute>> allAttributeMap(Iterable<String> featureNames)
```
    Retrieves an immutable Map of Member.name to Attribute with its declaring Feature that contains all declared and closest (least) inherited attributes of the provided features.
    
    Parameters:
    featureNames - The fully-qualified name (Declaration.name) of the Features whose attributes to be retrieved.
    
    Returns:
    an immutable Map.
  - allAttributeMap
```
public Map<String,Pair<Feature,Attribute>> allAttributeMap(List<NamedType> namedTypes)
```
    Retrieves an immutable Map of Member.name to Attribute with its declaring Feature that contains all declared and closest (least) inherited attributes of the provided named types.
    
    Parameters:
    namedTypes - The NamedTypes referring to Features whose attributes to be retrieved.
    
    Returns:
    an immutable Map.
  - allAttributeMap
```
public Map<String,Pair<Feature,Attribute>> allAttributeMap(String featureName)
```
    Retrieves an immutable Map of Member.name to Attribute with its declaring Feature that contains all declared and closest (least) inherited attributes of the provided feature.
    
    Parameters:
    featureName - The fully-qualified name (Declaration.name) of the Feature whose attributes to be retrieved.
    
    Returns:
    an immutable Map.
  - allAttributes
```
public Set<Pair<Feature,Attribute>> allAttributes(Iterable<String> featureNames,
                                         String attributeName,
                                         boolean isOverriden)
```
    Retrieves an immutable Set of Attribute with its declaring Feature that contains all overriden/overriding attributes of the provided features and attribute name.
    
    Parameters:
    featureNames - The fully-qualified name (Declaration.name) of the Features whose attributes to be retrieved.
    attributeName - The Member.name.
    isOverriden - Indicates whether to retrieve overriden/overriding attributes.
    
    Returns:
    an immutable Set.
  - allAttributes
```
public Set<Pair<Feature,Attribute>> allAttributes(List<NamedType> namedTypes,
                                         String attributeName,
                                         boolean isOverriden)
```
    Retrieves an immutable Set of Attribute with its declaring Feature that contains all overriden/overriding attributes of the provided named types and attribute name.
    
    Parameters:
    namedTypes - The NamedTypes referring to Features whose attributes to be retrieved.
    attributeName - The Member.name.
    isOverriden - Indicates whether to retrieve overriden/overriding attributes.
    
    Returns:
    an immutable Set.
  - allAttributes
```
public Set<Pair<Feature,Attribute>> allAttributes(String featureName,
                                         String attributeName,
                                         boolean isOverriden)
```
    Retrieves an immutable Set of Attribute with its declaring Feature that contains all overriden/overriding attributes of the provided named types and attribute name.
    
    Parameters:
    featureName - The fully-qualified name (Declaration.name) of the Feature whose attributes to be retrieved.
    attributeName - The Member.name.
    isOverriden - Indicates whether to retrieve overriden/overriding attributes.
    
    Returns:
    an immutable Set.
  - allInvariantMap
```
public Map<String,Pair<Feature,Invariant>> allInvariantMap(Iterable<String> featureNames)
```
    Retrieves an immutable Map of Member.name to Invariant with its declaring Feature that contains all declared and inherited invariants of the provided features.
    
    Parameters:
    featureNames - The fully-qualified name (Declaration.name) of the Features whose invariants to be retrieved.
    
    Returns:
    an immutable Map.
  - allInvariantMap
```
public Map<String,Pair<Feature,Invariant>> allInvariantMap(List<NamedType> namedTypes)
```
    Retrieves an immutable Map of Member.name to Invariant with its declaring Feature that contains all declared and inherited invariants of the provided named types.
    
    Parameters:
    namedTypes - The NamedTypes referring to Features whose invariants to be retrieved.
    
    Returns:
    an immutable Map.
  - allInvariantMap
```
public Map<String,Pair<Feature,Invariant>> allInvariantMap(String featureName)
```
    Retrieves an immutable Map of Member.name to Invariant with its declaring Feature that contains all declared and inherited invariants of the provided feature.
    
    Parameters:
    featureName - The fully-qualified name (Declaration.name) of the Feature whose invariants to be retrieved.
    
    Returns:
    an immutable Map.
  - allMemberMap
```
public Map<String,Pair<Feature,Member>> allMemberMap(Iterable<String> featureNames)
```
    Retrieves an immutable Map of Member.name to Member with its declaring Feature that contains all declared and closest (least) inherited members of the provided features.
    
    Parameters:
    featureNames - The fully-qualified name (Declaration.name) of the Features whose members to be retrieved.
    
    Returns:
    an immutable Map.
  - allMemberMap
```
public Map<String,Pair<Feature,Member>> allMemberMap(List<NamedType> namedTypes)
```
    Retrieves an immutable Map of Member.name to Member with its declaring Feature that contains all declared and inherited closest (least) members of the provided named types.
    
    Parameters:
    namedTypes - The NamedTypes referring to Features whose members to be retrieved.
    
    Returns:
    an immutable Map.
  - allMemberMap
```
public Map<String,Pair<Feature,Member>> allMemberMap(String featureName)
```
    Retrieves an immutable Map of Member.name to Invariant with its declaring Feature that contains all declared and closest (least) inherited members of the provided feature.
    
    Parameters:
    featureName - The fully-qualified name (Declaration.name) of the Feature whose members to be retrieved.
    
    Returns:
    an immutable Map.
  - basicType
```
public BasicType basicType(String name)
```
    Retrieves a BasicType from its fully-qualified name ( Declaration.name).
    
    Parameters:
    name - The fully-qualified name of the BasicType.
    
    Returns:
    The BasicType.
    
    Throws:
    
    {@link - IllegalArgumentException} if the provided name is not a BasicType in the models.
  - basicTypeOpt
```
public Optional<BasicType> basicTypeOpt(String name)
```
    Retrieves a BasicType from its fully-qualified name ( Declaration.name), if any.
    
    Parameters:
    name - The fully-qualified name to query.
    
    Returns:
    The BasicType, if found in models.
  - basicTypes
```
public List<BasicType> basicTypes()
```
    Retrieves all BasicTypes declared in the models.
    
    Returns:
    an immutable List.
  - declarationMap
```
public Map<String,Declaration> declarationMap()
```
    Retrieves an immutable Map of Declaration.name to Declaration that contains all declarations in the models.
    
    Returns:
    an immutable Map.
  - declarationNames
```
public Set<String> declarationNames()
```
    Retrieves an immutable Set of Declaration.name declared in the models.
    
    Returns:
    an immutable Set.
  - declaredAttributeMap
```
public Map<String,Attribute> declaredAttributeMap(String featureName)
```
    Retrieves an immutable Map of Member.name to Attribute that contains all declared attributes of the provided feature.
    
    Parameters:
    featureName - The fully-qualified name (Declaration.name) of the Feature whose attributes to be retrieved.
    
    Returns:
    an immutable Map.
  - declaredAttributes
```
public Collection<Attribute> declaredAttributes(String featureName)
```
    Retrieves an immutable Collection of all declared Attribute s of the provided feature.
    
    Parameters:
    featureName - The fully-qualified name (Declaration.name) of the Feature whose attributes to be retrieved.
    
    Returns:
    an immutable Collection.
  - declaredInvariantMap
```
public Map<String,Invariant> declaredInvariantMap(String featureName)
```
    Retrieves an immutable Map of Member.name to Invariant that contains all declared invariants of the provided feature.
    
    Parameters:
    featureName - The fully-qualified name (Declaration.name) of the Feature whose invariants to be retrieved.
    
    Returns:
    an immutable Map.
  - declaredInvariants
```
public Collection<Invariant> declaredInvariants(String featureName)
```
    Retrieves an immutable Collection of all declared Invariant s of the provided feature.
    
    Parameters:
    featureName - The fully-qualified name (Declaration.name) of the Feature whose attributes to be retrieved.
    
    Returns:
    an immutable Collection.
  - declaredMemberMap
```
public Map<String,Member> declaredMemberMap(String featureName)
```
    Retrieves an immutable Map of Member.name to Member that contains all declared members of the provided feature.
    
    Parameters:
    featureName - The fully-qualified name (Declaration.name) of the Feature whose members to be retrieved.
    
    Returns:
    an immutable Map.
  - declaredMembers
```
public Collection<Member> declaredMembers(String featureName)
```
    Retrieves an immutable Collection of all declared Members of the provided feature.
    
    Parameters:
    featureName - The fully-qualified name (Declaration.name) of the Feature whose members to be retrieved.
    
    Returns:
    an immutable Collection.
  - feature
```
public Feature feature(String name)
```
    Retrieves a Feature from its fully-qualified name ( Declaration.name).
    
    Parameters:
    name - The fully-qualified name (Declaration.name) of the Feature.
    
    Returns:
    The Feature.
    
    Throws:
    
    {@link - IllegalArgumentException} if the provided name is not a Feature in the models.
  - featureInits
```
public List<FeatureInit> featureInits()
```
    Retrieves all FeatureInits declared in the models.
    
    Returns:
    an immutable List.
  - featureMemberMap
```
public Map<String,Map<String,Pair<Feature,Member>>> featureMemberMap()
```
    Retrieves an immutable Map of Declaration.name to Map of Member.name to Member with its declaring Feature that contains all features' and their declared and closest (least) inherited members.
    
    Returns:
    an immutable Map.
  - featureOpt
```
public Optional<Feature> featureOpt(String name)
```
    Retrieves a Feature from its fully-qualified name ( Declaration.name), if any.
    
    Parameters:
    name - The fully-qualified name to query.
    
    Returns:
    The Feature, if found in models.
  - features
```
public List<Feature> features()
```
    Retrieves all Features declared in the models.
    
    Returns:
    an immutable List.
  - filter
```
public <V,T> Map<String,T> filter(Map<String,V> m,
                         Class<T> clazz)
```
    Retrieves an immutable map Map whose entries come from the provided map where the entries' value is an instance of the provided Class.
    
    Parameters:
    m - The map whose entries will be used to construct a filtered map according to the provided class.
    clazz - The class for filtering the provided map.
    
    Returns:
    an immutable Map.
  - filterp
```
public <V,T> Map<String,Pair<Feature,T>> filterp(Map<String,Pair<Feature,V>> m,
                                        Class<T> clazz)
```
    Retrieves an immutable map Map whose entries come from the provided map where the entries' value's second element is an instance of the provided Class.
    
    Parameters:
    m - The map whose entries will be used to construct a filtered map according to the provided class.
    clazz - The class for filtering the provided map.
    
    Returns:
    an immutable Map.
  - isBasicType
```
public boolean isBasicType(String name)
```
    Determines whether a Declaration fully-qualified name ( Declaration.name) is of a BasicType.
    
    Parameters:
    name - The fully-qualified name to query.
    
    Returns:
    true if the fully-qualified name is of a BasicType.
  - isFeature
```
public boolean isFeature(String name)
```
    Determines whether a Declaration fully-qualified name ( Declaration.name) is of a Feature.
    
    Parameters:
    name - The fully-qualified name to query.
    
    Returns:
    true if the fully-qualified name is of a Feature.
  - isRequirement
```
public boolean isRequirement(String name)
```
    Determines whether a Declaration fully-qualified name ( Declaration.name) is of a Requirement.
    
    Parameters:
    name - The fully-qualified name to query.
    
    Returns:
    true if the fully-qualified name is of a Requirement.
  - isSubTypeOf
```
public boolean isSubTypeOf(String typeName,
                  String name)
```
    Determines whether a fully-qualified name of a BasicType or a Feature is a sub type of another BasicType or a Feature.
    
    Parameters:
    typeName - The fully-qualified name to query.
    name - The fully-qualified name of a super type to query.
    
    Returns:
    true if typeName is a super type of name.
  - isSuperTypeOf
```
public boolean isSuperTypeOf(String typeName,
                    String name)
```
    Determines whether a fully-qualified name of a BasicType or a Feature is a super type of another BasicType or a Feature.
    
    Parameters:
    typeName - The fully-qualified name to query.
    name - The fully-qualified name of a sub type to query.
    
    Returns:
    true if typeName is a super type of name.
  - kind
```
public SymbolTable.Kind kind(String declarationName)
```
    Retrieves the kind of a Declaration.
    
    Parameters:
    declarationName - The fully-qualified name (Declaration.name) of the Declaration to query.
    
    Returns:
    the SymbolTable.Kind of the declaration.
    
    Throws:
    
    {@link - IllegalArgumentException} if the provided declaration name is not a Declaration in the models.
  - kindOpt
```
public Optional<SymbolTable.Kind> kindOpt(String declarationName)
```
    Retrieves the kind of a Declaration, if any.
    
    Parameters:
    declarationName - The fully-qualified name (Declaration.name) of the Declaration to query.
    
    Returns:
    the SymbolTable.Kind of the declaration, if found in models.
  - refinedTypes
```
public List<RefinedType> refinedTypes()
```
    Retrieves all RefinedTypes declared in the models.
    
    Returns:
    an immutable List.
  - requirement
```
public Requirement requirement(String name)
```
    Retrieves a Requirement from its fully-qualified name ( Declaration.name).
    
    Parameters:
    name - The fully-qualified name of the Requirement.
    
    Returns:
    The Requirement.
    
    Throws:
    
    {@link - IllegalArgumentException} if the provided name is not a Requirement in the models.
  - requirementOpt
```
public Optional<Requirement> requirementOpt(String name)
```
    Retrieves a Requirement from its fully-qualified name ( Declaration.name), if any.
    
    Parameters:
    name - The fully-qualified name to query.
    
    Returns:
    The Requirement, if found in models.
  - requirements
```
public List<Requirement> requirements()
```
    Retrieves all Requirements declared in the models.
    
    Returns:
    an immutable List.
  - subTransitiveMap
```
public Multimap<String,String> subTransitiveMap()
```
    Retrieves a Multimap that relates a super type's fully-qualified name (either of Declaration.name or Declaration.name) to its sub type's fully-qualified name (either of Declaration.name or Declaration.name).
    
    Returns:
    an immutable Multimap.
  - superTransitiveMap
```
public Multimap<String,String> superTransitiveMap()
```
    Retrieves a Multimap that relates a sub type's fully-qualified name (either of Declaration.name or Declaration.name) to its super type's fully-qualified name (either of Declaration.name or Declaration.name).
    
    Returns:
    an immutable Multimap.
  - toString
```
public String toString()
```
    Returns the String representation of this symbol table.
    
    Overrides:
    
    toString in class Object

Class SymbolTable

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

models

Method Detail

of

allAttributeMap

allAttributeMap

allAttributeMap

allAttributes

allAttributes

allAttributes

allInvariantMap

allInvariantMap

allInvariantMap

allMemberMap

allMemberMap

allMemberMap

basicType

basicTypeOpt

basicTypes

declarationMap

declarationNames

declaredAttributeMap

declaredAttributes

declaredInvariantMap

declaredInvariants

declaredMemberMap

declaredMembers

feature

featureInits

featureMemberMap

featureOpt

features

filter

filterp

isBasicType

isFeature

isRequirement

isSubTypeOf

isSuperTypeOf

kind

kindOpt

refinedTypes

requirement

requirementOpt

requirements

subTransitiveMap

superTransitiveMap

toString