Coverage Report

Coverage Report - org.argouml.kernel.AbstractProjectMember

Classes in this File

Line Coverage

Branch Coverage

Complexity

AbstractProjectMember

76%

29/38

50%

11/22

2.625

 /* $Id: AbstractProjectMember.java 17822 2010-01-12 18:47:46Z 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) 1996-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.kernel;
 
 import org.argouml.persistence.PersistenceManager;
 
 /**
  * A member of the project.
  *
  */
 public abstract class AbstractProjectMember implements ProjectMember {
 
     private String uniqueName;
     private Project project = null;
 
     /**
      * The constructor.
      *
      * @param theUniqueName the name of the member, this must
      *                      be different for all members. Note
      *                      that for diagram members this is
      *                      not the name of the diagram.
      * @param theProject the owning project
      */
     public AbstractProjectMember(String theUniqueName, Project theProject) {
         project = theProject;
         makeUniqueName(theUniqueName);
     }
 
     /**
      * In contrast to {@link #getZipName()} returns the member's
      * name without the prepended name of the project
      * (but with the extension). <p>
      * 
      * TODO: This is not used anywhere - shall we remove it?
      *
      * @author Steffen Zschaler
      *
      * @return the member's name without any prefix or suffix
      */
     public String getUniqueDiagramName() {
         String s = uniqueName;
 
         if (s != null) {
             if (!s.endsWith (getZipFileExtension())) {
                 s += getZipFileExtension();
             }
         }
 
         return s;
     }
 
     /**
      * Returns a unique member's name for storage in a zipfile.
      * The project's base name is prepended followed by an
      * underscore '_'. The extension is appended.<p>
      * 
      * Used by "argo.tee".
      *
      * @return the name for zip file storage
      */
     public String getZipName() {
         if (uniqueName == null) {
             return null;
         }
 
         String s = PersistenceManager.getInstance().getProjectBaseName(project);
 
         if (uniqueName.length() > 0) {
             s += "_" + uniqueName;
         }
 
         if (!s.endsWith(getZipFileExtension())) {
             s += getZipFileExtension();
         }
 
         return s;
     }
 
     /**
      * Makes a unique name for this member.
      * Note this is not the diagram name and this appears
      * to be flawed.
      * @param s a string which will make up part of this
      *          unique name.
      */
     protected void makeUniqueName(String s) {
         uniqueName = s;
 
         if (uniqueName == null) {
             return;
         }
 
         String pbn = 
             PersistenceManager.getInstance().getProjectBaseName(project); 
         if (uniqueName.startsWith (pbn)) {
             uniqueName = uniqueName.substring (pbn.length());
             /* Skip leading underscores: */
             int i = 0;
             for (; i < uniqueName.length(); i++) {
                     if (uniqueName.charAt(i) != '_') {
                         break;
                 }
             }
             if (i > 0) {
                 uniqueName = uniqueName.substring(i);
             }
         }
 
         if (uniqueName.endsWith(getZipFileExtension())) {
             uniqueName =
                 uniqueName.substring(0,
                         uniqueName.length() - getZipFileExtension().length());
         }
     }
 
     /**
      * Used by "argo.tee".
      * 
      * @return a short string defining the member type.
      * Usually equals the file extension.
      */
     public abstract String getType();
 
     /**
      * @return the file extension string
      */
     public String getZipFileExtension() {
         return "." + getType();
     }
 
     /**
      * Remove this member from its project.
      */
     protected void remove() {
         uniqueName = null;
         project = null;
     }
     
     public String toString() {
         return getZipName();
     }
 }

