Skip to Content

Wiki source code of Velocity Generator Reference

Last modified by David Avendasora on 2011/06/24 19:56
Show last authors
1 This is a reference of the available bindings for the Velocity Generator inside WOLips.  This is fairly complete, but not exhaustive.  For more detail consult the Entity Modeler [[source>>url:https://github.com/wolips/wolips/tree/master/wolips/core/plugins/org.objectstyle.wolips.eomodeler.core/java/org/objectstyle/wolips/eomodeler/core/model||title="WOLips Source Code on Github.com" shape="rect"]].
2
3 **~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/**
4 **EOEntity**
5 **~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/**
6 **NAME**
7 $entity.name
8 $entity.pluralName
9 $entity.initialLowercaseName
10 $entity.pluralInitialLowercaseName
11 $entity.fullyQualifiedName
12 $entity.originalName
13 $entity.externalName
14
15 **CLASS**
16 $entity.className
17 $entity.classNameWithDefault
18 $entity.classNameWithoutPackage
19 $entity.classNameWithOptionalPackage
20
21 $entity.initialLowercaseClassNameWithoutPackage
22 $entity.pluralInitialLowercaseClassNameWithoutPackage
23
24 $entity.prefixClassName
25 $entity.prefixClassNameWithoutPackage
26 $entity.prefixClassNameWithOptionalPackage
27
28 $entity.genericRecord (isGenericRecord)
29
30 $entity.packageName
31 $entity.superclassPackageName
32
33 $entity.parentClassName
34 $entity.parentClassNameSet (isParentClassNameSet)
35 $entity.clientClassName
36
37 **ATTRIBUTES**
38 $entity.attributes
39 $entity.sortedAttributes
40 $entity.attributeNames
41 $entity.singlePrimaryKeyAttribute
42 $entity.primaryKeyAttributes
43
44 $entity.classAttributes
45 $entity.sortedClassAttributes
46 $entity.clientClassAttributes
47 $entity.sortedClientClassAttributes
48 $entity.commonClassAttributes
49 $entity.sortedCommonClassAttributes
50 $entity.nonClassAttributes
51
52 **RELATIONSHIPS**
53 $entity.relationships
54 $entity.sortedRelationships
55 $entity.classRelationships
56 $entity.sortedClassRelationships
57 $entity.clientClassRelationships
58 $entity.sortedClientClassRelationships
59 $entity.commonClassRelationships
60 $entity.sortedCommonClassRelationships
61 $entity.nonClassRelationships
62
63 $entity.toOneRelationships
64 $entity.sortedToOneRelationships
65 $entity.classToOneRelationships
66 $entity.sortedClassToOneRelationships
67 $entity.clientClassToOneRelationships
68 $entity.sortedClientClassToOneRelationships
69 $entity.commonClassToOneRelationships
70 $entity.sortedCommonClassToOneRelationships
71
72 $entity.toManyRelationships
73 $entity.sortedToManyRelationships
74 $entity.classToManyRelationships
75 $entity.sortedClassToManyRelationships
76 $entity.clientClassToManyRelationships
77 $entity.sortedClientClassToManyRelationships
78 $entity.commonClassToManyRelationships
79 $entity.sortedCommonClassToManyRelationships
80
81 **INDEXES (See EOEntityIndex below)**
82 $entity.entityIndexes
83 $entity.sortedEntityIndexes
84
85 **FETCH SPECS (See EOFetchSpecification below)**
86 $entity.fetchSpecs
87 $entity.sortedFetchSpecs
88
89 **PROPERTIES**
90 $entity.externalName
91 $entity.model
92 $entity.readOnly (isReadOnly)
93 $entity.prototype (isPrototype)
94 $entity.partialBase (isPartialBase)
95 $entity.partialEntity (isPartialEntity)
96 $entity.abstractEntity (isAbstractEntity)
97 $entity.cachesObjects
98 $entity.hasSharedObjects
99 $entity.sharesAllObjectsOnly
100 $entity.enternalQuery
101 $entity.maxNumberOfInstancesToBatchFetch
102 $entity.entityIndexes
103 $entity.sortedEntityIndexes
104 $entity.referenceFailures
105 $entity.referencingRelationships
106 $entity.parent
107 $entity.childrenEntities
108 $entity.restrictingQualifier
109
110 **STORED PROCEDURES**
111 $entity.deleteProcedure
112 $entity.fetchAllProcedure
113 $entity.fetchWithPrimaryKeyProcedure
114 $entity.insertProcedure
115 $entity.nextPrimaryKeyProcedure
116
117 **INHERITANCE**
118 $entity.inherited (isInherited)
119 $entity.singleTableInheritance (isSingleTableInheritance)
120 $entity.verticalInheritance (isVerticalInheritance)
121 $entity.horizontalInheritance (isHorizontalInheritance)
122 $entity.inheritedAttributes
123 $entity.inheritedRelationships
124
125 **DOCUMENTATION**
126 $entity.documentation
127
128 **~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/**
129 **EOAttribute**
130 **~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/**
131
132 **NAME**
133 $attribute.name
134 $attribute.capitalizedName
135 $attribute.uppercaseUnderscoreName
136 $attribute.fullyQualifiedName
137
138 **CLASS**
139 $attribute.javaClassName
140 $attribute.valueClassName
141 $attribute.valueType
142
143 **PROPERTIES**
144 $attribute.columnName
145 $attribute.definition
146 $attribute.definitionPath
147
148 $attribute.allowsNull
149 $attribute.usedForLocking
150 $attribute.prototype
151
152 $attribute.externalType
153 $attribute.precision
154 $attribute.scale
155 $attribute.width
156 $attribute.serverTimeZone
157
158 $attribute.prototyped  (isPrototyped)
159 $attribute.flattened  (isFlattened)
160 $attribute.inherited  (isInherited)
161 $attribute.readOnly  (isReadOnly)
162 $attribute.indexed  (isIndexed)
163 $attribute.classProperty  (isClassProperty)
164 $attribute.clientClassProperty  (isClientClassProperty)
165 $attribute.commonClassProperty  (isCommonClassProperty)
166
167 $attribute.primaryKey  (isPrimaryKey)
168
169 $attribute.adaptorValueConversionMethodName
170 $attribute.factoryMethodArgumentType
171 $attribute.valueFactoryMethodName
172 $attribute.readFormat
173 $attribute.writeFormat
174
175 $attribute.referenceFailures
176 $attribute.referencingFlattenedAttributes
177 $attribute.referencingRelationships
178
179 **DOCUMENTATION**
180 $attribute.documentation
181
182 **~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/**
183 **EORelationship**
184 **~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/**
185
186 **NAME**
187 $relationship.name
188 $relationship.captializedName
189 $relationship.uppercaseUnderscoreName
190 $relationship.fullyQualifiedName
191
192 **PROPERTIES**
193 $relationship.actualDestination  (see EOEntity keys)
194 $relationship.destination
195
196 $relationship.ownsDestination
197 $relationship.propagatesPrimaryKey
198 $relationship.flattened  (isFlattened)
199 $relationship.inherited  (isInherited)
200 $relationship.mandatory  (isMandatory)
201 $relationship.optional  (isOptional)
202 $relationship.classProperty  (isClassProperty)
203 $relationship.clientClassProperty  (isClientClassProperty)
204 $relationship.commonClassProperty  (isCommonClassProperty)
205 $relationship.toMany  (isToMany)
206 $relationship.toOne  (isToOne)
207 $relationship.isInverseRelationship?
208
209 $relationship.definition
210 $relationship.definitionPath
211 $relationship.deleteRule
212 $relationship.inverseRelationship 
213 $relationship.relatedAttributes
214 $relationship.joinSemantic
215 $relationship.joins
216 $relationship.firstJoin
217 $relationship.mumberOfToManyFaultsToBatchFetch
218 $relationship.referenceFailures
219 $relationship.referencingFlattenedAttributes
220 $relationship.referencingFlattenedRelationships
221
222 **DOCUMENTATION**
223 $relationship.documentation
224
225 **~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/**
226 **EOEntityIndex**
227 **~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/**
228
229 $index.name
230 $index.constraint ($index.constraint.externalName == "distinct", "fulltext", "spatial", or "none")
231 $index.indexType ($index.indexType.externalName == "clustered" or "hashed"
232 $index.order ($index.order.externalName) == "asc" or "desc"
233 $index.attributes (see EOAttribute)
234
235 **~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/**
236 **EOFetchSpecification**
237 **~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/**
238
239 **NAME**
240 $fetchSpec.name
241 $fetchSpec.initialLowercaseName
242 $fetchSpec.capitalizedName
243 $fetchSpec.uppercaseUnderscoreName
244 $fetchSpec.fullyQualifiedName
245
246 **BINDINGS** (see EOQualifierBinding below for the keys for each binding)
247 $fetchSpec.distinctBindings
248 $fetchSpec.allBindings
249
250 **RAW ROWS**
251 $fetchSpec.rawRowKeyPaths
252 $fetchSpec.fetchEnterpriseObjects  (isFetchEnterpriseObjects)
253 $fetchSpec.fetchAllAttributesAsRawRows  (isFetchAllAttributesAsRawRows)
254 $fetchSpec.fetchSpecificAttributesAsRawRows  (isFetchSpecificAttributesAsRawRows)
255
256 **PROPERTIES**
257 $fetchSpec.sharesObjects
258 $fetchSpec.usingQualifier
259 $fetchSpec.usingCustomQuery
260 $fetchSpec.usingStoredProcedure
261 $fetchSpec.deep  (isDeep)
262 $fetchSpec.locksObjects
263 $fetchSpec.promptsAfterFetchLimit
264 $fetchSpec.refreshesRefetchedObjects
265 $fetchSpec.requiresAllQualifierBindingVariables
266 $fetchSpec.usesDistinct
267
268 $fetchSpec.sortOrderings
269 $fetchSpec.customQueryExpression
270 $fetchSpec.storedProcedure
271 $fetchSpec.qualifier
272 $fetchSpec.qualifierString
273 $fetchSpec.fetchLimit
274 $fetchSpec.prefetchingRelationshipKeyPaths
275 $fetchSpec.referenceFailures
276
277 **~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/**
278 **EOQualifierBinding**  (these keys are the for the Fetch Specification bindings in the qualifier)
279 **~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/~/**
280 $binding.name
281 $binding.javaClassName
282 $binding.keyPath
283 $binding.attributePath