1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
|
/**
* <copyright>
*
* Service Data Objects
* Version 2.1.0
* Licensed Materials
*
* (c) Copyright BEA Systems, Inc., International Business Machines Corporation,
* Oracle Corporation, Primeton Technologies Ltd., Rogue Wave Software, SAP AG.,
* Software AG., Sun Microsystems, Sybase Inc., Xcalia, Zend Technologies,
* 2005, 2006. All rights reserved.
*
* </copyright>
*
*/
package commonj.sdo;
import java.io.Serializable;
/**
* A data graph is used to package a graph of {@link DataObject data objects} along with their
* metadata, that is, data describing the data.
* A data graph also contains a {@link #getChangeSummary change summary}
* which is used to record changes made to the objects in the graph.
*/
public interface DataGraph extends Serializable
{
/**
* Returns the root {@link DataObject data object} of this data graph.
* @return the root data object.
* @see DataObject#getDataGraph
*/
DataObject getRootObject();
/**
* Returns the {@link ChangeSummary change summary} associated with this data graph.
* @return the change summary.
* @see ChangeSummary#getDataGraph
*/
ChangeSummary getChangeSummary();
/**
* Returns the {@link Type type} with the given the {@link Type#getURI() URI},
* or contained by the resource at the given URI,
* and with the given {@link Type#getName name}.
* @param uri the namespace URI of a type or the location URI of a resource containing a type.
* @param typeName name of a type.
* @return the type with the corresponding namespace and name.
*/
Type getType(String uri, String typeName);
/**
* Creates a new root data object of the {@link #getType specified type}.
* An exception is thrown if a root object exists.
* @param namespaceURI namespace of the type.
* @param typeName name of the type.
* @return the new root.
* @throws IllegalStateException if the root object already exists.
* @see #createRootObject(Type)
* @see #getType(String, String)
*/
DataObject createRootObject(String namespaceURI, String typeName);
/**
* Creates a new root data object of the specified type.
* An exception is thrown if a root object exists.
* @param type the type of the new root.
* @return the new root.
* @throws IllegalStateException if the root object already exists.
* @see #createRootObject(String, String)
*/
DataObject createRootObject(Type type);
}
|
