IGenerator Interface

Gets the action procedures stored in the SPCalls set. It consults the project for meta-data and assumes a proc is valid and thus is either an action proc on all targets or a rertieval proc on all targets

Gets the active derived model definition. If the generator isn't used for a derived model, this property returns null.

Gets or sets the name of the active source elements container. This is the project name when the project property 'GroupUsage' is set to AsVisualGroupingMechanism. Otherwise it's the active group name.

Gets or sets the ActiveSourceElementsContainerName value in raw form, without name correction. This variant is the direct name without any filtering on illegal characters, and therefore isn't suitable for creating type names.

Gets or sets a value indicating whether templates which have to be compiled into .NET code have to use debug build always (true) or leave it to their own settings (false).

Gets or sets the catalogs to process with this generator

Gets the compilation results for include templates per driver id list. Values are pairs, where Value1 is the compilationresults object and Value2 is the name of the file which contains the template runner sourcecode (which was compiled and gave the compilation results stored in Value1)

Gets the compilation results for templates per driver id list. Values are pairs, where Value1 is the compilationresults object and Value2 is the name of the file which contains the template runner sourcecode (which was compiled and gave the compilation results stored in Value1)

Gets the compiled include template assembly per driver id list.

Gets the compiled template assembly per driver id.

the configuration settings of the current application instance.

Defines the cache for the whole code generation cycle. Per ActiveSourceElementsContainerNameRaw used in a code gen task, the run queue cache is stored.

Gets the destination root folder.

Gets or sets the driver ID to use to obtain meta-data from the project.

Gets / sets the entities to process with the generator.

The Language object to use

The handler of the LogLineInApplicationOutputCallBack. Setting this property will allow the generator and any task or taskgroup to log text on the application output window.

When set to true, queue processing is performed per group if applicable (i.e. on entity model tasks, and if project setting for grouping is AsSeparateProjects). When false (default), the queue is processed once.

Gets the platform to use.

The complete definition of the project to generate. All necessary data can be obtained through the project instance returned by this property. This is the actual instance of the project and not a copy, because projects can be very large and the amount of objects to copy can be very big. Tasks are not the right instrument to change project data.

Gets the retrieval procedures stored in the SPCalls set. It consults the project for meta-data and assumes a proc is valid and thus is either an action proc on all targets or a rertieval proc on all targets

Gets or sets the root derived elements to process with this generator.

Gets the root namespace to use.

The cache with key-value pairs which is accessable for all performed tasks. The cache is never cleared by task performers, and can be used to cache information across task groups which do clear the TaskCache cache.

Gets / sets the sp calls to process with the generator.

Gets the startup path of the application this generator is used in.

The handler of the SubTaskProgressInitCallBack. Setting this property will allow Start to reflect its current progress of subtasks executed within a general task in the progress viewer.

The handler of the SubTaskProgressTaskCompletedCallBack. Setting this property will allow Start to reflect its current progress of subtasks executed within a general task in the progress viewer.

The handler of the SubTaskProgressTaskStartCallBack. Setting this property will allow Start to reflect its current progress of subtasks executed within a general task in the progress viewer.

Gets the system type converters defined for this framework. Key is the Type converter instance type, value is the codeGeneratorData value specified with this type converter in the framework's .framework file.

Gets or sets the target framework holder to use for this generator

The cache with key-value pairs which is accessable for all performed tasks. The cache can be used to pass data (for example task results) to other tasks.

The handler of the TaskProgressInitCallBack. Setting this property will allow Start to reflect its current progress of general tasks in the progress viewer.

The handler of the TaskProgressTaskCompletedCallBack. Setting this property will allow Start to reflect its current progress of general tasks in the progress viewer.

The handler of the TaskProgressTaskStartCallBack. Setting this property will allow Start to reflect its current progress of general tasks in the progress viewer.

Gets the TasksResultLog lognode, which is the root node in the lognode tree to which logging is done by task performers.

The complete set of tasks to execute by the generator. Use this tree to walk through the tasks to check if a given task has been succesfully completed.

Gets the templatebindings to use, in the order in which they have to take precedence, starting with the top precedence taking templatebindings object.

Gets the template group to use.

Gets or sets the table valued function calls to process with the generator.

