com.modeliosoft.modelio.api.model

Class ObUtils

java.lang.Object

com.modeliosoft.modelio.api.model.ObUtils

Deprecated.

most of the services defined in ObUtils are now available on IModelElement.

@Deprecated
public class ObUtils
extends Object

This utility class provides several convenience methods to handle tagged values, notes stereotypes and so on... Note that methods that actually modify the model requires a valid modeling session to be used.

Structure Diagram

Method Summary

Methods

Modifier and Type	Method and Description
static void	addStereotype(IModelingSession session, IModelElement element, String type) Deprecated.
static String	getNoteContent(IModelElement element, String type) Deprecated.
static ObList<IAssociationEnd>	getOppositeEnds(IAssociationEnd assocEnd) Deprecated.
static ITaggedValue	getTag(IModelElement element, String type) Deprecated.
static String	getTagValue(IModelElement element, String type) Deprecated.
static List<String>	getTagValues(IModelElement element, String type) Deprecated.
static boolean	isTagged(IModelElement element, String type) Deprecated.
static void	putNoteContent(IModelingSession session, IModelElement element, String type, String content) Deprecated.
static void	putTagValues(IModelingSession session, IModelElement element, String type, List<String> values) Deprecated.
static void	removeNote(IModelingSession session, IModelElement element, String noteType) Deprecated.
static void	removeStereotype(IModelingSession session, IModelElement element, String type) Deprecated.
static void	removeTag(IModelingSession session, IModelElement element, String type) Deprecated.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

addStereotype

@Deprecated
public static void addStereotype(IModelingSession session,
                            IModelElement element,
                            String type)
                          throws StereotypeNotFoundException

Deprecated.

This operation adds the stereotype having this name to the given element.

Parameters:

session - the modeling session used to look for the stereotype.

element - IModelElement on which the stereotype is added.

type - The stereotype name.

Throws:

StereotypeNotFoundException - if the stereotype is not known.

getNoteContent

@Deprecated
public static String getNoteContent(IModelElement element,
                               String type)

Deprecated.

This operation returns the content of the first note with the given type on the <element> IModelElement.

Parameters:

element - IModelElement on which the note is search for.

type - The note type name.

Returns:

The note or null if the note can't be found.

getOppositeEnds

@Deprecated
public static ObList<IAssociationEnd> getOppositeEnds(IAssociationEnd assocEnd)

Deprecated.

Get the opposite ends of the association related to the given association end.

Parameters:

assocEnd - The association end where we start from.

Returns:

The list of the opposite ends of the association. This list is not modifable.

getTag

@Deprecated
public static ITaggedValue getTag(IModelElement element,
                             String type)

Deprecated.

This operation returns the tagged value with the corresponding type.

Parameters:

element - IModelElement on which the tagged value is search for.

type - The tagged value type name

Returns:

The tag or null if it can't be found

getTagValue

@Deprecated
public static String getTagValue(IModelElement element,
                            String type)

Deprecated.

This operation returns the first parameter value of the tagged value with the given type on the <element> IModelElement.

Parameters:

element - IModelElement on which the tagged value is search for.

type - The tagged value type name

Returns:

null if no tag can be found or there are no parameters, otherwise the first parameter value.

getTagValues

@Deprecated
public static List<String> getTagValues(IModelElement element,
                                   String type)

Deprecated.

This operation returns the parameter values of the tagged value with the given type on the <element> IModelElement.

Parameters:

element - IModelElement on which the tagged value is search for.

type - The tagged value type name

Returns:

null if no tag can be found or there are no parameters, otherwise the parameter list

isTagged

@Deprecated
public static boolean isTagged(IModelElement element,
                          String type)

Deprecated.

This operation returns 'true' if the element has a tagged value with the corresponding type.

Parameters:

element - IModelElement on which the tagged value is search for.

type - The tagged value type name

Returns:

'true' if the element has a tagged value with the corresponding type.

putNoteContent

@Deprecated
public static void putNoteContent(IModelingSession session,
                             IModelElement element,
                             String type,
                             String content)
                           throws NoteTypeNotFoundException

Deprecated.

Set the content of the first note with the given type on the <element> IModelElement.

If no note with the given type is found one is created.

Parameters:

session - the modeling session used to create the note if it does not exist.

element - IModelElement on which the note is search for.

type - The note type name.

content - the note content

Throws:

NoteTypeNotFoundException - If the note type is not known.

putTagValues

@Deprecated
public static void putTagValues(IModelingSession session,
                           IModelElement element,
                           String type,
                           List<String> values)
                         throws TagTypeNotFoundException

Deprecated.

This operation sets the parameters of the tagged value with the given type on the <element> IModelElement.
The tagged value and the parameter are created if they don't exist.
If values is null or empty the existing tag is deleted.

Parameters:

session - the modeling session used to create the tagged value if it does not exist.

element - IModelElement on which the tagged value is created or updated.

type - The tagged value type name.

values - The values to store on the tag parameters. If values is null or empty the tag is deleted.

Throws:

TagTypeNotFoundException - thrown when no tag type with the given name exists on the element's metaclass.

removeNote

@Deprecated
public static void removeNote(IModelingSession session,
                         IModelElement element,
                         String noteType)

Deprecated.

This operation deletes the note having this noteType from the given element.

Parameters:

session - the modeling session.

element - IModelElement on which the note is removed.

noteType - The note type

removeStereotype

@Deprecated
public static void removeStereotype(IModelingSession session,
                               IModelElement element,
                               String type)
                             throws StereotypeNotFoundException

Deprecated.

This operation removes the stereotype having this name from the given element.

Parameters:

session - the modeling session.

element - IModelElement on which the stereotype is removed.

type - The stereotype name.

Throws:

StereotypeNotFoundException - if the stereotype is not known.

removeTag

@Deprecated
public static void removeTag(IModelingSession session,
                        IModelElement element,
                        String type)

Deprecated.

This operation deletes the tagged value having this type from the given element.

Parameters:

session - the modeling session.

element - IModelElement on which the tagged value is removed.

type - The tagged value type name