KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > ccm > runtime > cif > api > ComponentSegment


1 /*====================================================================
2
3 OpenCCM: The Open CORBA Component Model Platform
4 Copyright (C) 2000-2002 USTL - LIFL - GOAL
5 Contact: openccm-team@objectweb.org
6
7 This library is free software; you can redistribute it and/or
8 modify it under the terms of the GNU Lesser General Public
9 License as published by the Free Software Foundation; either
10 version 2.1 of the License, or any later version.
11
12 This library is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 Lesser General Public License for more details.
16
17 You should have received a copy of the GNU Lesser General Public
18 License along with this library; if not, write to the Free Software
19 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
20 USA
21
22 Initial developer(s): Philippe Merle, Christophe Demarey.
23 Contributor(s): _______________________________.
24
25 ====================================================================*/
26
27 package org.objectweb.ccm.runtime.cif.api;
28
29 import org.omg.Components.ExecutorSegmentBase;
30
31 /**
32  * Base interface for all component segment classes generated from CIDL.
33  *
34  * @author <a HREF="mailto:Philippe.Merle@lifl.fr">Philippe Merle</a>
35  * <a HREF="mailto:Christophe.Demarey@lifl.fr">Christophe Demarey</A>
36  *
37  * @version 0.1
38  */
39
40 public interface ComponentSegment
41          extends ExecutorSegmentBase,
42                  org.omg.Components.ExecutorLocator
43 {
44     /**
45      * Sets the number of executor segments.
46      *
47      * This method is called by the constructor of
48      * component segment classes generated from CIDL.
49      *
50      * @param nb_segments The number of executor segments
51      * for this CIDL component executor.
52      */
53     public void
54     set_nb_segments(int nb_segments);
55
56     /**
57      * Sets the associated segment home.
58      *
59      * @param sh The associated segment home.
60      */
61     public void
62     set_segment_home(SegmentHome sh);
63
64     /**
65      * Gets an executor segment.
66      *
67      * If the requested executor segment does not exist
68      * then it is created by the segment home.
69      *
70      * @param segid The executor segment id.
71      *
72      * @return The executor segment.
73      */
74     public ExecutorSegmentBase
75     get_executor_segment(int segid);
76
77     /**
78      * Obtains the segmentation table.
79      *
80      * This method is implemented by component segment classes generated
81      * from CIDL according to segmentation described in CIDL compositions.
82      *
83      * @return A HashMap containing <facet_name, segid> associations.
84      */
85     public java.util.HashMap JavaDoc
86     get_segmentation_table();
87 };
88
Popular Tags