← Back to branch summary

~ubuntu-branches/ubuntu/trusty/netbeans/trusty

« back to all changes in this revision

Viewing changes to xml/xamui/src/org/netbeans/modules/xml/xam/ui/customizer/AbstractReferenceDecorator.java

  • Committer: Bazaar Package Importer
  • Author(s): Marek Slama
  • Date: 2008-01-29 14:11:22 UTC
  • Revision ID: james.westby@ubuntu.com-20080129141122-fnzjbo11ntghxfu7
Tags: upstream-6.0.1
Import upstream version 6.0.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
xml/xamui/src/org/netbeans/modules/xml/xam/ui/customizer/AbstractReferenceDecorator.java
 
1
/*
 
2
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 
3
 *
 
4
 * Copyright 1997-2007 Sun Microsystems, Inc. All rights reserved.
 
5
 *
 
6
 * The contents of this file are subject to the terms of either the GNU
 
7
 * General Public License Version 2 only ("GPL") or the Common
 
8
 * Development and Distribution License("CDDL") (collectively, the
 
9
 * "License"). You may not use this file except in compliance with the
 
10
 * License. You can obtain a copy of the License at
 
11
 * http://www.netbeans.org/cddl-gplv2.html
 
12
 * or nbbuild/licenses/CDDL-GPL-2-CP. See the License for the
 
13
 * specific language governing permissions and limitations under the
 
14
 * License.  When distributing the software, include this License Header
 
15
 * Notice in each file and include the License file at
 
16
 * nbbuild/licenses/CDDL-GPL-2-CP.  Sun designates this
 
17
 * particular file as subject to the "Classpath" exception as provided
 
18
 * by Sun in the GPL Version 2 section of the License file that
 
19
 * accompanied this code. If applicable, add the following below the
 
20
 * License Header, with the fields enclosed by brackets [] replaced by
 
21
 * your own identifying information:
 
22
 * "Portions Copyrighted [year] [name of copyright owner]"
 
23
 *
 
24
 * Contributor(s):
 
25
 *
 
26
 * The Original Software is NetBeans. The Initial Developer of the Original
 
27
 * Software is Sun Microsystems, Inc. Portions Copyright 1997-2007 Sun
 
28
 * Microsystems, Inc. All Rights Reserved.
 
29
 *
 
30
 * If you wish your version of this file to be governed by only the CDDL
 
31
 * or only the GPL Version 2, indicate your decision by adding
 
32
 * "[Contributor] elects to include this software in this distribution
 
33
 * under the [CDDL or GPL Version 2] license." If you do not indicate a
 
34
 * single choice of license, a recipient has the option to distribute
 
35
 * your version of this file under either the CDDL, the GPL Version 2 or
 
36
 * to extend the choice of license to its licensees as provided above.
 
37
 * However, if you add GPL Version 2 code and therefore, elected the GPL
 
38
 * Version 2 license, then the option applies only if the new code is
 
39
 * made subject to such option by the copyright holder.
 
40
 */
 
41
 
 
42
package org.netbeans.modules.xml.xam.ui.customizer;
 
43
 
 
44
import java.util.HashMap;
 
45
import java.util.Map;
 
46
import org.netbeans.modules.xml.xam.Model;
 
47
 
 
48
/**
 
49
 * An abstract implementation of ExternalReferenceDecorator that provides
 
50
 * some common functionality for all concrete implementations to share.
 
51
 *
 
52
 * @author Nathan Fiedler
 
53
 */
 
54
public abstract class AbstractReferenceDecorator implements
 
55
        ExternalReferenceDecorator {
 
56
    /** Set of namespace prefixes, keyed by Model instances. */
 
57
    private Map<Model, String> prefixMap;
 
58
 
 
59
    /**
 
60
     * Creates a new instance of AbstractReferenceDecorator.
 
61
     */
 
62
    public AbstractReferenceDecorator() {
 
63
        prefixMap = new HashMap<Model, String>();
 
64
    }
 
65
 
 
66
    /**
 
67
     * Generate a unique namespace prefix. The model is provided as a
 
68
     * means of possibly creating a prefix that reflects the model in
 
69
     * some fashion (e.g. using its namespace).
 
70
     *
 
71
     * @param  model  XAM model, which may be used to generate the prefix.
 
72
     * @return  unique prefix value (e.g. "ns1"); must not be null.
 
73
     */
 
74
    protected abstract String generatePrefix(Model model);
 
75
 
 
76
    public String generatePrefix(ExternalReferenceNode node) {
 
77
        // It only makes sense to generate a prefix for nodes that have a
 
78
        // model, otherwise folders and non-XML files would have them.
 
79
        if (node.hasModel()) {
 
80
            // Use the model as the key, rather than the node itself, since
 
81
            // there could be multiple nodes representing a single model.
 
82
            Model model = node.getModel();
 
83
            String prefix = prefixMap.get(model);
 
84
            if (prefix == null) {
 
85
                prefix = generatePrefix(model);
 
86
                prefixMap.put(model, prefix);
 
87
            }
 
88
            return prefix;
 
89
        }
 
90
        return "";
 
91
    }
 
92
}