1		/* $Id: AbstractProjectMember.java 17822 2010-01-12 18:47:46Z linus $
2		*****************************************************************************
3		* Copyright (c) 2009 Contributors - see below
4		* All rights reserved. This program and the accompanying materials
5		* are made available under the terms of the Eclipse Public License v1.0
6		* which accompanies this distribution, and is available at
7		* http://www.eclipse.org/legal/epl-v10.html
8		*
9		* Contributors:
10		* tfmorris
11		*****************************************************************************
12		*
13		* Some portions of this file was previously release using the BSD License:
14		*/
15
16		// Copyright (c) 1996-2008 The Regents of the University of California. All
17		// Rights Reserved. Permission to use, copy, modify, and distribute this
18		// software and its documentation without fee, and without a written
19		// agreement is hereby granted, provided that the above copyright notice
20		// and this paragraph appear in all copies. This software program and
21		// documentation are copyrighted by The Regents of the University of
22		// California. The software program and documentation are supplied "AS
23		// IS", without any accompanying services from The Regents. The Regents
24		// does not warrant that the operation of the program will be
25		// uninterrupted or error-free. The end-user understands that the program
26		// was developed for research purposes and is advised not to rely
27		// exclusively on the program for any reason. IN NO EVENT SHALL THE
28		// UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT,
29		// SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, INCLUDING LOST PROFITS,
30		// ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF
31		// THE UNIVERSITY OF CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF
32		// SUCH DAMAGE. THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY
33		// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
34		// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE
35		// PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND THE UNIVERSITY OF
36		// CALIFORNIA HAS NO OBLIGATIONS TO PROVIDE MAINTENANCE, SUPPORT,
37		// UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
38
39		package org.argouml.kernel;
40
41		import org.argouml.persistence.PersistenceManager;
42
43		/**
44		* A member of the project.
45		*
46		*/
47		public abstract class AbstractProjectMember implements ProjectMember {
48
49		private String uniqueName;
50	5974	private Project project = null;
51
52		/**
53		* The constructor.
54		*
55		* @param theUniqueName the name of the member, this must
56		* be different for all members. Note
57		* that for diagram members this is
58		* not the name of the diagram.
59		* @param theProject the owning project
60		*/
61	5974	public AbstractProjectMember(String theUniqueName, Project theProject) {
62	5974	project = theProject;
63	5974	makeUniqueName(theUniqueName);
64	5974	}
65
66		/**
67		* In contrast to {@link #getZipName()} returns the member's
68		* name without the prepended name of the project
69		* (but with the extension). <p>
70		*
71		* TODO: This is not used anywhere - shall we remove it?
72		*
73		* @author Steffen Zschaler
74		*
75		* @return the member's name without any prefix or suffix
76		*/
77		public String getUniqueDiagramName() {
78	0	String s = uniqueName;
79
80	0	if (s != null) {
81	0	if (!s.endsWith (getZipFileExtension())) {
82	0	s += getZipFileExtension();
83		}
84		}
85
86	0	return s;
87		}
88
89		/**
90		* Returns a unique member's name for storage in a zipfile.
91		* The project's base name is prepended followed by an
92		* underscore '_'. The extension is appended.<p>
93		*
94		* Used by "argo.tee".
95		*
96		* @return the name for zip file storage
97		*/
98		public String getZipName() {
99	1922	if (uniqueName == null) {
100	0	return null;
101		}
102
103	1922	String s = PersistenceManager.getInstance().getProjectBaseName(project);
104
105	1922	if (uniqueName.length() > 0) {
106	0	s += "_" + uniqueName;
107		}
108
109	1922	if (!s.endsWith(getZipFileExtension())) {
110	1922	s += getZipFileExtension();
111		}
112
113	1922	return s;
114		}
115
116		/**
117		* Makes a unique name for this member.
118		* Note this is not the diagram name and this appears
119		* to be flawed.
120		* @param s a string which will make up part of this
121		* unique name.
122		*/
123		protected void makeUniqueName(String s) {
124	5974	uniqueName = s;
125
126	5974	if (uniqueName == null) {
127	0	return;
128		}
129
130	5974	String pbn =
131		PersistenceManager.getInstance().getProjectBaseName(project);
132	5974	if (uniqueName.startsWith (pbn)) {
133	968	uniqueName = uniqueName.substring (pbn.length());
134		/* Skip leading underscores: */
135	968	int i = 0;
136	968	for (; i < uniqueName.length(); i++) {
137	968	if (uniqueName.charAt(i) != '_') {
138	968	break;
139		}
140		}
141	968	if (i > 0) {
142	0	uniqueName = uniqueName.substring(i);
143		}
144		}
145
146	5974	if (uniqueName.endsWith(getZipFileExtension())) {
147	968	uniqueName =
148		uniqueName.substring(0,
149		uniqueName.length() - getZipFileExtension().length());
150		}
151	5974	}
152
153		/**
154		* Used by "argo.tee".
155		*
156		* @return a short string defining the member type.
157		* Usually equals the file extension.
158		*/
159		public abstract String getType();
160
161		/**
162		* @return the file extension string
163		*/
164		public String getZipFileExtension() {
165	968	return "." + getType();
166		}
167
168		/**
169		* Remove this member from its project.
170		*/
171		protected void remove() {
172	378	uniqueName = null;
173	378	project = null;
174	378	}
175
176		public String toString() {
177	1922	return getZipName();
178		}
179		}