C# Класс TSF.UmlToolingFramework.Wrappers.EA.Model

Наследование: TSF.UmlToolingFramework.UML.UMLModel
Показать файл Открыть проект Примеры использования класса

Открытые методы

Метод Описание
Model ( ) : System
Model ( global eaRepository ) : System
SQLQuery ( string sqlQuery ) : XmlDocument
addTab ( string title, string fullControlName ) : UserControl
addTaggedValueType ( string tagName, string tagDescription, string tagDetail ) : void
addWindow ( string title, string fullControlName ) : UserControl
adviseChange ( TSF.UmlToolingFramework.UML element ) : void
escapeSQLString ( string sqlString ) : string

escapes a literal string so it can be inserted using sql

executeSQL ( string SQLString ) : void
formatXPath ( string xpath ) : string

formats an xpath accordign to the type of database. For Oracle and Firebird it should be ALL CAPS

getAttributeByID ( int attributID ) : Attribute

gets the Attribute with the given ID

getAttributeTagByGUID ( string GUID ) : AttributeTag
getAttributeTagsWithValue ( string value ) : List
getAttributeWrapperByGUID ( string GUID ) : AttributeWrapper

gets the Attribute with the given GUID

getAttributesByQuery ( string SQLQuery ) : List
getCurrentRootPackage ( ) : TSF.UmlToolingFramework.UML.Classes.Kernel.Package
getDiagramByGUID ( string diagramGUID ) : Diagram
getDiagramByID ( int diagramID ) : Diagram
getDiagramsByQuery ( string sqlGetDiagrams ) : List
getElementByGUID ( string GUIDstring ) : TSF.UmlToolingFramework.UML.Classes.Kernel.Element
getElementTagByGUID ( string GUID ) : ElementTag
getElementTagsWithValue ( string value ) : HashSet
getElementWrapperByGUID ( string GUID ) : ElementWrapper

Finds the EA.Element with the given GUID and returns an EAElementwrapper wrapping this element.

getElementWrapperByID ( int id ) : ElementWrapper
getElementWrapperByPackageID ( int packageID ) : ElementWrapper
getElementWrappersByQuery ( string sqlQuery ) : List

returns the elementwrappers that are identified by the Object_ID's returned by the given query

getItemFromFQN ( string FQN ) : TSF.UmlToolingFramework.UML.Extended.UMLItem
getItemFromGUID ( string guidString ) : TSF.UmlToolingFramework.UML.Extended.UMLItem

finds the item with the given guid

getOperationByGUID ( string guid ) : Operation
getOperationByID ( int operationID ) : Operation
getOperationTagByGUID ( string GUID ) : OperationTag
getOperationTagsWithValue ( string value ) : List
getOperationsByQuery ( string SQLQuery ) : List
getParameterByGUID ( string GUID ) : ParameterWrapper

gets the parameter by its GUID. This is a tricky one since EA doesn't provide a getParameterByGUID operation we have to first get the operation, then loop the pamarameters to find the one with the GUID

getParameterTagByGUID ( string GUID ) : ParameterTag
getParameterTagsWithValue ( string value ) : List
getParametersByQuery ( string SQLQuery ) : List
getQuickSearchResults ( string searchText, int maxResults, bool elements, bool operations, bool attributes, bool diagrams ) : List

returns the first [maxresults] items who's name starts with the given searchText

getRelationByGUID ( string relationGUID ) : ConnectorWrapper
getRelationByID ( int relationID ) : ConnectorWrapper
getRelationTagByGUID ( string GUID ) : RelationTag
getRelationTagsWithValue ( string value ) : List
getRelationsByQuery ( string SQLQuery ) : List
getRepositoryType ( ) : RepositoryType

Gets the Repository type for this model

getRoootPackage ( TSF.UmlToolingFramework.UML item ) : RootPackage
getTaggedValuesWithValue ( string value ) : HashSet
getUserSelectedElement ( List allowedTypes ) : TSF.UmlToolingFramework.UML.Classes.Kernel.Element

Lets the user select an element from the model and return that

getUserSelectedPackage ( ) : TSF.UmlToolingFramework.UML.Classes.Kernel.Package

Show a dialog to the user that allows him to select a package from the model