Gets / sets typedLists to process with the generator.

Gets / sets typedViews to process with the generator.

Gets or sets the value type definitions to process with the generator.

Gets the VS net project files created during the complete code cycle.

Adds the file pair to dependent upon files cache.

Adds the file to destination filenames cache.

Adds the list specified as obsolete files, to be deleted or moved after the runqueue has been executed.

Applies the element selection rule specified on all the elements matching its scope and filters the elements out which result in false after applying the rule. This method alters the sets of elements, so use this method in combination of PushElementSets and PopElementSets.

Clears the dependent upon files cache.

Clears the destination filenames cache.

Creates the dependent upon store in cache under the key 'dependentUponFilenames', if it's not already there. The store is a dictionary(Of string, string) which has as key the filename of the dependening file and as value the filename of the file it depents upon.

Creates the destination filenames store in cache under the key 'destinationFilenames' if it's not already there. The store is a List(Of string) object.

Deletes (or moves, if the setting is switched off) all files added as 'obsolete' and which aren't generated through this generator. Call this method after the whole runqueue has been executed.

Checks whether the driver of the driver ID current set in this generator supports the aspect specified

Gets the list of catalogs in scope of the current cycle the generator is executed for. The catalogs aren't sorted. If you want to process them in a given order a sort has to be applied after this method.

Gets the compiled include templates assembly from cache for the active driverid

Gets the compiled templates assembly from cache for the active driverid

Gets the database name of the driver associated with the driver ID currently set in this generator

Gets the database name of the driver associated with the driver ID specified

Gets the database short name of the driver associated with the driver ID currently set in this generator

Gets the database short name of the driver associated with the driver ID specified

Gets the provider specific net type name to be used for type enums for the dbtype specified for the database with the driverid set in this generator.

Gets the dependent upon filenames store from the task cache.

Gets the destination filenames store from the task cache.

Gets the driver short name for the driver associated with the driver ID currently set in this generator

Gets the driver short name for the driver associated with the driver ID specified

Gets the external type name for the type specified, if any, for the active database. It retrieves this from the target framework of the entity model, as everything derives from that. If no external type is defined for the type specified, it will return null, so the caller knows the type is to be treated as-is.

Gets the name of the template bindings the templateID has been defined in, taking into account the templateBindingsName specified and the language set)

Gets the template file contents for the templateID specified for the set platform - language. It will start with the templatebindings with the highest precedence and will choose the first templateID binding found for the platform - language combination.

Gets the template file contents for the templateID specified for the set platform - language and as specified in the templatebindings with the name specified.

Gets the template filename for the first templateID encountered in the ordered list of templatebindings

Gets the template filename for the templateID specified in the templatebindings specified.

Gets the cached unique relationship name for relationship specified. The relationship has to be in scope of the generator

Gets the value from cycle cache. It uses the runqueueCacheKey to obtain the runqueue cache and the key to obtain the value in that runqueue cache.

Gets the value from the run queue cache for the key specified. If key is null, the default for T is returned.

Pops the destination root folder from the stack. If there's just one value left, no action is performed.

Pops the element sets from internal stacks, if they were pushed onto these before using a PushElementSets call. If there are no pushed sets, this method is a no-op.

Pops the root namespace to use from the stack. If there's just one value left, no action is performed.

Produces the real attribute string to emit into the output based on the attribute string passed in and the current language specified.

Pushes the element sets onto internal stacks so they're presevered: if the sets of elements (entities, typed lists etc.) are changed, after calling this method, they can be restored by calling PopElementSets().

Pushes the new destination root folder onto the stack of destination root folders. Using this method the DestinationRootFolder is set to a new value.

Pushes the new root namespace to use onto the stack of rootnamespaces. Using this method the RootNamespaceToUse is set to a new value.

Removes the file from destination filenames cache.

Removes the file pair from dependent upon files cache, with the key fromFile

Sets the call backs to use for this generator

Starts the generation process. It executes the code generation task specified.

Stores the compilation results for include templates. Include templates are only compiled when used inside TDL templates

Stores the compilation results for compiled templates.

Stores the compiled include templates assembly in cache.

Stores the compiled templates assembly in cache.

Stores the value specified in run queue cache. If there's already a value for this key, it's overwritten.