Velocity Generator Reference

Last modified by David Avendasora on 2011/06/24 19:56

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.

//////////////////////////////////////////////////////////
EOEntity
//////////////////////////////////////////////////////////
NAME
 $entity.name
 $entity.pluralName
 $entity.initialLowercaseName
 $entity.pluralInitialLowercaseName
 $entity.fullyQualifiedName
 $entity.originalName
 $entity.externalName

CLASS
 $entity.className
 $entity.classNameWithDefault
 $entity.classNameWithoutPackage
 $entity.classNameWithOptionalPackage

$entity.initialLowercaseClassNameWithoutPackage
 $entity.pluralInitialLowercaseClassNameWithoutPackage

$entity.prefixClassName
 $entity.prefixClassNameWithoutPackage
 $entity.prefixClassNameWithOptionalPackage

$entity.genericRecord (isGenericRecord)

$entity.packageName
 $entity.superclassPackageName

$entity.parentClassName
 $entity.parentClassNameSet (isParentClassNameSet)
 $entity.clientClassName

ATTRIBUTES
 $entity.attributes
 $entity.sortedAttributes
 $entity.attributeNames
 $entity.singlePrimaryKeyAttribute
 $entity.primaryKeyAttributes

$entity.classAttributes
 $entity.sortedClassAttributes
 $entity.clientClassAttributes
 $entity.sortedClientClassAttributes
 $entity.commonClassAttributes
 $entity.sortedCommonClassAttributes
 $entity.nonClassAttributes

RELATIONSHIPS
 $entity.relationships
 $entity.sortedRelationships
 $entity.classRelationships
 $entity.sortedClassRelationships
 $entity.clientClassRelationships
 $entity.sortedClientClassRelationships
 $entity.commonClassRelationships
 $entity.sortedCommonClassRelationships
 $entity.nonClassRelationships

$entity.toOneRelationships
 $entity.sortedToOneRelationships
 $entity.classToOneRelationships
 $entity.sortedClassToOneRelationships
 $entity.clientClassToOneRelationships
 $entity.sortedClientClassToOneRelationships
 $entity.commonClassToOneRelationships
 $entity.sortedCommonClassToOneRelationships

$entity.toManyRelationships
 $entity.sortedToManyRelationships
 $entity.classToManyRelationships
 $entity.sortedClassToManyRelationships
 $entity.clientClassToManyRelationships
 $entity.sortedClientClassToManyRelationships
 $entity.commonClassToManyRelationships
 $entity.sortedCommonClassToManyRelationships

INDEXES (See EOEntityIndex below)
 $entity.entityIndexes
 $entity.sortedEntityIndexes

FETCH SPECS (See EOFetchSpecification below)
 $entity.fetchSpecs
 $entity.sortedFetchSpecs

PROPERTIES
 $entity.externalName
 $entity.model
 $entity.readOnly (isReadOnly)
 $entity.prototype (isPrototype)
 $entity.partialBase (isPartialBase)
 $entity.partialEntity (isPartialEntity)
 $entity.abstractEntity (isAbstractEntity)
 $entity.cachesObjects
 $entity.hasSharedObjects
 $entity.sharesAllObjectsOnly
 $entity.enternalQuery
 $entity.maxNumberOfInstancesToBatchFetch
 $entity.entityIndexes
 $entity.sortedEntityIndexes
 $entity.referenceFailures
 $entity.referencingRelationships
 $entity.parent
 $entity.childrenEntities
 $entity.restrictingQualifier

STORED PROCEDURES
 $entity.deleteProcedure
 $entity.fetchAllProcedure
 $entity.fetchWithPrimaryKeyProcedure
 $entity.insertProcedure
 $entity.nextPrimaryKeyProcedure

INHERITANCE
 $entity.inherited (isInherited)
 $entity.singleTableInheritance (isSingleTableInheritance)
 $entity.verticalInheritance (isVerticalInheritance)
 $entity.horizontalInheritance (isHorizontalInheritance)
 $entity.inheritedAttributes
 $entity.inheritedRelationships

DOCUMENTATION
 $entity.documentation

//////////////////////////////////////////////////////////
EOAttribute
//////////////////////////////////////////////////////////

NAME
 $attribute.name
 $attribute.capitalizedName
 $attribute.uppercaseUnderscoreName
 $attribute.fullyQualifiedName

CLASS
 $attribute.javaClassName
 $attribute.valueClassName
 $attribute.valueType

PROPERTIES
 $attribute.columnName
 $attribute.definition
 $attribute.definitionPath

$attribute.allowsNull
 $attribute.usedForLocking
 $attribute.prototype

