View Javadoc

1   package org.lcsim.detector.identifier;
2   
3   /**
4    * A manager for {@link IIdentifierDictionary} objects.
5    *
6    * @author Jeremy McCormick
7    * @version $Id: IIdentifierDictionaryManager.java,v 1.3 2007/05/11 00:21:09 jeremy Exp $
8    */
9   
10  public interface IIdentifierDictionaryManager
11  {
12      /**
13       * Get an {@link IIdentifierDictionary} by name.
14       * @param name The name of the IdentifierDictionary.
15       * @return The IdentifierDictionary with matching name.
16       */
17      public IIdentifierDictionary getIdentifierDictionary(String name);
18      
19      /**
20       * Add an {@link IIdentifierDictionary}.
21       * @param dict The IdentifierDictionary to be added.
22       */
23      public void addIdentifierDictionary(IIdentifierDictionary dict);
24      
25      /**
26       * Clear the list of {@link IIdentifierDictionary}s.
27       */
28      // FIXME: This should probably not be part of the public interface,
29      //        but it is required to be available for DetectorStore.clear().
30      public void clear();
31  }