initialize ( global eaRepository ) : void

(re)initialises this model with the given ea repository object

openProperties ( TSF.UmlToolingFramework.UML item ) : void

opens the properties dialog for this item

refreshDiagram ( Diagram diagram ) : void
reloadDiagrams ( ) : void

reload the open diagrams

saveDiagram ( TSF.UmlToolingFramework.UML diagram ) : void
saveElement ( TSF.UmlToolingFramework.UML element ) : void
saveOpenedDiagram ( TSF.UmlToolingFramework.UML diagram ) : void

saves unsaved changes to an opened diagram

selectDiagram ( Diagram diagram ) : void
showTab ( string title ) : void
showWindow ( string title ) : void
taggedValueTypeExists ( string tagName ) : bool

checks if a tagged value type with the given name exists in the current model

toArrayList ( IEnumerable collection ) : ArrayList
toObject ( object someObject ) : Object

Приватные методы

Метод Описание
convertFromEANotes ( string EANotes, string newFormat ) : string
convertToEANotes ( string externalNotes, string externalFormat ) : string
formatSQL ( string sqlQuery ) : string

sets the correct wildcards depending on the database type. changes '%' into '*' if on ms access and _ into ? on msAccess

formatSQLFunctions ( string sqlQuery ) : string

Operation to translate SQL functions in there equivalents in different sql syntaxes supported functions: - lcase -> lower in T-SQL (SQLSVR and ASA)

formatSQLTop ( string sqlQuery ) : string

limiting the number of results in an sql query is different on different platforms. "SELECT TOP N" is used on SQLSVR ADOJET ASA OPENEDGE ACCESS2007 "WHERE rowcount <= N" is used on ORACLE "LIMIT N" is used on MYSQL POSTGRES This operation will replace the SELECT TOP N by the appropriate sql syntax depending on the repositorytype

replaceSQLWildCards ( string sqlQuery ) : string

replace the wildcards in the given sql query string to match either MSAccess or ANSI syntax

Описание методов

Model() публичный Метод

public Model ( ) : System
Результат System

Model() публичный Метод

public Model ( global eaRepository ) : System
eaRepository global
Результат System

SQLQuery() публичный Метод

public SQLQuery ( string sqlQuery ) : XmlDocument
sqlQuery string
Результат System.Xml.XmlDocument

addTab() публичный Метод

public addTab ( string title, string fullControlName ) : UserControl
title string
fullControlName string
Результат System.Windows.Forms.UserControl

addTaggedValueType() публичный Метод

public addTaggedValueType ( string tagName, string tagDescription, string tagDetail ) : void
tagName string
tagDescription string
tagDetail string
Результат void

addWindow() публичный Метод

public addWindow ( string title, string fullControlName ) : UserControl
title string
fullControlName string
Результат System.Windows.Forms.UserControl

adviseChange() публичный Метод

public adviseChange ( TSF.UmlToolingFramework.UML element ) : void
element TSF.UmlToolingFramework.UML
Результат void

escapeSQLString() публичный Метод

escapes a literal string so it can be inserted using sql
public escapeSQLString ( string sqlString ) : string
sqlString string the string to be escaped
Результат string

executeSQL() публичный Метод

public executeSQL ( string SQLString ) : void
SQLString string
Результат void

formatXPath() публичный Метод

formats an xpath accordign to the type of database. For Oracle and Firebird it should be ALL CAPS
public formatXPath ( string xpath ) : string
xpath string the xpath to format
Результат string

getAttributeByID() публичный Метод

gets the Attribute with the given ID
public getAttributeByID ( int attributID ) : Attribute
attributID int the attribute's ID
Результат Attribute

getAttributeTagByGUID() публичный Метод

public getAttributeTagByGUID ( string GUID ) : AttributeTag
GUID string
Результат AttributeTag

getAttributeTagsWithValue() публичный Метод

public getAttributeTagsWithValue ( string value ) : List
value string
Результат List

getAttributeWrapperByGUID() публичный Метод

gets the Attribute with the given GUID
public getAttributeWrapperByGUID ( string GUID ) : AttributeWrapper
GUID string the attribute's GUID
Результат AttributeWrapper

