DmcDefinitionSet (dark-matter 3.1.15 API)

java.lang.Object
- org.dmd.dmc.definitions.DmcDefinitionSet<DEF>

Type Parameters:

DEF -
```
public class DmcDefinitionSet<DEF extends DSDefinition>
extends Object
```
The DmcDefinitionSet class provides a mechanism to store a set of definitions with the possibility that the DefinitionName of some of the definitions may clash.
The resulting class stores three different types of maps and, depending on the constructor used to create it, populates those maps in slightly different ways. The subtleties of the population has to do with how definitions are named and references to them resolved.
The nameMap for a given

Constructor Summary

Constructors
Constructor and Description
`DmcDefinitionSet()` Constructs a new global definition set.
`DmcDefinitionSet(String sn)` Constructs a new global definition set.
`DmcDefinitionSet(String cn, DmcDefinitionSet<DSDefinition> gs)` Constructs a new definition set.
`DmcDefinitionSet(String cn, DmcDefinitionSet<DSDefinition> gs, DmcDefinitionSet<?> derivedFrom)` Constructs a new definition set.
`DmcDefinitionSet(String sn, String cn)` Constructs a new global definition set.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(DEF def)` Adds the specified definition.
`static void`	`debug(boolean f)`
`void`	`delete(DEF def)` Deletes the specified definition from all maps.
`void`	`delete(DotName dn)` Deletes the specified object from this definition set.
`protected void`	`deleteFromBase(DSDefinition dsd)` When we delete up the chain of derivation, we have a small hack to get around the fact that our derivedFromSet is not typed, so go through this intermediate function to cast the derived definition to the correct type.
`String`	`getAllDotNames()`
`DEF`	`getDefinition(DotName name)`
`DEF`	`getDefinition(String name)` Attempts to return a definition based on its name.
`DEF`	`getDefinitionByNameAndType(DotName dn)` Attempts to return a definition based on the defname.type form of its name.
`int`	`getDefinitionCountByName(String name)` Using just the name of the definition (without the module), let's you know how many definitions of that name exist.
`Iterator<DEF>`	`getDefinitionsByName(String name)` Gets the definitions with the specified name.
`Collection<DmwNamedObjectWrapper>`	`getIndex()` This method is used to support GetRequest retrieval when a definition manager is used as a caching mechanism.
`int`	`getLongestName()`
`int`	`size()`
`String`	`summary()`
`Collection<DEF>`	`values()`

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

- Constructor Detail
  - DmcDefinitionSet
```
public DmcDefinitionSet()
```
    Constructs a new global definition set. This type of set doesn't have a class name and is used to store a global mapping of definitions of all types.
  - DmcDefinitionSet
```
public DmcDefinitionSet(String sn)
```
    Constructs a new global definition set. This type of set doesn't have a class name and is used to store a global mapping of definitions of all types. This form of the constructor also allows you to give the definition a name that can be useful for debugging purposes.
    
    Parameters:
    
    sn - the set name - so that we can see the name of this set when debugging
  - DmcDefinitionSet
```
public DmcDefinitionSet(String sn,
                        String cn)
```
    Constructs a new global definition set. This type of set doesn't have a class name and is used to store a global mapping of definitions of all types. This form of the constructor also allows you to give the definition a name that can be useful for debugging purposes.
    
    Parameters:
    
    sn - the set name - so that we can see the name of this set when debugging
    
    cn - the class name
  - DmcDefinitionSet
```
public DmcDefinitionSet(String cn,
                        DmcDefinitionSet<DSDefinition> gs)
```
    Constructs a new definition set.
    
    Parameters:
    
    cn - the name of the class of definition being stored in this definition set
    
    gs - the global definition set
  - DmcDefinitionSet
```
public DmcDefinitionSet(String cn,
                        DmcDefinitionSet<DSDefinition> gs,
                        DmcDefinitionSet<?> derivedFrom)
```
    Constructs a new definition set.
    
    Parameters:
    
    cn - the name of the class of definition being stored in this definition set
    
    gs - the global definition set
    
    derivedFrom - definition set for class from which we're derived
- Method Detail
  - debug
```
public static void debug(boolean f)
```
  - add
```
public void add(DEF def)
```
    Adds the specified definition. If the dotname of the definition already exists, an IllegalState exception is thrown.
    
    Parameters:
    
    def - the definition to be added.
  - delete
```
public void delete(DotName dn)
            throws ResultException
