/* $Id: SourcePathControllerImpl.java 17881 2010-01-12 21:09:28Z linus $

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

  * Copyright (c) 2009 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:

  *    tfmorris

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

  *

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

  */

 // Copyright (c) 2004-2007 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.uml.ui;

 import java.io.File;

 import java.util.ArrayList;

 import java.util.Collection;

 import java.util.Iterator;

 import org.argouml.kernel.Project;

 import org.argouml.kernel.ProjectManager;

 import org.argouml.model.Model;

 import org.argouml.uml.reveng.ImportInterface;

 /**

  * Implements the source path controller.

  * NOTE: If requested in the future this could be returned from the language

  * modules.

  *

  * TODO: Update this to use the UML 1.4 TagDefinition mechanism instead of

  * UML 1.3 String type tag types. The TagDefinition can be made more specific

  * so that it just applies to Components with a <<sourceModule>> stereotype

  * or something similar. - tfm

  * 

  * @author euluis

  * @since 0.17.1

  */

 public class SourcePathControllerImpl implements SourcePathController {

     /*

      * @see org.argouml.uml.ui.SourcePathController#getSourcePath(java.lang.Object)

      */

     public File getSourcePath(Object modelElement) {

         Object tv = Model.getFacade().getTaggedValue(modelElement,

                 ImportInterface.SOURCE_PATH_TAG);

         if (tv != null) {

             String srcPath = Model.getFacade().getValueOfTag(tv);

             if (srcPath != null) {

                 return new File(srcPath);

             }

         }

         return null;

     }

     /*

      * @see org.argouml.uml.ui.SourcePathController#getSourcePathSettings()

      */

     public SourcePathTableModel getSourcePathSettings() {

         return new SourcePathTableModel(this);

     }

     /*

      * @see org.argouml.uml.ui.SourcePathController#setSourcePath(org.argouml.uml.ui.SourcePathTableModel)

      */

     public void setSourcePath(SourcePathTableModel srcPaths) {

         for (int i = 0; i < srcPaths.getRowCount(); i++) {

             setSourcePath(srcPaths.getModelElement(i),

                 new File(srcPaths.getMESourcePath(i)));

         }

     }

     /*

      * @see org.argouml.uml.ui.SourcePathController#setSourcePath(

      * java.lang.Object, java.io.File)

      */

     public void setSourcePath(Object modelElement, File sourcePath) {

         Object tv =

                 Model.getFacade().getTaggedValue(

                         modelElement, ImportInterface.SOURCE_PATH_TAG);

         if (tv == null) {

             Model.getExtensionMechanismsHelper().addTaggedValue(

                     modelElement,

                     Model.getExtensionMechanismsFactory().buildTaggedValue(

                             ImportInterface.SOURCE_PATH_TAG,

                             sourcePath.toString()));

         } else {

             Model.getExtensionMechanismsHelper().setValueOfTag(

                     tv, sourcePath.toString());

         }

     }

     /*

      * @see java.lang.Object#toString()

      */

     public String toString() {

         return "ArgoUML default source path controller.";

     }

     /*

      * @see org.argouml.uml.ui.SourcePathController#deleteSourcePath(java.lang.Object)

      */

     public void deleteSourcePath(Object modelElement) {

         Object taggedValue = Model.getFacade().getTaggedValue(modelElement,

                 ImportInterface.SOURCE_PATH_TAG);

         Model.getExtensionMechanismsHelper().removeTaggedValue(modelElement,

                 taggedValue);

     }

     /*

      * @see org.argouml.uml.ui.SourcePathController#getAllModelElementsWithSourcePath()

      */

     public Collection getAllModelElementsWithSourcePath() {

         Project p = ProjectManager.getManager().getCurrentProject();

         Object model = p.getRoot();

         Collection elems =

             Model.getModelManagementHelper().getAllModelElementsOfKindWithModel(

                 model, Model.getMetaTypes().getModelElement());

         ArrayList mElemsWithSrcPath = new ArrayList();

         Iterator iter = elems.iterator();

         while (iter.hasNext()) {

             Object me = iter.next();

             if (getSourcePath(me) != null) {

                 mElemsWithSrcPath.add(me);

             }

         }

         return mElemsWithSrcPath;

     }

 } /* end of SourcePathControllerImpl class definition */