$attribute.externalType
 $attribute.precision
 $attribute.scale
 $attribute.width
 $attribute.serverTimeZone

$attribute.prototyped  (isPrototyped)
 $attribute.flattened  (isFlattened)
 $attribute.inherited  (isInherited)
 $attribute.readOnly  (isReadOnly)
 $attribute.indexed  (isIndexed)
 $attribute.classProperty  (isClassProperty)
 $attribute.clientClassProperty  (isClientClassProperty)
 $attribute.commonClassProperty  (isCommonClassProperty)

$attribute.primaryKey  (isPrimaryKey)

$attribute.adaptorValueConversionMethodName
 $attribute.factoryMethodArgumentType
 $attribute.valueFactoryMethodName
 $attribute.readFormat
 $attribute.writeFormat

$attribute.referenceFailures
 $attribute.referencingFlattenedAttributes
 $attribute.referencingRelationships

DOCUMENTATION
 $attribute.documentation

//////////////////////////////////////////////////////////
EORelationship
//////////////////////////////////////////////////////////

NAME
 $relationship.name
 $relationship.captializedName
 $relationship.uppercaseUnderscoreName
 $relationship.fullyQualifiedName

PROPERTIES
 $relationship.actualDestination  (see EOEntity keys)
 $relationship.destination

$relationship.ownsDestination
 $relationship.propagatesPrimaryKey
 $relationship.flattened  (isFlattened)
 $relationship.inherited  (isInherited)
 $relationship.mandatory  (isMandatory)
 $relationship.optional  (isOptional)
 $relationship.classProperty  (isClassProperty)
 $relationship.clientClassProperty  (isClientClassProperty)
 $relationship.commonClassProperty  (isCommonClassProperty)
 $relationship.toMany  (isToMany)
 $relationship.toOne  (isToOne)
 $relationship.isInverseRelationship?

$relationship.definition
 $relationship.definitionPath
 $relationship.deleteRule
 $relationship.inverseRelationship 
 $relationship.relatedAttributes
 $relationship.joinSemantic
 $relationship.joins
 $relationship.firstJoin
 $relationship.mumberOfToManyFaultsToBatchFetch
 $relationship.referenceFailures
 $relationship.referencingFlattenedAttributes
 $relationship.referencingFlattenedRelationships

DOCUMENTATION
 $relationship.documentation

//////////////////////////////////////////////////////////
EOEntityIndex
//////////////////////////////////////////////////////////

$index.name
 $index.constraint    ($index.constraint.externalName == "distinct", "fulltext", "spatial", or "none")
 $index.indexType  ($index.indexType.externalName == "clustered" or "hashed"
 $index.order   ($index.order.externalName) == "asc" or "desc"
 $index.attributes   (see EOAttribute)

//////////////////////////////////////////////////////////
EOFetchSpecification
//////////////////////////////////////////////////////////

NAME
 $fetchSpec.name
 $fetchSpec.initialLowercaseName
 $fetchSpec.capitalizedName
 $fetchSpec.uppercaseUnderscoreName
 $fetchSpec.fullyQualifiedName

BINDINGS (see EOQualifierBinding below for the keys for each binding)
 $fetchSpec.distinctBindings
 $fetchSpec.allBindings

RAW ROWS
 $fetchSpec.rawRowKeyPaths
 $fetchSpec.fetchEnterpriseObjects  (isFetchEnterpriseObjects)
 $fetchSpec.fetchAllAttributesAsRawRows  (isFetchAllAttributesAsRawRows)
 $fetchSpec.fetchSpecificAttributesAsRawRows  (isFetchSpecificAttributesAsRawRows)

PROPERTIES
 $fetchSpec.sharesObjects
 $fetchSpec.usingQualifier
 $fetchSpec.usingCustomQuery
 $fetchSpec.usingStoredProcedure
 $fetchSpec.deep  (isDeep)
 $fetchSpec.locksObjects
 $fetchSpec.promptsAfterFetchLimit
 $fetchSpec.refreshesRefetchedObjects
 $fetchSpec.requiresAllQualifierBindingVariables
 $fetchSpec.usesDistinct

$fetchSpec.sortOrderings
 $fetchSpec.customQueryExpression
 $fetchSpec.storedProcedure
 $fetchSpec.qualifier
 $fetchSpec.qualifierString
 $fetchSpec.fetchLimit
 $fetchSpec.prefetchingRelationshipKeyPaths
 $fetchSpec.referenceFailures

//////////////////////////////////////////////////////////
EOQualifierBinding  (these keys are the for the Fetch Specification bindings in the qualifier)
//////////////////////////////////////////////////////////
 $binding.name
 $binding.javaClassName
 $binding.keyPath
 $binding.attributePath