KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > eclipse > emf > ecore > sdo > EDataGraph


1 /**
2  * <copyright>
3  *
4  * Copyright (c) 2003-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: EDataGraph.java,v 1.3 2005/06/08 06:24:25 nickb Exp $
16  */

17 package org.eclipse.emf.ecore.sdo;
18
19 import org.eclipse.emf.ecore.EClass;
20 import org.eclipse.emf.ecore.EClassifier;
21 import org.eclipse.emf.ecore.EObject;
22 import org.eclipse.emf.ecore.resource.Resource;
23 import org.eclipse.emf.ecore.resource.ResourceSet;
24
25 import commonj.sdo.DataGraph;
26
27 /**
28  * <!-- begin-user-doc -->
29  * A representation of the model object '<em><b>EData Graph</b></em>'.
30  * <!-- end-user-doc -->
31  *
32  * <p>
33  * The following features are supported:
34  * <ul>
35  * <li>{@link org.eclipse.emf.ecore.sdo.EDataGraph#getResourceSet <em>Resource Set</em>}</li>
36  * <li>{@link org.eclipse.emf.ecore.sdo.EDataGraph#getRootResource <em>Root Resource</em>}</li>
37  * <li>{@link org.eclipse.emf.ecore.sdo.EDataGraph#getEChangeSummary <em>EChange Summary</em>}</li>
38  * <li>{@link org.eclipse.emf.ecore.sdo.EDataGraph#getERootObject <em>ERoot Object</em>}</li>
39  * </ul>
40  * </p>
41  *
42  * @see org.eclipse.emf.ecore.sdo.SDOPackage#getEDataGraph()
43  * @model
44  * @generated
45  */

46 public interface EDataGraph extends EObject, DataGraph
47 {
48   /**
49    * Returns the value of the '<em><b>Resource Set</b></em>' attribute.
50    * <!-- begin-user-doc -->
51    * <p>
52    * If the meaning of the '<em>Resource Set</em>' attribute isn't clear,
53    * there really should be more of a description here...
54    * </p>
55    * <!-- end-user-doc -->
56    * @return the value of the '<em>Resource Set</em>' attribute.
57    * @see #setResourceSet(ResourceSet)
58    * @see org.eclipse.emf.ecore.sdo.SDOPackage#getEDataGraph_ResourceSet()
59    * @model transient="true"
60    * @generated
61    */

62   ResourceSet getResourceSet();
63
64   /**
65    * Sets the value of the '{@link org.eclipse.emf.ecore.sdo.EDataGraph#getResourceSet <em>Resource Set</em>}' attribute.
66    * <!-- begin-user-doc -->
67    * <!-- end-user-doc -->
68    * @param value the new value of the '<em>Resource Set</em>' attribute.
69    * @see #getResourceSet()
70    * @generated
71    */

72   void setResourceSet(ResourceSet value);
73
74   /**
75    * Returns the value of the '<em><b>Root Resource</b></em>' attribute.
76    * <!-- begin-user-doc -->
77    * <p>
78    * If the meaning of the '<em>Root Resource</em>' attribute isn't clear,
79    * there really should be more of a description here...
80    * </p>
81    * <!-- end-user-doc -->
82    * @return the value of the '<em>Root Resource</em>' attribute.
83    * @see org.eclipse.emf.ecore.sdo.SDOPackage#getEDataGraph_RootResource()
84    * @model transient="true" changeable="false" volatile="true"
85    * @generated
86    */

87   Resource getRootResource();
88
89   /**
90    * Returns the resource of this data graph; one is created if necessary.
91    * @return the resource of this data graph.
92    */

93   Resource getDataGraphResource();
94
95   /**
96    * Returns the value of the '<em><b>EChange Summary</b></em>' reference.
97    * It is bidirectional and its opposite is '{@link org.eclipse.emf.ecore.sdo.EChangeSummary#getEDataGraph <em>EData Graph</em>}'.
98    * <!-- begin-user-doc -->
99    * <p>
100    * If the meaning of the '<em>EChange Summary</em>' reference isn't clear,
101    * there really should be more of a description here...
102    * </p>
103    * <!-- end-user-doc -->
104    * @return the value of the '<em>EChange Summary</em>' reference.
105    * @see #setEChangeSummary(EChangeSummary)
106    * @see org.eclipse.emf.ecore.sdo.SDOPackage#getEDataGraph_EChangeSummary()
107    * @see org.eclipse.emf.ecore.sdo.EChangeSummary#getEDataGraph
108    * @model opposite="eDataGraph" resolveProxies="false" required="true"
109    * @generated
110    */

111   EChangeSummary getEChangeSummary();
112
113   /**
114    * Sets the value of the '{@link org.eclipse.emf.ecore.sdo.EDataGraph#getEChangeSummary <em>EChange Summary</em>}' reference.
115    * <!-- begin-user-doc -->
116    * <!-- end-user-doc -->
117    * @param value the new value of the '<em>EChange Summary</em>' reference.
118    * @see #getEChangeSummary()
119    * @generated
120    */

121   void setEChangeSummary(EChangeSummary value);
122
123   /**
124    * Returns the value of the '<em><b>ERoot Object</b></em>' reference.
125    * <!-- begin-user-doc -->
126    * <p>
127    * If the meaning of the '<em>ERoot Object</em>' reference isn't clear,
128    * there really should be more of a description here...
129    * </p>
130    * <!-- end-user-doc -->
131    * @return the value of the '<em>ERoot Object</em>' reference.
132    * @see #setERootObject(EObject)
133    * @see org.eclipse.emf.ecore.sdo.SDOPackage#getEDataGraph_ERootObject()
134    * @model resolveProxies="false" required="true"
135    * @generated
136    */

137   EObject getERootObject();
138
139   /**
140    * Sets the value of the '{@link org.eclipse.emf.ecore.sdo.EDataGraph#getERootObject <em>ERoot Object</em>}' reference.
141    * <!-- begin-user-doc -->
142    * <!-- end-user-doc -->
143    * @param value the new value of the '<em>ERoot Object</em>' reference.
144    * @see #getERootObject()
145    * @generated
146    */

147   void setERootObject(EObject value);
148
149   /**
150    * <!-- begin-user-doc -->
151    * <!-- end-user-doc -->
152    * @model
153    * @generated
154    */

155   EClassifier getEClassifier(String JavaDoc namespaceURI, String JavaDoc typeName);
156
157   /**
158    * <!-- begin-user-doc -->
159    * <!-- end-user-doc -->
160    * @model
161    * @generated
162    */

163   EObject createEObject(EClass type);
164
165   /**
166    * An internal interface implemented by all data graphs to support.
167    */

168   interface Internal
169   {
170     /**
171      * Returns an object to be used as a write replacement.
172      * @return an object to be used as a write replacement.
173      */

174     Object JavaDoc getWriteReplacement();
175
176     /**
177      * Returns an object to be used as a write replacement for the given object in the data graph..
178      * @param eObject the object in question.
179      * @return an object to be used as a write replacement.
180      */

181     Object JavaDoc getWriteReplacement(EObject eObject);
182   }
183 } // EDataGraph
184
Popular Tags