001: /*
002: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
003: *
004: * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
005: *
006: * The contents of this file are subject to the terms of either the GNU
007: * General Public License Version 2 only ("GPL") or the Common
008: * Development and Distribution License("CDDL") (collectively, the
009: * "License"). You may not use this file except in compliance with the
010: * License. You can obtain a copy of the License at
011: * http://www.netbeans.org/cddl-gplv2.html
012: * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
013: * specific language governing permissions and limitations under the
014: * License. When distributing the software, include this License Header
015: * Notice in each file and include the License file at
016: * nbbuild/licenses/CDDL-GPL-2-CP. Sun designates this
017: * particular file as subject to the "Classpath" exception as provided
018: * by Sun in the GPL Version 2 section of the License file that
019: * accompanied this code. If applicable, add the following below the
020: * License Header, with the fields enclosed by brackets [] replaced by
021: * your own identifying information:
022: * "Portions Copyrighted [year] [name of copyright owner]"
023: *
024: * Contributor(s):
025: *
026: * The Original Software is NetBeans. The Initial Developer of the Original
027: * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
028: * Microsystems, Inc. All Rights Reserved.
029: *
030: * If you wish your version of this file to be governed by only the CDDL
031: * or only the GPL Version 2, indicate your decision by adding
032: * "[Contributor] elects to include this software in this distribution
033: * under the [CDDL or GPL Version 2] license." If you do not indicate a
034: * single choice of license, a recipient has the option to distribute
035: * your version of this file under either the CDDL, the GPL Version 2 or
036: * to extend the choice of license to its licensees as provided above.
037: * However, if you add GPL Version 2 code and therefore, elected the GPL
038: * Version 2 license, then the option applies only if the new code is
039: * made subject to such option by the copyright holder.
040: */
041:
042: package org.netbeans.modules.uml.requirements.xmlprovider;
043:
044: import java.io.File;
045: import java.io.IOException;
046:
047: import javax.swing.JFileChooser;
048:
049: import org.dom4j.Document;
050: import org.dom4j.Element;
051: import org.dom4j.Node;
052:
053: import org.netbeans.modules.uml.core.coreapplication.IDesignCenterSupport;
054: import org.netbeans.modules.uml.core.metamodel.structure.IRequirementArtifact;
055: import org.netbeans.modules.uml.core.requirementsframework.IRequirement;
056: import org.netbeans.modules.uml.core.requirementsframework.IRequirementSource;
057: import org.netbeans.modules.uml.core.requirementsframework.IRequirementsProvider;
058: import org.netbeans.modules.uml.core.requirementsframework.RequirementSource;
059: import org.netbeans.modules.uml.core.requirementsframework.RequirementUtility;
060: import org.netbeans.modules.uml.core.support.umlsupport.StringUtilities;
061: import org.netbeans.modules.uml.core.support.umlsupport.XMLManip;
062: import org.netbeans.modules.uml.core.support.umlutils.ETList;
063: import org.netbeans.modules.uml.ui.support.ProductHelper;
064: import org.openide.util.NbBundle;
065:
066: /**
067: * @author josephg
068: *
069: */
070: public class ETReqProvider implements IDesignCenterSupport,
071: IRequirementsProvider {
072: private String m_progID = "org.netbeans.modules.uml.ui.products.ad.requirementsprovider.etrequirementsprovider";
073: private String m_Version;
074:
075: public String getProgID() {
076: return m_progID;
077: }
078:
079: public void setProgID(String newVal) {
080: m_progID = newVal;
081: }
082:
083: /* (non-Javadoc)
084: * @see org.netbeans.modules.uml.core.addinframework.IAddIn#deInitialize(java.lang.Object)
085: */
086: public long deInitialize(Object context) {
087: // nothing in C++ code here
088: return 0;
089: }
090:
091: /* (non-Javadoc)
092: * @see org.netbeans.modules.uml.core.addinframework.IAddIn#getID()
093: */
094: public String getID() {
095: return getProgID();
096: }
097:
098: public String getDisplayName() {
099: return Messages.getString("DisplayName");//$NON-NLS-1$
100: }
101:
102: /* (non-Javadoc)
103: * @see org.netbeans.modules.uml.core.addinframework.IAddIn#getLocation()
104: */
105: public String getLocation() {
106: JFileChooser chooser = new JFileChooser();
107: chooser.setAcceptAllFileFilterUsed(false);
108:
109: chooser.setFileFilter(new javax.swing.filechooser.FileFilter() {
110: public boolean accept(File file) {
111: return file.isDirectory()
112: || file.toString().toLowerCase().endsWith(
113: ".etreq"); //$NON-NLS-1$
114: }
115:
116: public String getDescription() {
117: return Messages
118: .getString("ETReqProvider.Requirements_(*.etreq)_2"); //$NON-NLS-1$
119: }
120: });
121:
122: chooser.setDialogTitle(Messages
123: .getString("ETReqProvider.Open_Requirements_File_3")); //$NON-NLS-1$
124:
125: int res = chooser.showOpenDialog(ProductHelper
126: .getProxyUserInterface().getWindowHandle());
127: try {
128: return res == JFileChooser.APPROVE_OPTION ? chooser
129: .getSelectedFile().getCanonicalPath() : null;
130: } catch (IOException e) {
131: }
132: return null;
133: }
134:
135: /* (non-Javadoc)
136: * @see org.netbeans.modules.uml.core.addinframework.IAddIn#getName()
137: */
138: public String getName() {
139: // TODO Auto-generated method stub
140: return null;
141: }
142:
143: /* (non-Javadoc)
144: * @see org.netbeans.modules.uml.core.addinframework.IAddIn#getVersion()
145: */
146: public String getVersion() {
147: return m_Version;
148: }
149:
150: /* (non-Javadoc)
151: * @see org.netbeans.modules.uml.core.addinframework.IAddIn#initialize(java.lang.Object)
152: */
153: public long initialize(Object context) {
154: // nothing in C++ code here
155: return 0;
156: }
157:
158: /* (non-Javadoc)
159: * @see org.netbeans.modules.uml.core.addinframework.IAddIn#unLoad(java.lang.Object)
160: */
161: public long unLoad(Object context) {
162: // nothing in C++ code here
163: return 0;
164: }
165:
166: public IRequirementSource displaySources(/*IAddInDescriptor addInDescriptor*/) {
167: IRequirementSource requirementSource = new RequirementSource();
168: requirementSource.setRequiresLogin(false);
169:
170: String id = XMLManip.retrieveDCEID();
171: requirementSource.setID(id);
172:
173: String location = getLocation();
174:
175: if (location != null) {
176: String fileN = StringUtilities.getFileName(location);
177: String friendlyName = "SUN XML - " + fileN; //$NON-NLS-1$
178:
179: // Set the name displayed in the design center tree for the requirements source.
180: requirementSource.setDisplayName(friendlyName);
181:
182: // Set the prog Id for the requirement source provider.
183: //String value = addInDescriptor.getProgID();
184: String value = getProgID();
185: requirementSource.setProvider(value);
186:
187: // Set the location of the source provider's requirements file.
188: requirementSource.setLocation(location);
189:
190: // Set the location of the proxy file (which connects Describe symbols with the
191: // requirements that they fulfill).
192: requirementSource.setProxyFile(""); //$NON-NLS-1$
193:
194: return requirementSource;
195: } else {
196: // Report error, no selection
197: }
198: return null;
199: }
200:
201: public ETList<IRequirement> loadRequirements(
202: IRequirementSource requirementSource) {
203: ETList<IRequirement> retVal = null;
204:
205: Document doc = ReqUtils.getXMLDoc(requirementSource);
206:
207: if (doc != null) {
208: Node xmlNode = doc.selectSingleNode("/RequirementsProject"); //$NON-NLS-1$
209:
210: if (xmlNode != null) {
211: retVal = RequirementUtility.processChildElements(
212: xmlNode, ETRequirement.class, null);
213:
214: if (retVal != null) {
215: int reqCount = retVal.getCount();
216:
217: for (int index = 0; index < reqCount; index++) {
218: IRequirement requirement = retVal.item(index);
219: ReqUtils.addSatisfierChildElements(requirement,
220: requirementSource);
221: }
222: }
223: }
224: }
225: return retVal;
226: }
227:
228: public IRequirement getRequirement(
229: IRequirementArtifact requirementArtifact,
230: IRequirementSource requirementSource) {
231: String id = requirementArtifact.getRequirementID();
232:
233: Document doc = ReqUtils.getXMLDoc(requirementSource);
234:
235: if (doc != null) {
236: Node xmlNode = doc
237: .selectSingleNode("//Requirement[@id='" + id + "']"); //$NON-NLS-1$ //$NON-NLS-2$
238:
239: if (xmlNode != null) {
240: // Create a Dummy container node to hold node we care about, put cloned node of the matched node
241: // in container. ProcessChildElements will build requirements from children of container node.
242: Element dummyContainerNode = XMLManip.createElement(
243: doc, "RequirementsProject"); //$NON-NLS-1$
244:
245: if (dummyContainerNode != null) {
246: Node xmlNode2 = (Node) xmlNode.clone();
247: dummyContainerNode.add(xmlNode2);
248:
249: // There should only be one Requirement matching ID, use the ProcessChildElements method to
250: // turn XML into Requirements collection.
251: ETList<IRequirement> requirements = RequirementUtility
252: .processChildElements(dummyContainerNode,
253: ETRequirement.class, null);
254:
255: if (requirements != null) {
256: int reqCount = requirements.getCount();
257:
258: if (reqCount > 0) {
259: return requirements.item(0);
260: }
261: }
262: }
263: }
264: }
265: return null;
266: }
267:
268: ////////////////////////////////////////////////////////////////////////////
269: // IDesignCenterSupport Methods
270:
271: /** save the design center addin */
272: public void save() {
273: // There is nothing to save.
274: }
275:
276: public String getDescription() {
277: return NbBundle.getMessage(ETReqProvider.class,
278: "IDS_XML_REQ_SOURCE_TITLE");
279: }
280: }
|