Namespace: Consultingwerk.Studio.ClassDocumentation
Class 
ClassRelationProvider Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.Studio.ClassDocumentation.ClassRelationProvider

Inherits: Progress.Lang.Object
Implements: Consultingwerk.Studio.ClassDocumentation.IClassRelationProvider

File:ClassRelationProvider
Purpose:Provides information about relations between classes
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Wed Jul 02 21:32:00 CEST 2014

Navigate to: Methods | Constructors | Events | Properties



Top Method Summary
Options Name Purpose
+ Consultingwerk.Framework.Collections.CharacterList GetChildClasses (character) Returns the List of Child Classes of the given parent class
# GetChildClasses (character, CharacterList) Recursively looks for child classes and adds them to the list
+ Consultingwerk.Framework.Collections.CharacterList GetImplementingClasses (character) Returns the List of Classes implementing the given interface
# GetImplementingClasses (character, CharacterList) Recursively looks for classes implementing the Interface and adds them to the list

Top Constructor Summary
Options Name Purpose
+ ClassRelationProvider (IDocumentWriterParameter) Constructor for the ClassRelationProvider class


Method Detail
Top

PUBLIC Consultingwerk.Framework.Collections.CharacterList GetChildClasses (character)
Purpose: Returns the List of Child Classes of the given parent class
Notes: Returns direct and indirect child classes

Parameters:
pcParentClass CHARACTER
The name of the parent class
Returns Consultingwerk.Framework.Collections.CharacterList
The CharacterList of Child Classes
Top

PROTECTED GetChildClasses (character, CharacterList)
Purpose: Recursively looks for child classes and adds them to the list
Notes:

Parameters:
pcParentClass CHARACTER
The current parent class
poList Consultingwerk.Framework.Collections.CharacterList
The CharacterList to add the child classes to
Top

PUBLIC Consultingwerk.Framework.Collections.CharacterList GetImplementingClasses (character)
Purpose: Returns the List of Classes implementing the given interface
Notes: Returns direct and indirect child classes

Parameters:
pcInterfaceName CHARACTER
The name of the interface
Returns Consultingwerk.Framework.Collections.CharacterList
The CharacterList of Child Classes
Top

PROTECTED GetImplementingClasses (character, CharacterList)
Purpose: Recursively looks for classes implementing the Interface and adds
them to the list
Notes:

Parameters:
pcInterfaceName CHARACTER
The name of the interface
poList Consultingwerk.Framework.Collections.CharacterList
The CharacterList to add the child classes to


Constructor Detail
Top

PUBLIC ClassRelationProvider (IDocumentWriterParameter)
Purpose: Constructor for the ClassRelationProvider class
Notes: Initializes the temp-table with the class relation data from the
class doc XML files

Parameters:
poParameter Consultingwerk.Studio.ClassDocumentation.IDocumentWriterParameter
The parameter object control the output


©2006-2016 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       26.08.2016 08:45:04