KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > emf > mapping > MappingHelper


1 /**
2  * <copyright>
3  *
4  * Copyright (c) 2002-2004 IBM Corporation and others.
5  * All rights reserved. This program and the accompanying materials
6  * are made available under the terms of the Eclipse Public License v1.0
7  * which accompanies this distribution, and is available at
8  * http://www.eclipse.org/legal/epl-v10.html
9  *
10  * Contributors:
11  * IBM - Initial API and implementation
12  *
13  * </copyright>
14  *
15  * $Id: MappingHelper.java,v 1.4 2005/06/08 06:21:43 nickb Exp $
16  */
17 package org.eclipse.emf.mapping;
18
19
20 import org.eclipse.emf.common.util.EList;
21 import org.eclipse.emf.ecore.EObject;
22
23
24 /**
25  * <!-- begin-user-doc -->
26  * A representation of the model object '<em><b>Helper</b></em>'.
27  * <!-- end-user-doc -->
28  *
29  * <p>
30  * The following features are supported:
31  * <ul>
32  * <li>{@link org.eclipse.emf.mapping.MappingHelper#getMapper <em>Mapper</em>}</li>
33  * <li>{@link org.eclipse.emf.mapping.MappingHelper#getHelpedObject <em>Helped Object</em>}</li>
34  * <li>{@link org.eclipse.emf.mapping.MappingHelper#getNestedIn <em>Nested In</em>}</li>
35  * <li>{@link org.eclipse.emf.mapping.MappingHelper#getNested <em>Nested</em>}</li>
36  * </ul>
37  * </p>
38  *
39  * @see org.eclipse.emf.mapping.MappingPackage#getMappingHelper()
40  * @model
41  * @generated
42  */
43 public interface MappingHelper extends EObject
44 {
45   /**
46    * Returns the value of the '<em><b>Mapper</b></em>' container reference.
47    * It is bidirectional and its opposite is '{@link org.eclipse.emf.mapping.Mapping#getHelper <em>Helper</em>}'.
48    * <!-- begin-user-doc -->
49    * <p>
50    * If the meaning of the '<em>Mapper</em>' container reference isn't clear,
51    * there really should be more of a description here...
52    * </p>
53    * <!-- end-user-doc -->
54    * @return the value of the '<em>Mapper</em>' container reference.
55    * @see #setMapper(Mapping)
56    * @see org.eclipse.emf.mapping.MappingPackage#getMappingHelper_Mapper()
57    * @see org.eclipse.emf.mapping.Mapping#getHelper
58    * @model opposite="helper"
59    * @generated
60    */
61   Mapping getMapper();
62
63   /**
64    * Sets the value of the '{@link org.eclipse.emf.mapping.MappingHelper#getMapper <em>Mapper</em>}' container reference.
65    * <!-- begin-user-doc -->
66    * <!-- end-user-doc -->
67    * @param value the new value of the '<em>Mapper</em>' container reference.
68    * @see #getMapper()
69    * @generated
70    */
71   void setMapper(Mapping value);
72
73   /**
74    * Returns the value of the '<em><b>Helped Object</b></em>' reference.
75    * <!-- begin-user-doc -->
76    * <p>
77    * If the meaning of the '<em>Helped Object</em>' reference isn't clear,
78    * there really should be more of a description here...
79    * </p>
80    * <!-- end-user-doc -->
81    * @return the value of the '<em>Helped Object</em>' reference.
82    * @see #setHelpedObject(EObject)
83    * @see org.eclipse.emf.mapping.MappingPackage#getMappingHelper_HelpedObject()
84    * @model
85    * @generated
86    */
87   EObject getHelpedObject();
88
89   /**
90    * Sets the value of the '{@link org.eclipse.emf.mapping.MappingHelper#getHelpedObject <em>Helped Object</em>}' reference.
91    * <!-- begin-user-doc -->
92    * <!-- end-user-doc -->
93    * @param value the new value of the '<em>Helped Object</em>' reference.
94    * @see #getHelpedObject()
95    * @generated
96    */
97   void setHelpedObject(EObject value);
98
99   /**
100    * Returns the value of the '<em><b>Nested In</b></em>' container reference.
101    * It is bidirectional and its opposite is '{@link org.eclipse.emf.mapping.MappingHelper#getNested <em>Nested</em>}'.
102    * <!-- begin-user-doc -->
103    * <p>
104    * If the meaning of the '<em>Nested In</em>' container reference isn't clear,
105    * there really should be more of a description here...
106    * </p>
107    * <!-- end-user-doc -->
108    * @return the value of the '<em>Nested In</em>' container reference.
109    * @see #setNestedIn(MappingHelper)
110    * @see org.eclipse.emf.mapping.MappingPackage#getMappingHelper_NestedIn()
111    * @see org.eclipse.emf.mapping.MappingHelper#getNested
112    * @model opposite="nested"
113    * @generated
114    */
115   MappingHelper getNestedIn();
116
117   /**
118    * Sets the value of the '{@link org.eclipse.emf.mapping.MappingHelper#getNestedIn <em>Nested In</em>}' container reference.
119    * <!-- begin-user-doc -->
120    * <!-- end-user-doc -->
121    * @param value the new value of the '<em>Nested In</em>' container reference.
122    * @see #getNestedIn()
123    * @generated
124    */
125   void setNestedIn(MappingHelper value);
126
127   /**
128    * Returns the value of the '<em><b>Nested</b></em>' containment reference list.
129    * The list contents are of type {@link org.eclipse.emf.mapping.MappingHelper}.
130    * It is bidirectional and its opposite is '{@link org.eclipse.emf.mapping.MappingHelper#getNestedIn <em>Nested In</em>}'.
131    * <!-- begin-user-doc -->
132    * <p>
133    * If the meaning of the '<em>Nested</em>' containment reference list isn't clear,
134    * there really should be more of a description here...
135    * </p>
136    * <!-- end-user-doc -->
137    * @return the value of the '<em>Nested</em>' containment reference list.
138    * @see org.eclipse.emf.mapping.MappingPackage#getMappingHelper_Nested()
139    * @see org.eclipse.emf.mapping.MappingHelper#getNestedIn
140    * @model type="org.eclipse.emf.mapping.MappingHelper" opposite="nestedIn" containment="true"
141    * @generated
142    */
143   EList getNested();
144
145 } // MappingHelper
146
Popular Tags