getAttributesByQuery() публичный Метод

public getAttributesByQuery ( string SQLQuery ) : List
SQLQuery string
Результат List

getCurrentRootPackage() публичный Метод

public getCurrentRootPackage ( ) : TSF.UmlToolingFramework.UML.Classes.Kernel.Package
Результат TSF.UmlToolingFramework.UML.Classes.Kernel.Package

getDiagramByGUID() публичный Метод

public getDiagramByGUID ( string diagramGUID ) : Diagram
diagramGUID string
Результат Diagram

getDiagramByID() публичный Метод

public getDiagramByID ( int diagramID ) : Diagram
diagramID int
Результат Diagram

getDiagramsByQuery() публичный Метод

public getDiagramsByQuery ( string sqlGetDiagrams ) : List
sqlGetDiagrams string
Результат List

getElementByGUID() публичный Метод

public getElementByGUID ( string GUIDstring ) : TSF.UmlToolingFramework.UML.Classes.Kernel.Element
GUIDstring string
Результат TSF.UmlToolingFramework.UML.Classes.Kernel.Element

getElementTagByGUID() публичный Метод

public getElementTagByGUID ( string GUID ) : ElementTag
GUID string
Результат ElementTag

getElementTagsWithValue() публичный Метод

public getElementTagsWithValue ( string value ) : HashSet
value string
Результат HashSet

getElementWrapperByGUID() публичный Метод

Finds the EA.Element with the given GUID and returns an EAElementwrapper wrapping this element.
public getElementWrapperByGUID ( string GUID ) : ElementWrapper
GUID string the GUID of the element
Результат ElementWrapper

getElementWrapperByID() публичный Метод

public getElementWrapperByID ( int id ) : ElementWrapper
id int
Результат ElementWrapper

getElementWrapperByPackageID() публичный Метод

public getElementWrapperByPackageID ( int packageID ) : ElementWrapper
packageID int
Результат ElementWrapper

getElementWrappersByQuery() публичный Метод

returns the elementwrappers that are identified by the Object_ID's returned by the given query
public getElementWrappersByQuery ( string sqlQuery ) : List
sqlQuery string query returning the Object_ID's
Результат List

getItemFromFQN() публичный Метод

public getItemFromFQN ( string FQN ) : TSF.UmlToolingFramework.UML.Extended.UMLItem
FQN string
Результат TSF.UmlToolingFramework.UML.Extended.UMLItem

getItemFromGUID() публичный Метод

finds the item with the given guid
public getItemFromGUID ( string guidString ) : TSF.UmlToolingFramework.UML.Extended.UMLItem
guidString string the string with the guid
Результат TSF.UmlToolingFramework.UML.Extended.UMLItem

getOperationByGUID() публичный Метод

public getOperationByGUID ( string guid ) : Operation
guid string
Результат Operation

getOperationByID() публичный Метод

public getOperationByID ( int operationID ) : Operation
operationID int
Результат Operation

getOperationTagByGUID() публичный Метод

public getOperationTagByGUID ( string GUID ) : OperationTag
GUID string
Результат OperationTag

getOperationTagsWithValue() публичный Метод

public getOperationTagsWithValue ( string value ) : List
value string
Результат List

getOperationsByQuery() публичный Метод

public getOperationsByQuery ( string SQLQuery ) : List
SQLQuery string
Результат List

getParameterByGUID() публичный Метод

gets the parameter by its GUID. This is a tricky one since EA doesn't provide a getParameterByGUID operation we have to first get the operation, then loop the pamarameters to find the one with the GUID
public getParameterByGUID ( string GUID ) : ParameterWrapper
GUID string the parameter's GUID
Результат ParameterWrapper

getParameterTagByGUID() публичный Метод

public getParameterTagByGUID ( string GUID ) : ParameterTag
GUID string
Результат ParameterTag

getParameterTagsWithValue() публичный Метод

public getParameterTagsWithValue ( string value ) : List
value string
Результат List

getParametersByQuery() публичный Метод

public getParametersByQuery ( string SQLQuery ) : List
SQLQuery string
Результат List

getQuickSearchResults() публичный Метод

