com.ibm.xtools.uml.core

Interface IUMLHelper

public interface IUMLHelper

Set of UML related helper functions

Note: Not to be implemented

This interface is not intended to be implemented by clients.

Note: Not to be extended

This interface is not intended to be extended by clients.

Method Summary

Modifier and Type	Method and Description
org.eclipse.uml2.uml.Element	findElement(org.eclipse.uml2.uml.Element root, java.lang.String id) Finds elements whose ID matches exactly the specified id.
org.eclipse.uml2.uml.Element	findElement(org.eclipse.uml2.uml.Element root, java.lang.String id, org.eclipse.core.runtime.IProgressMonitor monitor) Finds elements whose ID matches exactly the specified id.
org.eclipse.uml2.uml.Element	findElementById(org.eclipse.uml2.uml.Model model, java.lang.String id) Deprecated. Since 7.5, use the findElement(Element, String, IProgressMonitor) method, instead.
org.eclipse.uml2.uml.Element	findElementById(org.eclipse.uml2.uml.Model model, java.lang.String id, org.eclipse.core.runtime.IProgressMonitor monitor) Deprecated. Since 7.5, use the findElement(Element, String, IProgressMonitor) method, instead.
java.util.Set<org.eclipse.uml2.uml.Element>	findElementByName(org.eclipse.uml2.uml.Element container, java.lang.String name, org.eclipse.emf.ecore.EClass type, org.eclipse.core.runtime.IProgressMonitor monitor) Finds the UML Element whose name and type match exactly the specified name and type respectively.
java.lang.String	getAlias(org.eclipse.uml2.uml.NamedElement element) Gets the alias of the named element, or empty string if the element does not have an alias.
void	setAlias(org.eclipse.uml2.uml.NamedElement element, java.lang.String alias) Sets the alias of the element.

Method Detail

findElementById

@Deprecated
org.eclipse.uml2.uml.Element findElementById(org.eclipse.uml2.uml.Model model,
                                                          java.lang.String id)

Deprecated. Since 7.5, use the findElement(Element, String, IProgressMonitor) method, instead.

Finds elements whose ID matches exactly the specified id. The search is performed in the model specified by model

Parameters:

model - The UML model where to perform the search

id - The ID of the UML element to match

Returns:

The UML element with the specified id, null if not found

Throws:

java.lang.IllegalArgumentException - is is an empty string

java.lang.ClassCastException - is if the element associated with the specified id is not a UML Element

See Also:

com.ibm.xtools.emf.index.search.IIndexSearchManager

findElement

org.eclipse.uml2.uml.Element findElement(org.eclipse.uml2.uml.Element root,
                                         java.lang.String id)

Finds elements whose ID matches exactly the specified id. The search is performed in the model specified by model

Parameters:

root - The UML model where to perform the search

id - The ID of the UML element to match

Returns:

The UML element with the specified id, null if not found

Throws:

java.lang.IllegalArgumentException - is is an empty string

java.lang.ClassCastException - is if the element associated with the specified id is not a UML Element

Since:

7.5

See Also:

com.ibm.xtools.emf.index.search.IIndexSearchManager

findElementById

@Deprecated
org.eclipse.uml2.uml.Element findElementById(org.eclipse.uml2.uml.Model model,
                                                          java.lang.String id,
                                                          org.eclipse.core.runtime.IProgressMonitor monitor)
                                                   throws java.lang.InterruptedException

Deprecated. Since 7.5, use the findElement(Element, String, IProgressMonitor) method, instead.

Finds elements whose ID matches exactly the specified id. The search is performed in the model model resource specified by its root element.

Parameters:

model - The UML model where to perform the search

id - The ID of the UML element to match

monitor - The monitor to use to display progress and/or cancel operation

Returns:

The UML element with the specified id, null if not found

Throws:

java.lang.IllegalArgumentException - name is an empty string or type is not a UML2 type

java.lang.InterruptedException - The query operation was interrupted

java.lang.ClassCastException - is if the element associated with the specified id is not a UML Element

See Also:

com.ibm.xtools.emf.index.search.IIndexSearchManager

findElement

org.eclipse.uml2.uml.Element findElement(org.eclipse.uml2.uml.Element root,
                                         java.lang.String id,
                                         org.eclipse.core.runtime.IProgressMonitor monitor)
                                  throws java.lang.InterruptedException

Finds elements whose ID matches exactly the specified id. The search is performed in the model resource specified by its root element.

Parameters:

root - The root of the UML model where to perform the search

id - The ID of the UML element to match

monitor - The monitor to use to display progress and/or cancel operation

Returns:

The UML element with the specified id, null if not found

Throws:

java.lang.IllegalArgumentException - name is an empty string or type is not a UML2 type

java.lang.InterruptedException - The query operation was interrupted

java.lang.ClassCastException - is if the element associated with the specified id is not a UML Element

Since:

7.5

See Also:

com.ibm.xtools.emf.index.search.IIndexSearchManager

findElementByName

java.util.Set<org.eclipse.uml2.uml.Element> findElementByName(org.eclipse.uml2.uml.Element container,
                                                              java.lang.String name,
                                                              org.eclipse.emf.ecore.EClass type,
                                                              org.eclipse.core.runtime.IProgressMonitor monitor)
                                                       throws java.lang.InterruptedException

Finds the UML Element whose name and type match exactly the specified name and type respectively. The search begins at the element specified by container and recurses within its owned elements

Parameters:

container - The root Element where to perform the search

name - The name of the Element to match

type - The type of the Element to match

monitor - The monitor to use to display progress and/or cancel operation

Returns:

The set of Element matching the specified criteria

Throws:

java.lang.InterruptedException - The query operation was interrupted

java.lang.IllegalArgumentException - name is an empty string or type is not a UML2 type

java.lang.NullPointerException - One of the passed parameters was null

See Also:

com.ibm.xtools.emf.index.search.IIndexSearchManager

getAlias

java.lang.String getAlias(org.eclipse.uml2.uml.NamedElement element)

Gets the alias of the named element, or empty string if the element does not have an alias.

Parameters:

element - The NamedElement to get the alias for

Returns:

The element alias

setAlias

void setAlias(org.eclipse.uml2.uml.NamedElement element,
              java.lang.String alias)

Sets the alias of the element. The element's alias will be removed if the supplied alias parameter String is null or empty.

Parameters:

element - The element for which the alias is to be changed

alias - The alias to be set