```
    Deletes the specified object from this definition set.
    
    Parameters:
    
    dn - the fully qualified name of a definition.
    
    Throws:
    
    ResultException - if the object deosn't exist or is of the wrong class.
  - deleteFromBase
```
protected void deleteFromBase(DSDefinition dsd)
                       throws ResultException
```
    When we delete up the chain of derivation, we have a small hack to get around the fact that our derivedFromSet is not typed, so go through this intermediate function to cast the derived definition to the correct type.
    
    Parameters:
    
    dsd - the definition to be deleted
    
    Throws:
    
    ResultException
  - delete
```
public void delete(DEF def)
            throws ResultException
```
    Deletes the specified definition from all maps. If the definition has any references to it (that are not self referential), an exception is thrown.
    
    Parameters:
    
    def - the definition to be deleted.
    
    Throws:
    
    ResultException
  - size
```
public int size()
```
    Returns:
    
    the number of definitions in this set.
  - getLongestName
```
public int getLongestName()
```
    Returns:
    
    the length of the longest DefinitionName
  - getDefinition
```
public DEF getDefinition(DotName name)
```
    Parameters:
    
    name - the name of the object you're looking for
    
    Returns:
    
    the definition or null if it doesn't exist.
  - values
```
public Collection<DEF> values()
```
    Returns:
    
    the set of definition in this set.
  - getIndex
```
public Collection<DmwNamedObjectWrapper> getIndex()
```
    This method is used to support GetRequest retrieval when a definition manager is used as a caching mechanism.
    
    Returns:
    
    An iterator over the set of objects in the index. It will be an empty iterator if there are no objects.
  - getDefinition
```
public DEF getDefinition(String name)
                  throws DmcNameClashException,
                         DmcValueException
```
    Attempts to return a definition based on its name.
    
    Parameters:
    
    name - the name of the definition you're looking for
    
    Returns:
    
    the definition or null if it doesn't exist
    
    Throws:
    
    DmcNameClashException - if there's more than one definition with the specified name, we throw an exception
    
    DmcValueException
  - getDefinitionsByName
```
public Iterator<DEF> getDefinitionsByName(String name)
                                   throws DmcValueException
```
    Gets the definitions with the specified name.
    
    Parameters:
    
    name - the name of the definition.
    
    Returns:
    
    an Iterator over the available definitions with that name or null.
    
    Throws:
    
    DmcValueException
  - getDefinitionCountByName
```
public int getDefinitionCountByName(String name)
                             throws DmcValueException
```
    Using just the name of the definition (without the module), let's you know how many definitions of that name exist.
    
    Parameters:
    
    name - the definition name
    
    Returns:
    
    the number of definitions with that name
    
    Throws:
    
    DmcValueException
  - getDefinitionByNameAndType
```
public DEF getDefinitionByNameAndType(DotName dn)
                               throws DmcNameClashException
```
    Attempts to return a definition based on the defname.type form of its name. This is useful in situations where name resolution is being done via the findNamedObjectMayClash() mechanisms where we have the name of the object and the attribute via which the reference is being made, which gives us the type information.
    
    Parameters:
    
    dn - the defname.type form of a definition name
    
    Returns:
    
    the definition or null if it doesn't exist
    
    Throws:
    
    DmcNameClashException - DmcNameClashException if there's more than one definition with the specified name, we throw an exception
    
    DmcValueException
  - getAllDotNames
```
public String getAllDotNames()
```
    Returns:
    
    all the dot names for which we have a definition in the set
  - summary
```
public String summary()
```

Class DmcDefinitionSet<DEF extends DSDefinition>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DmcDefinitionSet

DmcDefinitionSet

DmcDefinitionSet

DmcDefinitionSet

DmcDefinitionSet

Method Detail

debug

add

delete

deleteFromBase

delete

size

getLongestName

getDefinition

values

getIndex

getDefinition

getDefinitionsByName

getDefinitionCountByName

getDefinitionByNameAndType

getAllDotNames

summary