View Javadoc

1   package org.lcsim.detector.identifier;
2   
3   /**
4    * A mixin interface for objects that have an associated {@link IIdentifier},
5    * {@link IExpandedIdentifier}, and an {@link IIdentifierHelper}
6    * for performing converting between these.
7    *  
8    * @author Jeremy McCormick
9    * @version $Id: Identifiable.java,v 1.1 2008/05/15 22:06:12 jeremy Exp $
10   */
11  public interface Identifiable 
12  {
13      /**
14       * Get the {@link IIdentifier} associated with this object.
15       * @return The Identifier.
16       */
17      public IIdentifier getIdentifier();
18      
19      /**
20       * Get the {@link IExpandedIdentifier} associated with this object.
21       * Should use {@link IIdentifierHelper} to unpack the 
22       * {@link IIdentifier}.
23       * 
24       * @return The ExpandedIdentifier.
25       */
26      public IExpandedIdentifier getExpandedIdentifier();   
27      
28      /**
29       * Get the {@link IIdentifierHelper} associated with this object. 
30       * @return The IdentifierHelper.
31       */
32      public IIdentifierHelper getIdentifierHelper();
33  }