1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18 package org.apache.jdo.model.jdo;
19
20 import org.apache.jdo.model.ModelException;
21 import org.apache.jdo.model.java.JavaType;
22
23
24 /***
25 * A JDOCollection instance represents the JDO relationship metadata
26 * of a collection relationship field.
27 *
28 * @author Michael Bouschen
29 */
30 public interface JDOCollection
31 extends JDORelationship
32 {
33 /***
34 * Determines whether the values of the elements should be stored if
35 * possible as part of the instance instead of as their own instances
36 * in the datastore.
37 * @return <code>true</code> if the elements should be stored as part of
38 * the instance; <code>false</code> otherwise
39 */
40 public boolean isEmbeddedElement();
41
42 /***
43 * Set whether the values of the elements should be stored if possible as
44 * part of the instance instead of as their own instances in the datastore.
45 * @param embeddedElement <code>true</code> if elements should be stored
46 * as part of the instance
47 * @exception ModelException if impossible
48 */
49 public void setEmbeddedElement(boolean embeddedElement)
50 throws ModelException;
51
52 /***
53 * Get the type representation of the collection elements.
54 * @return the element type
55 */
56 public JavaType getElementType();
57
58 /***
59 * Set the type representation of the collection elements.
60 * @param elementType the type representation of the collection elements
61 * @exception ModelException if impossible
62 */
63 public void setElementType(JavaType elementType)
64 throws ModelException;
65
66 /***
67 * Get the type of collection elements as string.
68 * @return the element type as string
69 */
70 public String getElementTypeName();
71
72 /***
73 * Set string representation of the type of collection elements.
74 * @param elementTypeName a string representation of the type of elements in
75 * the collection.
76 * @exception ModelException if impossible
77 */
78 public void setElementTypeName(String elementTypeName)
79 throws ModelException;
80
81 }