org.modelio.api.modelio.model

Interface IDefaultNameService

public interface IDefaultNameService

Help class used when an element needs a "default" name.

Default is understood as "the name that it would have taken if you had created it through the UI in the most usual way (no smart interaction/wizard/etc)" .

The 4 main methods are:

• setDefaultName( IModelElement element ) and setDefaultName( IAbstractDiagram diagram ): the most simple ones, where you just request a name for the passed element or diagram.
  The name returned will follow the following construction: "base_name" + "postfix_counter".
  The base name is usually the metaclass name or something like that.
  The postfix counter will be an integer computed to make sure that the name returned is not already used by another element of the same type in the same parent element.
• setDefaultName( IModelElement element, String prefix ): here you additionally give a prefix to be used (default value: "copy of").
• setdefaultNameUsingBaseName( IModelElement element, String baseName ): here you give the base name to be used (in the default version, the metaclass name or something close is usually used).

Method Summary

Modifier and Type	Method and Description
void	setDefaultName(ModelElement element) Set an element default name.
void	setDefaultName(ModelElement element, java.lang.String baseName) Set an element default name.

Method Detail

setDefaultName

void setDefaultName(ModelElement element)

Set an element default name. The name is composed of an invariant radical (mostly based on the metaclass of the element) optionally followed by an integer counter to distinguish from other elements of the same type in the same container.

Parameters:

element - an element

setDefaultName

void setDefaultName(ModelElement element,
                    java.lang.String baseName)

Set an element default name. The name is composed of the given baseName as radical, optionally followed by an integer counter to distinguish from other elements of the same type in the same container.

Parameters:

element - an element

baseName - the radical to use.