1 // license-header java merge-point
2 //
3 // Attention: generated code (by Metafacade.vsl) - do not modify!
4 //
5 package org.andromda.cartridges.hibernate.metafacades;
6
7 import org.andromda.metafacades.uml.EntityAssociationEnd;
8
9 /**
10 * Represents an association end between Hibernate entities.
11 *
12 * Metafacade interface to be used by AndroMDA cartridges.
13 */
14 public interface HibernateAssociationEnd
15 extends EntityAssociationEnd
16 {
17 /**
18 * Indicates the metafacade type (used for metafacade mappings).
19 *
20 * @return boolean always <code>true</code>
21 */
22 public boolean isHibernateAssociationEndMetaType();
23
24 /**
25 * TODO: Model Documentation for
26 * org.andromda.cartridges.hibernate.metafacades.HibernateAssociationEnd.collectionIndexName
27 * @return String
28 */
29 public String getCollectionIndexName();
30
31 /**
32 * this will only apply for Maps, it will return the type of the attribute specified on the
33 * CollectionIndexName tagged value
34 * @return String
35 */
36 public String getCollectionIndexType();
37
38 /**
39 * TODO: Model Documentation for
40 * org.andromda.cartridges.hibernate.metafacades.HibernateAssociationEnd.collectionType
41 * @return String
42 */
43 public String getCollectionType();
44
45 /**
46 * The actual implementation of the collection type.
47 * @return String
48 */
49 public String getCollectionTypeImplementation();
50
51 /**
52 * TODO: Model Documentation for
53 * org.andromda.cartridges.hibernate.metafacades.HibernateAssociationEnd.embedXML
54 * @return String
55 */
56 public String getEmbedXML();
57
58 /**
59 * Stores the value indicating how a UML aggregation should be interpreted as cascade.
60 * @return String
61 */
62 public String getHibernateAggregationCascade();
63
64 /**
65 * Stores the hibernate cascade attribute of this association end.
66 * @return String
67 */
68 public String getHibernateCascade();
69
70 /**
71 * Stores the value indicating how a UML composition should be interpreted as cascade.
72 * @return String
73 */
74 public String getHibernateCompositionCascade();
75
76 /**
77 * TODO: Model Documentation for
78 * org.andromda.cartridges.hibernate.metafacades.HibernateAssociationEnd.orderByColumns
79 * @return String
80 */
81 public String getOrderByColumns();
82
83 /**
84 * This value will determine how Hibernate manages the asocciation on a many to one and one to
85 * one relation. It will tell hibernate how to use outerJoins. Values: auto,false,true
86 * @return String
87 */
88 public String getOuterJoin();
89
90 /**
91 * TODO: Model Documentation for
92 * org.andromda.cartridges.hibernate.metafacades.HibernateAssociationEnd.sortType
93 * @return String
94 */
95 public String getSortType();
96
97 /**
98 * TODO: Model Documentation for
99 * org.andromda.cartridges.hibernate.metafacades.HibernateAssociationEnd.whereClause
100 * @return String
101 */
102 public String getWhereClause();
103
104 /**
105 * TODO: Model Documentation for
106 * org.andromda.cartridges.hibernate.metafacades.HibernateAssociationEnd.xmlTagName
107 * @return String
108 */
109 public String getXmlTagName();
110
111 /**
112 * TODO: Model Documentation for
113 * org.andromda.cartridges.hibernate.metafacades.HibernateAssociationEnd.bag
114 * @return boolean
115 */
116 public boolean isBag();
117
118 /**
119 * TODO: Model Documentation for
120 * org.andromda.cartridges.hibernate.metafacades.HibernateAssociationEnd.bidirectionalOrderedListChild
121 * @return boolean
122 */
123 public boolean isBidirectionalOrderedListChild();
124
125 /**
126 * TODO: Model Documentation for
127 * org.andromda.cartridges.hibernate.metafacades.HibernateAssociationEnd.bidirectionalOrderedListParent
128 * @return boolean
129 */
130 public boolean isBidirectionalOrderedListParent();
131
132 /**
133 * Whether or not the hibernate inverse attribute is true or false.
134 * @return boolean
135 */
136 public boolean isHibernateInverse();
137
138 /**
139 * TODO: Model Documentation for
140 * org.andromda.cartridges.hibernate.metafacades.HibernateAssociationEnd.indexedCollection
141 * @return boolean
142 */
143 public boolean isIndexedCollection();
144
145 /**
146 * TODO: Model Documentation for
147 * org.andromda.cartridges.hibernate.metafacades.HibernateAssociationEnd.lazy
148 * @return boolean
149 */
150 public boolean isLazy();
151
152 /**
153 * TODO: Model Documentation for
154 * org.andromda.cartridges.hibernate.metafacades.HibernateAssociationEnd.list
155 * @return boolean
156 */
157 public boolean isList();
158
159 /**
160 * TODO: Model Documentation for
161 * org.andromda.cartridges.hibernate.metafacades.HibernateAssociationEnd.map
162 * @return boolean
163 */
164 public boolean isMap();
165
166 /**
167 * Returns whether or not a one-to-one mapping should be the "primary" mapping for the one2one.
168 * It returns a true if this one2one end is an aggregation or a composite. If using the foriegn
169 * key association approach, this end will get the foreign key column definition. If using the
170 * primary key association approach, this end will get the independent primary key and the other
171 * end will get the dependent primary key (i.e. its primary key will be a foreign key to this
172 * table).
173 * @return boolean
174 */
175 public boolean isOne2OnePrimary();
176
177 /**
178 * TODO: Model Documentation for
179 * org.andromda.cartridges.hibernate.metafacades.HibernateAssociationEnd.owning
180 * @return boolean
181 */
182 public boolean isOwning();
183
184 /**
185 * TODO: Model Documentation for
186 * org.andromda.cartridges.hibernate.metafacades.HibernateAssociationEnd.set
187 * @return boolean
188 */
189 public boolean isSet();
190 }