ComponentElement


1   /**
2    * Copyright (C) 2002 Kelua SA
3    * 
4    * This library is free software; you can redistribute it and/or
5    * modify it under the terms of the GNU Lesser General Public
6    * License as published by the Free Software Foundation; either
7    * version 2 of the License, or (at your option) any later version.
8    * 
9    * This library is distributed in the hope that it will be useful,
10   * but WITHOUT ANY WARRANTY; without even the implied warranty of
11   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12   * Lesser General Public License for more details.
13   * 
14   * You should have received a copy of the GNU Lesser General Public
15   * License along with this library; if not, write to the Free Software
16   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17   */
18  
19  package org.objectweb.kilim.model;
20  
21  import java.util.Iterator  ;
22  
23  import org.objectweb.kilim.description.TemplateElementImpl;
24  
25  /**
26   * @author horn
27   */
28      
29  public interface ComponentElement {
30      /**
31       * returns a reference to the component or the slot containing the element.
32       * It returns null when applied to the top level component.
33       * @return ContainerElement
34       */
35      ContainerElement getContainingElement();
36      
37      /**
38       * returns a reference to the component containing the element.
39       * It returns null when applied to the top level component. It is equivalent to getContainingElement()
40       * for elements directly defined at a component level.
41       * It is equivalent to getContainingElement().getContainingElement() for elements defined at a slot level.
42       * @return Component
43       */
44      Component getContainingComponent();
45          
46      /**
47       * returns the "template description" of the component element.
48       * @return TemplateElement
49       */
50      TemplateElementImpl getElementDescription();
51      
52      /**
53       * returns all templates in which the element has been defined (and eventually redefined).
54       * This method is mainly targeted to debugging.
55       * @return Iterator
56       */
57      Iterator   getTemplateDefHierarchy();
58      
59      /**
60       * returns the fully qualified name of the component element.
61       * @return String : 
62       */
63      String   getQualifiedName();
64      
65      /**
66       * returns the local name of the component element.
67       * @return String
68       */
69      String   getLocalName();
70  }
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags