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.core.eventframework;
043:
044: import org.dom4j.Document;
045:
046: import org.netbeans.modules.uml.core.coreapplication.ICoreProduct;
047: import org.netbeans.modules.uml.core.metamodel.core.foundation.ConfigManager;
048: import org.netbeans.modules.uml.core.metamodel.core.foundation.IConfigManager;
049:
050: //import org.netbeans.modules.uml.core.support.umlsupport.ProductRetriever;
051: import org.netbeans.modules.uml.core.support.umlsupport.ProductRetriever;
052: import org.netbeans.modules.uml.core.support.umlsupport.XMLManip;
053:
054: /**
055: * @author sumitabhk
056: *
057: */
058: public class EventMechanism {
059:
060: private static EventMechanism m_Instance = null;
061: private Document m_Mechanism = null;
062:
063: /**
064: *
065: */
066: private EventMechanism() {
067: super ();
068: }
069:
070: /**
071: * Retrieves the single instance of the mechanism.
072: *
073: * @return The instance, else 0 if something is terribly
074: * wrong.
075: */
076: public static EventMechanism instance() {
077: if (m_Instance == null) {
078: m_Instance = new EventMechanism();
079: m_Instance.initialize();
080: }
081:
082: return m_Instance;
083: }
084:
085: /**
086: * Loads the EventFramework.etc file into memory. The contents
087: * of this file are used by every EventDispatcher.
088: */
089: private void initialize() {
090: String loc = retrieveEventFileLocation();
091: if (loc.length() > 0) {
092: m_Mechanism = XMLManip.getDOMDocument(loc);
093: }
094: }
095:
096: /**
097: * Retrieves the location of the EventFramework XML file
098: * that describes how to build the appropriate EventContexts.
099: *
100: * @return The location of the EventFramework file
101: */
102: private String retrieveEventFileLocation() {
103: String loc = null;
104: ICoreProduct prod = ProductRetriever.retrieveProduct();
105: IConfigManager conMan = null;
106: if (prod != null) {
107: conMan = prod.getConfigManager();
108: } else {
109: conMan = new ConfigManager();
110: }
111: if (conMan != null) {
112: loc = conMan.getEventFrameworkLocation();
113: }
114: return loc;
115: }
116:
117: /**
118: *
119: * Provides direct access to the actual dom document representing
120: * the event framework etc file.
121: *
122: * @param doc[out] The document
123: *
124: * @return HRESULT
125: *
126: */
127: public Document mechanism() {
128: return m_Mechanism;
129: }
130:
131: /**
132: * If the EventMechanism instance has been created, this will return that instance.
133: * If it has not been created, null is returned.
134: *
135: * @return The mechanism, else 0.
136: */
137: public static EventMechanism exists() {
138: return m_Instance;
139: }
140: }
|