1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17 package javax.jdo.metadata;
18
19 /**
20 * Represents ordering of a collection field/property.
21 * @since 3.0
22 */
23 public interface OrderMetadata extends Metadata {
24 /**
25 * Method to set the version column name.
26 *
27 * @param column Name of the version clumn
28 */
29 OrderMetadata setColumn(String column);
30
31 /**
32 * Accessor for the version column name
33 *
34 * @return The version column name
35 */
36 String getColumn();
37
38 /**
39 * Method to set mapped-by information whether the order is present in the element class.
40 *
41 * @param mappedBy Field/property name in which to store the ordering in the element
42 */
43 OrderMetadata setMappedBy(String mappedBy);
44
45 /**
46 * Accessor for the mapped-by field/property name in the element class.
47 *
48 * @return Name of field/property in element class
49 */
50 String getMappedBy();
51
52 /**
53 * Accessor for all column(s) defined on the ordering.
54 *
55 * @return The column(s)
56 */
57 ColumnMetadata[] getColumns();
58
59 /**
60 * Add a column for this ordering.
61 *
62 * @return The ColumnMetadata
63 */
64 ColumnMetadata newColumnMetadata();
65
66 /**
67 * Accessor for the number of columns defined for this ordering.
68 *
69 * @return The number of columns
70 */
71 int getNumberOfColumns();
72
73 /**
74 * Method to set index metadata for the ordering
75 *
76 * @return The metadata for any index
77 */
78 IndexMetadata newIndexMetadata();
79
80 /**
81 * Accessor for any index metadata for the ordering
82 *
83 * @return Index metadata
84 */
85 IndexMetadata getIndexMetadata();
86 }