org.modelio.api.modelio.mc

Class DefaultModelComponentContributor

java.lang.Object

org.modelio.api.modelio.mc.AbstractModelComponentContributor

org.modelio.api.modelio.mc.DefaultModelComponentContributor

public class DefaultModelComponentContributor
extends AbstractModelComponentContributor

Default implementation of the IModelComponentContributor interface.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Set<ExportedFileEntry>	files

Constructor Summary

Constructors

Constructor and Description
DefaultModelComponentContributor(IModule module) Default constructor, initializing all fields.

Method Summary

Modifier and Type	Method and Description
void	addDependencyStereotype(Stereotype stereotype) Return the set of dependency stereotypes that must be added to a model component.
void	addElement(MObject element) Adds a model element that must be added to a model component.
void	addFiles(java.lang.String exportedFile, java.lang.String exportRelativePath) Adds a file path to the set of files path that must be added to a model component.
void	addNoteType(NoteType noteType) Adds a note type to the set of note types that must be added to a model component.
void	addTagType(TagType tagType) Adds a tagged value to the set of tagged value types that must be added to a model component.
java.util.Set<Stereotype>	getDependencyStereotypes() Return the set of dependency stereotypes that must be added to a model component.
java.util.Set<MObject>	getElements() Return the set of Elements that must be added to a model component.
java.util.Set<ExportedFileEntry>	getFiles() Return the set of files path that must be added to a model component.
java.util.Set<NoteType>	getNoteTypes() Return the set of note types that must be added to a model component.
java.util.Set<TagType>	getTagTypes() Return the set of tagged value types that must be added to a model component.

Methods inherited from class org.modelio.api.modelio.mc.AbstractModelComponentContributor

getModule

Methods inherited from class java.lang.Object

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

Field Detail

files

protected java.util.Set<ExportedFileEntry> files

Constructor Detail

DefaultModelComponentContributor

public DefaultModelComponentContributor(IModule module)

Default constructor, initializing all fields.

Parameters:

module - the module contibuting to the model component.

Method Detail

addDependencyStereotype

public void addDependencyStereotype(Stereotype stereotype)

Return the set of dependency stereotypes that must be added to a model component.

Only dependencies that own one of the stereotype of the set will be exported in the model component.

Parameters:

stereotype - the stereotype to add

addFiles

public void addFiles(java.lang.String exportedFile,
                     java.lang.String exportRelativePath)

Adds a file path to the set of files path that must be added to a model component.

The provided paths must be relative to the project path. If the provided path does not match a file in the project, it will be ignored.

Parameters:

exportedFile - the file to package in the model component.

exportRelativePath - the path to deploy the file into.

addNoteType

public void addNoteType(NoteType noteType)

Adds a note type to the set of note types that must be added to a model component.

Parameters:

noteType - the note type to add

addTagType

public void addTagType(TagType tagType)

Adds a tagged value to the set of tagged value types that must be added to a model component.

Parameters:

tagType - the type to add

getDependencyStereotypes

public java.util.Set<Stereotype> getDependencyStereotypes()

Return the set of dependency stereotypes that must be added to a model component.

The Strings returned by the method are the names of the stereotypes that extends the Dependency link. Only dependencies that own one of the stereotype of the set will be exported in the model component.

Returns:

a set of String representing the stereotype names.

getElements

public java.util.Set<MObject> getElements()

Return the set of Elements that must be added to a model component.

Returns:

a set of elements

getFiles

public java.util.Set<ExportedFileEntry> getFiles()

Return the set of files path that must be added to a model component.

The provided paths must be relative to the project path. If the provided path does not match a file in the project, it will be ignored.

Returns:

a set of relative paths

getNoteTypes

public java.util.Set<NoteType> getNoteTypes()

Return the set of note types that must be added to a model component.

Returns:

a set of String representing the note type names.

getTagTypes

public java.util.Set<TagType> getTagTypes()

Return the set of tagged value types that must be added to a model component.

Returns:

a set of String representing the tagged value type names.

addElement

public void addElement(MObject element)

Adds a model element that must be added to a model component.

Parameters:

element - the model element to add.

Since:

3.6