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 attribute of an entity.
9 *
10 * Metafacade interface to be used by AndroMDA cartridges.
11 */
12 public interface EntityAttribute
13 extends AttributeFacade
14 {
15 /**
16 * Indicates the metafacade type (used for metafacade mappings).
17 *
18 * @return boolean always <code>true</code>
19 */
20 public boolean isEntityAttributeMetaType();
21
22 /**
23 * The name of the index to create on a column that persists the entity attribute.
24 * @return String
25 */
26 public String getColumnIndex();
27
28 /**
29 * The length of the column that persists this entity attribute.
30 * @return String
31 */
32 public String getColumnLength();
33
34 /**
35 * The name of the table column to which this entity is mapped.
36 * @return String
37 */
38 public String getColumnName();
39
40 /**
41 * The PIM to language specific mappings for JDBC.
42 * @return TypeMappings
43 */
44 public TypeMappings getJdbcMappings();
45
46 /**
47 * The JDBC type for this entity attribute.
48 * @return String
49 */
50 public String getJdbcType();
51
52 /**
53 * The SQL mappings (i.e. the mappings which provide PIM to SQL mappings).
54 * @return TypeMappings
55 */
56 public TypeMappings getSqlMappings();
57
58 /**
59 * The SQL type for this attribute.
60 * @return String
61 */
62 public String getSqlType();
63
64 /**
65 * The name of the unique-key that this unique attribute belongs
66 * @return String
67 */
68 public String getUniqueGroup();
69
70 /**
71 * True if this attribute is an identifier for its entity.
72 * @return boolean
73 */
74 public boolean isIdentifier();
75
76 /**
77 * Indicates this attribute should be ignored by the persistence layer.
78 * @return boolean
79 */
80 public boolean isTransient();
81 }