Class EAAnnotations


  • public class EAAnnotations
    extends java.lang.Object
    This Class is used to Manage the Enterprise Architect Extensions
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String READER_ANNOTATION_ISAUTOGENERATED
      Represents the category called ea.reader.autogenerated for Extensions created when parsing an Enterprise Architect model
      static java.lang.String READER_ANNOTATION_ISIMPLICITCLASS
      Represents the category called ea.reader.implicitclass for Extensions created when parsing an Enterprise Architect model
      static java.lang.String READER_CATEGORY
      Represents the category called ea.reader.autogenerated for Extensions created when parsing an Enterprise Architect model
      static java.lang.String READER_COMMENT_ISDOCUMENTATION
      Represents the category called ea.reader.isDocumentation for Extensions created when parsing an Enterprise Architect model Valuated to True if the annotated Comment is generated from the documentation of an Element False otherwise
      static java.lang.String READER_EA_VERSION
      Represents the version of Enterprise Architect used to export the XMI.
      static java.lang.String READER_PROFILE_NSPREFIX
      Represents the category called ea.reader.nsPrefix for Extensions created when parsing an Enterprise Architect model
      static java.lang.String READER_REFERENCE_ISOWNEDBY
      Represents the category called ea.reader.isownedby for Extensions created when parsing an Enterprise Architect model
      static java.lang.String ROOT_ANNOTATION_SOURCE
      Represents the category of Extensions created when parsing an Enterprise Architect model
      static java.lang.String WRITER_ANNOTATION_IS_ASSOCIATION_END
      Represents the category called ea.writer.associationEnd for Extensions created when parsing an Enterprise Architect model
      static java.lang.String WRITER_CATEGORY
      Represents the category called ea.writer.category for Extensions created when parsing an Enterprise Architect model
      static java.lang.String WRITER_REFERENCE_REALIZEDBY
      Represents the category called ea.writer.realizedBy for Extensions created when parsing an Enterprise Architect model
    • Constructor Summary

      Constructors 
      Constructor Description
      EAAnnotations()  
    • Method Summary

      All Methods Static Methods Concrete Methods Deprecated Methods 
      Modifier and Type Method Description
      static java.util.Properties getProperties​(MDWObject eaObject, java.lang.String category)
      Returns the Properties values for the specified eaObject and category.
      static java.lang.String getProperty​(MDWObject eaObject, java.lang.String qualifiedProperty)
      Returns the Property value for the specified eaObject and qualified Property
      static void setProperty​(MDWObject eaObject, java.lang.String category, java.lang.String key, java.lang.String value)
      Creates an EAnnotation on an MDWorkbench Object
      static void setReference​(MDWObject eaObject, java.lang.String category, java.lang.String key, org.eclipse.emf.ecore.EObject value)
      Deprecated.
      This method will be removed in a future release
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Field Detail

      • ROOT_ANNOTATION_SOURCE

        public static final java.lang.String ROOT_ANNOTATION_SOURCE
        Represents the category of Extensions created when parsing an Enterprise Architect model
        See Also:
        Constant Field Values
      • READER_CATEGORY

        public static final java.lang.String READER_CATEGORY
        Represents the category called ea.reader.autogenerated for Extensions created when parsing an Enterprise Architect model
        See Also:
        Constant Field Values
      • READER_COMMENT_ISDOCUMENTATION

        public static final java.lang.String READER_COMMENT_ISDOCUMENTATION
        Represents the category called ea.reader.isDocumentation for Extensions created when parsing an Enterprise Architect model Valuated to True if the annotated Comment is generated from the documentation of an Element False otherwise
        See Also:
        Constant Field Values
      • READER_EA_VERSION

        public static final java.lang.String READER_EA_VERSION
        Represents the version of Enterprise Architect used to export the XMI.
        See Also:
        Constant Field Values
      • READER_ANNOTATION_ISAUTOGENERATED

        public static final java.lang.String READER_ANNOTATION_ISAUTOGENERATED
        Represents the category called ea.reader.autogenerated for Extensions created when parsing an Enterprise Architect model
        See Also:
        Constant Field Values
      • READER_ANNOTATION_ISIMPLICITCLASS

        public static final java.lang.String READER_ANNOTATION_ISIMPLICITCLASS
        Represents the category called ea.reader.implicitclass for Extensions created when parsing an Enterprise Architect model
        See Also:
        Constant Field Values
      • READER_PROFILE_NSPREFIX

        public static final java.lang.String READER_PROFILE_NSPREFIX
        Represents the category called ea.reader.nsPrefix for Extensions created when parsing an Enterprise Architect model
        See Also:
        Constant Field Values
      • READER_REFERENCE_ISOWNEDBY

        public static final java.lang.String READER_REFERENCE_ISOWNEDBY
        Represents the category called ea.reader.isownedby for Extensions created when parsing an Enterprise Architect model
        See Also:
        Constant Field Values
      • WRITER_CATEGORY

        public static final java.lang.String WRITER_CATEGORY
        Represents the category called ea.writer.category for Extensions created when parsing an Enterprise Architect model
        See Also:
        Constant Field Values
      • WRITER_REFERENCE_REALIZEDBY

        public static final java.lang.String WRITER_REFERENCE_REALIZEDBY
        Represents the category called ea.writer.realizedBy for Extensions created when parsing an Enterprise Architect model
        See Also:
        Constant Field Values
      • WRITER_ANNOTATION_IS_ASSOCIATION_END

        public static final java.lang.String WRITER_ANNOTATION_IS_ASSOCIATION_END
        Represents the category called ea.writer.associationEnd for Extensions created when parsing an Enterprise Architect model
        See Also:
        Constant Field Values
    • Constructor Detail

      • EAAnnotations

        public EAAnnotations()
    • Method Detail

      • getProperties

        public static java.util.Properties getProperties​(MDWObject eaObject,
                                                         java.lang.String category)
        Returns the Properties values for the specified eaObject and category.
        Parameters:
        eaObject - A MDWorkbench Object from Enterprise Architect
        category - The category of properties
        Returns:
        Properties reflecting each property of the category, null if not existing
      • getProperty

        public static java.lang.String getProperty​(MDWObject eaObject,
                                                   java.lang.String qualifiedProperty)
        Returns the Property value for the specified eaObject and qualified Property
        Parameters:
        eaObject - A MDWorkbench Object from Enterprise Architect
        qualifiedProperty - The qualified name of the property. Format: category.propertyKey.
        Returns:
        the property value
      • setProperty

        public static void setProperty​(MDWObject eaObject,
                                       java.lang.String category,
                                       java.lang.String key,
                                       java.lang.String value)
        Creates an EAnnotation on an MDWorkbench Object
        Parameters:
        eaObject - The MDWorkbench Object for which the Property has to be created
        category - The category of the Property
        key - The Property key
        value - The value of the Property
      • setReference

        @Deprecated
        public static void setReference​(MDWObject eaObject,
                                        java.lang.String category,
                                        java.lang.String key,
                                        org.eclipse.emf.ecore.EObject value)
        Deprecated.
        This method will be removed in a future release