View Javadoc

1   package org.andromda.metafacades.uml;
2   
3   /***
4    * Stores the metafacade namespace properties used throughout the UML metafacades.
5    *
6    * @author Chad Brandon
7    */
8   public class UMLMetafacadeProperties
9   {
10      /***
11       * Stores the property containing the URI to the language mappings file.
12       */
13      public static final String LANGUAGE_MAPPINGS_URI = "languageMappingsUri";
14  
15      /***
16       * This property controls whether or not to produce templating parameters
17       * where possible.
18       */
19      public static final String ENABLE_TEMPLATING = "enableTemplating";
20  
21      /***
22       * Stores the property defining the default schema name for entity tables.
23       */
24      public static final String SCHEMA_NAME = "schemaName";
25      
26      /***
27       * Stores the property defining the prefix for entity table names.
28       */
29      public static final String TABLE_NAME_PREFIX = "tableNamePrefix";
30  
31      /***
32       * Stores the property defining the prefix for entity table column names.
33       */
34      public static final String COLUMN_NAME_PREFIX = "columnNamePrefix";
35  
36      /***
37       * Stores the property containing the URI to the SQL mappings file.
38       */
39      public static final String SQL_MAPPINGS_URI = "sqlMappingsUri";
40  
41      /***
42       * Stores the property containing the URI to the JDBC mappings file.
43       */
44      public static final String JDBC_MAPPINGS_URI = "jdbcMappingsUri";
45  
46      /***
47       * Stores the property containing the URI to the Wrapper mappings file.
48       */
49      public static final String WRAPPER_MAPPINGS_URI = "wrapperMappingsUri";
50  
51      /***
52       * Allows the pluralization of association end names (when the multiplicity is greater than one) to be turned
53       * on/off.
54       */
55      public static final String PLURALIZE_ASSOCIATION_END_NAMES = "pluralizeAssociationEndNames";
56  
57      /***
58       * The default suffix to use for foreign keys.
59       */
60      public static final String FOREIGN_KEY_SUFFIX = "foreignKeySuffix";
61  
62      /***
63       * The default suffix to use for foreign keys.
64       */
65      public static final String CONSTRAINT_SUFFIX = "constraintSuffix";
66  
67      /***
68       * The mask to apply to role names {@see NameMasker#mask(String, String)}.
69       */
70      public static final String ROLE_NAME_MASK = "roleNameMask";
71  
72      /***
73       * The mask to apply to any classifier names {@see NameMasker#mask(String, String)}.
74       */
75      public static final String CLASSIFIER_NAME_MASK = "classifierNameMask";
76  
77      /***
78       * The mask to apply to any of the classifier property names {@see NameMasker#mask(String, String)}.
79       */
80      public static final String CLASSIFIER_PROPERTY_NAME_MASK = "classifierPropertyNameMask";
81  
82      /***
83       * The mask to apply to any operation names {@see NameMasker#mask(String, String)}.
84       */
85      public static final String OPERATION_NAME_MASK = "operationNameMask";
86  
87      /***
88       * The mask to apply to any parameter names {@see NameMasker#mask(String, String)}.
89       */
90      public static final String PARAMETER_NAME_MASK = "parameterNameMask";
91  
92      /***
93       * The mask to apply to enumeration literal names {@see NameMasker#mask(String, String)}.
94       */
95      public static final String ENUMERATION_LITERAL_NAME_MASK = "enumerationLiteralNameMask";
96  
97      /***
98       * The mask to apply to the enumeration literal name {@see NameMasker#mask(String, String)}.
99       */
100     public static final String ENUMERATION_NAME_MASK = "enumerationNameMask";
101 
102     /***
103      * The mask to apply to the entity name {@see NameMasker#mask(String, String)}.
104      */
105     public static final String ENTITY_NAME_MASK = "entityNameMask";
106 
107     /***
108      * The mask to apply to the entity property (attributes and association) names {@see
109      * MetafacadeUtils#getMaskedName(String, String)}.
110      */
111     public static final String ENTITY_PROPERTY_NAME_MASK = "entityPropertyNameMask";
112 
113     /***
114      * The maximum length a SQL name can be before its truncated.
115      */
116     public static final String MAX_SQL_NAME_LENGTH = "maxSqlNameLength";
117 
118     /***
119      * Whether or not to allow default identifiers for modeled entities.
120      */
121     public static final String ALLOW_DEFAULT_IDENTITIFIERS = "allowDefaultIdentifiers";
122 
123     /***
124      * The pattern used to construct the name entity default identifiers (if enabled).
125      */
126     public static final String DEFAULT_IDENTIFIER_PATTERN = "defaultIdentifierPattern";
127 
128     /***
129      * The type to given default identifiers.
130      */
131     public static final String DEFAULT_IDENTIFIER_TYPE = "defaultIdentifierType";
132 
133     /***
134      * The visibility to apply to default identifiers.
135      */
136     public static final String DEFAULT_IDENTIFIER_VISIBILITY = "defaultIdentifierVisibility";
137 
138     /***
139      * The type to given default enumeration literals.
140      */
141     public static final String DEFAULT_ENUMERATION_LITERAL_TYPE = "defaultEnumerationLiteralType";
142 
143     /***
144      * Are manageable tables resolved by default when referenced ?
145      */
146     public static final String PROPERTY_DEFAULT_RESOLVEABLE = "defaultResolveable";
147 
148     /***
149      * Stores the default upper limit for lists.
150      */
151     public static final String PROPERTY_DEFAULT_MAX_LIST_SIZE = "defaultMaximumListSize";
152 
153     /***
154      * Stores the default number of records shown per page.
155      */
156     public static final String PROPERTY_DEFAULT_PAGE_SIZE = "defaultPageSize";
157 
158     /***
159      * The separator used for packages and element names when constructing fully qualified names.
160      */
161     public static final String NAMESPACE_SEPARATOR = "namespaceSeparator";
162 
163     /***
164      * The name given to model elements without a name.
165      */
166     public static final String UNDEFINED_NAME = "undefinedName";
167 
168     /***
169      * Stores the suffix given to array type names.
170      */
171     public static final String ARRAY_NAME_SUFFIX = "arrayNameSuffix";
172 
173     /***
174      * Whether or not to enable manageable entities for the currently running cartridge.
175      */
176     public static final String ENABLE_MANAGEABLE_ENTITIES = "enableManageableEntities";
177 
178     /***
179      * The namespace property used to denote the name of the subpackage create for
180      * manageable entities.
181      */
182     public static final String MANAGEABLE_PACKAGE_NAME_SUFFIX = "manageablePackageSuffix";
183 
184     /***
185      * Stores the boolean flag indicating whether or not we should use arrays instead of collections with associations
186      * of type many (where appropriate).
187      */
188     public static final String USE_ARRAYS_FOR_MULTIPLICITIES_OF_TYPE_MANY = "useArraysForMultiplicitiesOfTypeMany";
189 
190     /***
191      * The seperator for relation names between associations.
192      */
193     public static final String RELATION_NAME_SEPARATOR = "relationNameSeparator";
194 
195     /***
196      * The seperator to use when constructing SQL names.
197      */
198     public static final String SQL_NAME_SEPARATOR = "sqlNameSeparator";
199 
200     /***
201      * The pattern used for constructing operations that handle precondition constraints.
202      */
203     public static final String PRECONDITION_NAME_PATTERN = "preconditionNamePattern";
204 
205     /***
206      * The pattern used for constructing operations that handle postcondition constraints.
207      */
208     public static final String POSTCONDITION_NAME_PATTERN = "postconditionNamePattern";
209     
210     /***
211      * The namespace property used to identify the pattern used to construct the backend CRUD service's accessor.
212      */
213     public static final String MANAGEABLE_SERVICE_ACCESSOR_PATTERN = "manageableServiceAccessorPattern";
214     
215     /***
216      * The namespace property used to define the default multiplicity of
217      * an attribute or association end (when one isn't modeled).
218      */
219     public static final String DEFAULT_MULTIPLICITY = "defaultMultiplicity";
220 
221     /***
222      * Denotes whether or not the id needs to be displayed when managing an entity, or whether this
223      * should be transparent for the user.
224      */
225     public static final String MANAGEABLE_ID_DISPLAY_STRATEGY = "manageableIdDisplayStrategy";
226 
227     /***
228      * Indicates whether enumerations must be generated using a Java 5 type-safe enum or a 
229      * traditional enumeration-pattern class.
230      */
231 	public static final String TYPE_SAFE_ENUMS_ENABLED = "typeSafeEnumsEnabled";
232 
233 }