← Back to branch summary

~ubuntu-branches/ubuntu/quantal/netbeans/quantal

« back to all changes in this revision

Viewing changes to xml/axi/src/org/netbeans/modules/xml/axi/SchemaGeneratorFactory.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/axi/src/org/netbeans/modules/xml/axi/SchemaGeneratorFactory.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
package org.netbeans.modules.xml.axi;
 
42
 
 
43
import java.io.IOException;
 
44
import java.util.List;
 
45
import javax.swing.text.BadLocationException;
 
46
import org.netbeans.modules.xml.axi.impl.SchemaGeneratorFactoryImpl;
 
47
import org.netbeans.modules.xml.schema.model.SchemaModel;
 
48
 
 
49
/**
 
50
 *
 
51
 * @author Ayub Khan
 
52
 */
 
53
public abstract class SchemaGeneratorFactory {
 
54
    
 
55
    public enum TransformHint{
 
56
        OK,
 
57
        SAME_DESIGN_PATTERN,
 
58
        INVALID_SCHEMA,
 
59
        NO_GLOBAL_ELEMENTS,
 
60
        GLOBAL_ELEMENTS_HAVE_NO_CHILD_ELEMENTS,
 
61
        GLOBAL_ELEMENTS_HAVE_NO_CHILD_ATTRIBUTES,
 
62
        GLOBAL_ELEMENTS_HAVE_NO_CHILD_ELEMENTS_AND_ATTRIBUTES,
 
63
        GLOBAL_ELEMENTS_HAVE_NO_GRAND_CHILDREN,
 
64
        NO_ATTRIBUTES,
 
65
        WILL_REMOVE_TYPES,
 
66
        WILL_REMOVE_GLOBAL_ELEMENTS,
 
67
        WILL_REMOVE_GLOBAL_ELEMENTS_AND_TYPES,
 
68
        CANNOT_REMOVE_TYPES,
 
69
        CANNOT_REMOVE_GLOBAL_ELEMENTS,
 
70
        CANNOT_REMOVE_GLOBAL_ELEMENTS_AND_TYPES;
 
71
    }
 
72
    
 
73
    private static SchemaGeneratorFactory instance;
 
74
    
 
75
    /** Creates a new instance of SchemaGeneratorFactory */
 
76
    public static SchemaGeneratorFactory getDefault() {
 
77
        if(instance == null)
 
78
            instance = new SchemaGeneratorFactoryImpl();
 
79
        return instance;
 
80
    }
 
81
    
 
82
    /*
 
83
     * infers design pattern
 
84
     *
 
85
     */
 
86
    public abstract SchemaGenerator.Pattern inferDesignPattern(AXIModel am);
 
87
    
 
88
    /*
 
89
     * Updates schema using a a particular design pattern
 
90
     *
 
91
     */
 
92
    public abstract void updateSchema(SchemaModel sm,
 
93
            SchemaGenerator.Pattern pattern) throws BadLocationException, IOException;
 
94
    
 
95
    /*
 
96
     * returns list of all master axi global elements
 
97
     *
 
98
     * @param am - AXIModel
 
99
     * @return ges - list of all master axi global elements
 
100
     */    
 
101
    public abstract List<Element> findMasterGlobalElements(AXIModel am);
 
102
    
 
103
    /*
 
104
     * can transforms schema using a a particular design pattern
 
105
     *
 
106
     * @param sm - SchemaModel
 
107
     * @param currentPattern - if null then checks only if the schema is valid and well-formed for transform
 
108
     * @param targetPattern - if null then checks only if the schema is valid and well-formed for transform
 
109
     */
 
110
    public abstract TransformHint canTransformSchema(SchemaModel sm,
 
111
            SchemaGenerator.Pattern currentPattern, SchemaGenerator.Pattern targetPattern);
 
112
    
 
113
    /*
 
114
     * can transforms schema using a a particular design pattern
 
115
     *
 
116
     * @param sm - SchemaModel
 
117
     * @param currentPattern - if null then checks only if the schema is valid and well-formed for transform
 
118
     * @param targetPattern - if null then checks only if the schema is valid and well-formed for transform
 
119
     * @param ges - list of all master axi global elements
 
120
     */
 
121
    public abstract TransformHint canTransformSchema(SchemaModel sm,
 
122
            SchemaGenerator.Pattern currentPattern, SchemaGenerator.Pattern targetPattern,
 
123
            List<Element> ges);
 
124
    
 
125
    /*
 
126
     * transforms schema using a a particular design pattern
 
127
     *
 
128
     */
 
129
    public abstract void transformSchema(SchemaModel sm,
 
130
            SchemaGenerator.Pattern targetPattern) throws IOException;
 
131
}