View Javadoc

1   //
2   // Attention: generated code (by Metafacade.vsl) - do not modify!
3   //
4   package org.andromda.metafacades.uml;
5   
6   /***
7    * <p>
8    * Represents an attribute of an entity.
9    * </p>
10   *
11   * Metafacade interface to be used by AndroMDA cartridges.
12   */
13  public interface EntityAttribute
14      extends org.andromda.metafacades.uml.AttributeFacade
15  {
16  
17      /***
18       * Indicates the metafacade type (used for metafacade mappings).
19       *
20       * @return always <code>true</code>
21       */
22      public boolean isEntityAttributeMetaType();
23  
24     /***
25      * <p>
26      * The name of the index to create on a column that persists the
27      * entity attribute.
28      * </p>
29      */
30      public java.lang.String getColumnIndex();
31  
32     /***
33      * <p>
34      * The length of the column that persists this entity attribute.
35      * </p>
36      */
37      public java.lang.String getColumnLength();
38  
39     /***
40      * <p>
41      * The name of the table column to which this entity is mapped.
42      * </p>
43      */
44      public java.lang.String getColumnName();
45  
46     /***
47      * <p>
48      * The PIM to language specific mappings for JDBC.
49      * </p>
50      */
51      public org.andromda.metafacades.uml.TypeMappings getJdbcMappings();
52  
53     /***
54      * <p>
55      * The JDBC type for this entity attribute.
56      * </p>
57      */
58      public java.lang.String getJdbcType();
59  
60     /***
61      * <p>
62      * The SQL mappings (i.e. the mappings which provide PIM to SQL
63      * mappings).
64      * </p>
65      */
66      public org.andromda.metafacades.uml.TypeMappings getSqlMappings();
67  
68     /***
69      * <p>
70      * The SQL type for this attribute.
71      * </p>
72      */
73      public java.lang.String getSqlType();
74  
75     /***
76      * <p>
77      * The name of the unique-key that this unique attribute belongs
78      * </p>
79      */
80      public java.lang.String getUniqueGroup();
81  
82     /***
83      * <p>
84      * True if this attribute is an identifier for its entity.
85      * </p>
86      */
87      public boolean isIdentifier();
88  
89     /***
90      * <p>
91      * Indicates this attribute should be ignored by the persistence
92      * layer.
93      * </p>
94      */
95      public boolean isTransient();
96  
97     /***
98      * <p>
99      * Whether or not the entity attribute is unique (default is
100     * false).
101     * </p>
102     */
103     public boolean isUnique();
104 
105 }