View Javadoc
1   // license-header java merge-point
2   //
3   // Attention: generated code (by Metafacade.vsl) - do not modify!
4   //
5   package org.andromda.metafacades.uml;
6   
7   /**
8    * Represents an association end of an entity.
9    *
10   * Metafacade interface to be used by AndroMDA cartridges.
11   */
12  public interface EntityAssociationEnd
13      extends AssociationEndFacade
14  {
15      /**
16       * Indicates the metafacade type (used for metafacade mappings).
17       *
18       * @return boolean always <code>true</code>
19       */
20      public boolean isEntityAssociationEndMetaType();
21  
22      /**
23       * The name of the index to create on a column that persists the foreign key attribute.
24       * @return String
25       */
26      public String getColumnIndex();
27  
28      /**
29       * The name of the column that makes up the foreign key.
30       * @return String
31       */
32      public String getColumnName();
33  
34      /**
35       * The name of the foreign key constraint to use for databases.
36       * @return String
37       */
38      public String getForeignKeyConstraintName();
39  
40      /**
41       * The current foreign key suffix specified for this entity association end facade.
42       * @return String
43       */
44      public String getForeignKeySuffix();
45  
46      /**
47       * The SQL type for this the foreign key column of this association end.
48       * @return String
49       */
50      public String getSqlType();
51  
52      /**
53       * The name of the unique-key that this unique association end belongs
54       * @return String
55       */
56      public String getUniqueGroup();
57  
58      /**
59       * Indicates whether or not a foreign identifier should be used for the entity that owns this
60       * association end.  This would only make sense in the case of a child in a one-to-one
61       * parent-child association.  If this flag is true, then the identifier of this entity should
62       * also be used as the foreign key to the related parent entity.
63       * @return boolean
64       */
65      public boolean isForeignIdentifier();
66  
67      /**
68       * True if this association is an identifier for its entity.
69       * @return boolean
70       */
71      public boolean isIdentifier();
72  
73      /**
74       * True if the associationEnd is marked with identifiers stereotype, false otherwise.
75       * @return boolean
76       */
77      public boolean isIdentifiersPresent();
78  
79      /**
80       * Indicates this association end should be ignored by the persistence layer.
81       * @return boolean
82       */
83      public boolean isTransient();
84  }