/* $Id: ProfileMeta.java 18257 2010-04-13 17:58:32Z tfmorris $

  *****************************************************************************

  * Copyright (c) 2008,2010 Contributors - see below

  * All rights reserved. This program and the accompanying materials

  * are made available under the terms of the Eclipse Public License v1.0

  * which accompanies this distribution, and is available at

  * http://www.eclipse.org/legal/epl-v10.html

  *

  * Contributors:

  *    maas - Initial implementation

  *    tfmorris

  *****************************************************************************

  *

  * Some portions of this file was previously release using the BSD License:

  */

 // Copyright (c) 2008 The Regents of the University of California. All

 // Rights Reserved. Permission to use, copy, modify, and distribute this

 // software and its documentation without fee, and without a written

 // agreement is hereby granted, provided that the above copyright notice

 // and this paragraph appear in all copies. This software program and

 // documentation are copyrighted by The Regents of the University of

 // California. The software program and documentation are supplied "AS

 // IS", without any accompanying services from The Regents. The Regents

 // does not warrant that the operation of the program will be

 // uninterrupted or error-free. The end-user understands that the program

 // was developed for research purposes and is advised not to rely

 // exclusively on the program for any reason. IN NO EVENT SHALL THE

 // UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,

 // SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS,

 // ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF

 // THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF

 // SUCH DAMAGE. THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY

 // WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF

 // MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE

 // PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF

 // CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT,

 // UPDATES, ENHANCEMENTS, OR MODIFICATIONS.

 package org.argouml.profile.internal;

 import java.net.MalformedURLException;

 import java.util.ArrayList;

 import java.util.Collection;

 import java.util.Collections;

 import java.util.HashSet;

 import java.util.Set;

 import org.apache.log4j.Logger;

 import org.argouml.cognitive.Critic;

 import org.argouml.cognitive.ToDoItem;

 import org.argouml.model.Model;

 import org.argouml.profile.CoreProfileReference;

 import org.argouml.profile.Profile;

 import org.argouml.profile.ProfileException;

 import org.argouml.profile.ProfileModelLoader;

 import org.argouml.profile.ProfileReference;

 import org.argouml.profile.ResourceModelLoader;

 import org.argouml.profile.internal.ocl.CrOCL;

 import org.argouml.profile.internal.ocl.InvalidOclException;

 /**

  * Meta Profile which defines the TaggedValues to be used in User defined

  * Profiles

  * 

  * @author maas

  */

 public class ProfileMeta extends Profile {

     private static final Logger LOG = Logger.getLogger(ProfileMeta.class);

     private static final String PROFILE_FILE = "metaprofile.xmi";

     private ProfileReference profileReference = null;

     private Collection model = null;

     Set<Critic> critics = null;

     /**

      * Creates a new instance of this profile

      * 

      * @throws ProfileException if something goes wrong

      */

     @SuppressWarnings("unchecked")

     public ProfileMeta() throws ProfileException {

         super();

         try {

             profileReference = new CoreProfileReference(PROFILE_FILE);

         } catch (MalformedURLException e) {

             throw new ProfileException(

                     "Exception while creating profile reference.", e);

         }

     }

     private Collection getModel() {

         if (model == null) {

             ProfileModelLoader profileModelLoader = new ResourceModelLoader();

             try {

                 model = profileModelLoader.loadModel(profileReference);

             } catch (ProfileException e) {

                 LOG.error("Exception loading metaprofile " + PROFILE_FILE, e);

             }

             if (model == null) {

                 model = new ArrayList();

                 model.add(Model.getModelManagementFactory().createModel());

             }

         }

         return model;

     }

     private void loadWellFormednessRules() {

         critics = new HashSet<Critic>();

         try {

             critics.add(new CrOCL("context ModelElement inv: "

                     + "self.taggedValue->" 

                     + "exists(x|x.type.name='Dependency') implies "

                               + "self.stereotype->exists(x|x.name = 'Profile')",

                  "The 'Dependency' tag definition should be applied"

                                 + " only to profiles.", null,

                     ToDoItem.MED_PRIORITY, null, null,

                     "http://argouml.tigris.org/"));

         } catch (InvalidOclException e) {

             e.printStackTrace();

         }

         try {

             critics.add(new CrOCL("context ModelElement inv: "

                     + "self.taggedValue->" 

                     + "exists(x|x.type.name='Figure') or "

                     + "exists(x|x.type.name='Description') or "

                     + "exists(x|x.type.name='i18n') or "

                     + "exists(x|x.type.name='KnowledgeType') or "

                     + "exists(x|x.type.name='MoreInfoURL') or "

                     + "exists(x|x.type.name='Priority') or "

                     + "exists(x|x.type.name='Description') or "

                     + "exists(x|x.type.name='SupportedDecision') or "

                     + "exists(x|x.type.name='Headline') "

                     + "implies "

                               + "self.stereotype->exists(x|x.name = 'Critic')",

                     "Misuse of Metaprofile TaggedValues",

                     "The 'Figure', 'i18n', 'KnowledgeType', 'MoreInfoURL', " 

                     + "'Priority', 'SupportedDecision', 'Description' " 

                     + "and 'Headline' tag definitions "

                     + "should be applied only to OCL critics.",

                     ToDoItem.MED_PRIORITY, null, null,

                     "http://argouml.tigris.org/"));

         } catch (InvalidOclException e) {

             e.printStackTrace();

         }

         try {

             critics.add(new CrOCL("context Stereotype inv: "

                     + "self.namespace.stereotype->exists(x|x.name = 'Profile')",

                             "Stereotypes should be declared inside a Profile. ",

                             "Please add the <<Profile>> stereotype to "

                                    + "the containing Namespace",

                     ToDoItem.MED_PRIORITY, null, null,

                     "http://argouml.tigris.org/"));

         } catch (InvalidOclException e) {

             e.printStackTrace();

         }

         setCritics(critics);

     }

     @Override

     public String getDisplayName() {

         return "MetaProfile";

     }

     @Override

     public Collection getProfilePackages() throws ProfileException {

         return Collections.unmodifiableCollection(getModel());

     }

     @Override

     public Collection<Object> getLoadedPackages() {

         if (model == null) {

             return Collections.emptyList();

         } else {

             return Collections.unmodifiableCollection(model);

         }

     }

     @Override

     public Set<Critic> getCritics() {

         if (critics == null) {

             loadWellFormednessRules();

         }

         return super.getCritics();

     }

 }