Package org.nuiton.eugene.models.object

Interface ObjectModel

  • All Superinterfaces:
    Model, WithTagValuesOrStereotypes
    All Known Implementing Classes:
    ObjectModelImpl
    public interface ObjectModel
extends Model
    Abstraction for the root node of object model trees. This an entry point for browsing a model tree. This object offers as well several facilities for a direct access to some of the object model elements. Created: 14 janv. 2004
    Author:
    Cédric Pineau - pineau@codelutin.com

    • Method Detail

      • getPackage

        ObjectModelPackage getPackage​(String qualifiedClassifierName)
        Returns the package corresponding to the given name, or null if the model contains no package for this name.
        Parameters:
        qualifiedClassifierName - - the name of the package to retrieve.
        Returns:
        the ObjectModelPackage of the found given name, or null if the model contains no package for this name.
        Since:
        2.12

      • getPackage

        ObjectModelPackage getPackage​(ObjectModelClassifier classifier)
        Returns the package of the given classifier, or null if the model contains no package for this classifier.
        Parameters:
        classifier - the classifier of the package to retrieve.
        Returns:
        the ObjectModelPackage for the given classifier, or null if the model contains no package for this classifier.
        Since:
        2.12

      • hasPackage

        boolean hasPackage​(String name)
        Indicates whether the model contains the package associated to the given name
        Parameters:
        name - - the name of the package to retrieve.
        Returns:
        true if the package has been found.
        Since:
        2.12

      • getClassifier

        ObjectModelClassifier getClassifier​(String qualifiedClassifierName)
        Returns the classifier corresponding to the given qualified name, or null if the model contains no classifier for this qualified name.
        Parameters:
        qualifiedClassifierName - - the qualified name of the classifier to retrieve.
        Returns:
        the ObjectModelClassifier of the found classifier, or null if the model contains no classifier for this qualified name.

      • getClasses

        Collection<ObjectModelClass> getClasses()
        Returns all classes defined in this model. (Except innerClasses)
        Returns:
        a Collection containing all ObjectModelClass for this model.
        See Also:
        ObjectModelClass

      • getClass

        ObjectModelClass getClass​(String qualifiedClassName)
        Returns the class corresponding to the given qualified name, or null if the model contains no class for this qualified name.
        Parameters:
        qualifiedClassName - - the qualified name of the class to retrieve.
        Returns:
        the ObjectModelClass of the found class, or null if the model contains no class for this qualified name.

      • hasClass

        boolean hasClass​(String qualifiedClassName)
        Indicates whether the model contains the class associated to the given className
        Parameters:
        qualifiedClassName - - the qualified name of the class to retrieve.
        Returns:
        true if the class has been found.

      • getInterface

        ObjectModelInterface getInterface​(String qualifiedInterfaceName)
        Returns the interface corresponding to the given qualified name, or null if the model contains no interface for this qualified name.
        Parameters:
        qualifiedInterfaceName - the qualified name of the interface to retrieve.
        Returns:
        the ObjectModelInterface of the found interface, or null if the model contains no interface for this qualified name.

      • getEnumeration

        ObjectModelEnumeration getEnumeration​(String qualifiedEnumerationName)
        Return the enumeration corresponding to the given qualified name
        Parameters:
        qualifiedEnumerationName - the fully qualified name of the enumeration to retrieve.
        Returns:
        the ObjectModelEnumeration of the found enumeration or null if the model contains no enumeration for this qualified name.

      • getComments

        List<String> getComments()
        Returns all comments not lied to a particular model element
        Returns:
        a List containing all comments for this model as Strings.