returns the first [maxresults] items who's name starts with the given searchText
public getQuickSearchResults ( string searchText, int maxResults, bool elements, bool operations, bool attributes, bool diagrams ) : List
searchText string the first part of the name to match
maxResults int the number of results required
elements bool indicates whether elements should be selected
operations bool indicates whether operations should be selected
attributes bool indicates whether attributes should be selected
diagrams bool indicates whether diagrams should be selected
Результат List

getRelationByGUID() публичный Метод

public getRelationByGUID ( string relationGUID ) : ConnectorWrapper
relationGUID string
Результат ConnectorWrapper

getRelationByID() публичный Метод

public getRelationByID ( int relationID ) : ConnectorWrapper
relationID int
Результат ConnectorWrapper

getRelationTagByGUID() публичный Метод

public getRelationTagByGUID ( string GUID ) : RelationTag
GUID string
Результат RelationTag

getRelationTagsWithValue() публичный Метод

public getRelationTagsWithValue ( string value ) : List
value string
Результат List

getRelationsByQuery() публичный Метод

public getRelationsByQuery ( string SQLQuery ) : List
SQLQuery string
Результат List

getRepositoryType() публичный Метод

Gets the Repository type for this model
public getRepositoryType ( ) : RepositoryType
Результат RepositoryType

getRoootPackage() публичный Метод

public getRoootPackage ( TSF.UmlToolingFramework.UML item ) : RootPackage
item TSF.UmlToolingFramework.UML
Результат RootPackage

getTaggedValuesWithValue() публичный Метод

public getTaggedValuesWithValue ( string value ) : HashSet
value string
Результат HashSet

getUserSelectedElement() публичный Метод

Lets the user select an element from the model and return that
public getUserSelectedElement ( List allowedTypes ) : TSF.UmlToolingFramework.UML.Classes.Kernel.Element
allowedTypes List the subtypes of UML.Classes.Kernel.Element that should be used as a filter
Результат TSF.UmlToolingFramework.UML.Classes.Kernel.Element

getUserSelectedPackage() публичный Метод

Show a dialog to the user that allows him to select a package from the model
public getUserSelectedPackage ( ) : TSF.UmlToolingFramework.UML.Classes.Kernel.Package
Результат TSF.UmlToolingFramework.UML.Classes.Kernel.Package

initialize() публичный Метод

(re)initialises this model with the given ea repository object
public initialize ( global eaRepository ) : void
eaRepository global the ea repository object
Результат void

openProperties() публичный Метод

opens the properties dialog for this item
public openProperties ( TSF.UmlToolingFramework.UML item ) : void
item TSF.UmlToolingFramework.UML the item to open the properties dialog for
Результат void

refreshDiagram() публичный Метод

public refreshDiagram ( Diagram diagram ) : void
diagram Diagram
Результат void

reloadDiagrams() публичный Метод

reload the open diagrams
public reloadDiagrams ( ) : void
Результат void

saveDiagram() публичный Метод

public saveDiagram ( TSF.UmlToolingFramework.UML diagram ) : void
diagram TSF.UmlToolingFramework.UML
Результат void

saveElement() публичный Метод

public saveElement ( TSF.UmlToolingFramework.UML element ) : void
element TSF.UmlToolingFramework.UML
Результат void

saveOpenedDiagram() публичный Метод

saves unsaved changes to an opened diagram
public saveOpenedDiagram ( TSF.UmlToolingFramework.UML diagram ) : void
diagram TSF.UmlToolingFramework.UML the diagram that is currently opened
Результат void

selectDiagram() публичный Метод

public selectDiagram ( Diagram diagram ) : void
diagram Diagram
Результат void

showTab() публичный Метод

public showTab ( string title ) : void
title string
Результат void

showWindow() публичный Метод

public showWindow ( string title ) : void
title string
Результат void

taggedValueTypeExists() публичный Метод

checks if a tagged value type with the given name exists in the current model
public taggedValueTypeExists ( string tagName ) : bool
tagName string the name of the tagged value type
Результат bool

toArrayList() публичный Метод

public toArrayList ( IEnumerable collection ) : ArrayList
collection IEnumerable
Результат ArrayList

toObject() публичный Метод

public toObject ( object someObject ) : Object
someObject object
Результат Object