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: package org.netbeans.modules.xml.axi;
042:
043: import java.io.IOException;
044: import java.util.List;
045: import javax.swing.text.BadLocationException;
046: import org.netbeans.modules.xml.axi.impl.SchemaGeneratorFactoryImpl;
047: import org.netbeans.modules.xml.schema.model.SchemaModel;
048:
049: /**
050: *
051: * @author Ayub Khan
052: */
053: public abstract class SchemaGeneratorFactory {
054:
055: public enum TransformHint {
056: OK, SAME_DESIGN_PATTERN, INVALID_SCHEMA, NO_GLOBAL_ELEMENTS, GLOBAL_ELEMENTS_HAVE_NO_CHILD_ELEMENTS, GLOBAL_ELEMENTS_HAVE_NO_CHILD_ATTRIBUTES, GLOBAL_ELEMENTS_HAVE_NO_CHILD_ELEMENTS_AND_ATTRIBUTES, GLOBAL_ELEMENTS_HAVE_NO_GRAND_CHILDREN, NO_ATTRIBUTES, WILL_REMOVE_TYPES, WILL_REMOVE_GLOBAL_ELEMENTS, WILL_REMOVE_GLOBAL_ELEMENTS_AND_TYPES, CANNOT_REMOVE_TYPES, CANNOT_REMOVE_GLOBAL_ELEMENTS, CANNOT_REMOVE_GLOBAL_ELEMENTS_AND_TYPES;
057: }
058:
059: private static SchemaGeneratorFactory instance;
060:
061: /** Creates a new instance of SchemaGeneratorFactory */
062: public static SchemaGeneratorFactory getDefault() {
063: if (instance == null)
064: instance = new SchemaGeneratorFactoryImpl();
065: return instance;
066: }
067:
068: /*
069: * infers design pattern
070: *
071: */
072: public abstract SchemaGenerator.Pattern inferDesignPattern(
073: AXIModel am);
074:
075: /*
076: * Updates schema using a a particular design pattern
077: *
078: */
079: public abstract void updateSchema(SchemaModel sm,
080: SchemaGenerator.Pattern pattern)
081: throws BadLocationException, IOException;
082:
083: /*
084: * returns list of all master axi global elements
085: *
086: * @param am - AXIModel
087: * @return ges - list of all master axi global elements
088: */
089: public abstract List<Element> findMasterGlobalElements(AXIModel am);
090:
091: /*
092: * can transforms schema using a a particular design pattern
093: *
094: * @param sm - SchemaModel
095: * @param currentPattern - if null then checks only if the schema is valid and well-formed for transform
096: * @param targetPattern - if null then checks only if the schema is valid and well-formed for transform
097: */
098: public abstract TransformHint canTransformSchema(SchemaModel sm,
099: SchemaGenerator.Pattern currentPattern,
100: SchemaGenerator.Pattern targetPattern);
101:
102: /*
103: * can transforms schema using a a particular design pattern
104: *
105: * @param sm - SchemaModel
106: * @param currentPattern - if null then checks only if the schema is valid and well-formed for transform
107: * @param targetPattern - if null then checks only if the schema is valid and well-formed for transform
108: * @param ges - list of all master axi global elements
109: */
110: public abstract TransformHint canTransformSchema(SchemaModel sm,
111: SchemaGenerator.Pattern currentPattern,
112: SchemaGenerator.Pattern targetPattern, List<Element> ges);
113:
114: /*
115: * transforms schema using a a particular design pattern
116: *
117: */
118: public abstract void transformSchema(SchemaModel sm,
119: SchemaGenerator.Pattern targetPattern) throws IOException;
120: }
|