1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124
|
/*
* JBoss, Home of Professional Open Source
* Copyright 2005, JBoss Inc., and individual contributors as indicated
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.jboss.ws.tools.interfaces;
import java.util.HashMap;
import java.util.Map;
import javax.xml.namespace.QName;
import org.jboss.ws.core.jaxrpc.LiteralTypeMapping;
import org.jboss.ws.metadata.jaxrpcmapping.JavaWsdlMapping;
import org.jboss.ws.metadata.wsdl.xmlschema.JBossXSModel;
import org.jboss.ws.metadata.wsdl.xmlschema.JBossXSTypeDefinition;
/**
* Defines the contract for Schema Creating agents (Java -> XSD Process)
* @author <mailto:Anil.Saldhana@jboss.org>Anil Saldhana
* @since Jul 23, 2005
*/
public interface SchemaCreatorIntf
{
/**
* Add a package - namespace mapping entry
* @param pkgname
* @param ns
* @throws IllegalArgumentException if either pkgname or ns is null
*/
public void addPackageNamespaceMapping(String pkgname, String ns);
/**
* Return a HashMap of custom namespaces like ns1, ns2 etc
* @return
*/
public HashMap getCustomNamespaceMap();
/**
* get the XSModel representing the targetNS
* @return
*/
public JBossXSModel getXSModel();
public JavaWsdlMapping getJavaWsdlMapping();
/**
* @return Returns the packageNamespaceMap.
*/
public Map<String, String> getPackageNamespaceMap();
/**
* Return the Type Mapping
* @return
*/
public LiteralTypeMapping getTypeMapping();
/**
* Main method that is involved in generating a Schema Type
* @param xmlType QName of the Complex Type. Can be null
* @param javaType Java class for the type. Can be null
* @return Schema Type
*/
public JBossXSTypeDefinition generateType(QName xmlType, Class javaType);
public JBossXSTypeDefinition generateType(QName xmlType, Class javaType, Map<String, QName> elementNames);
/**
* Given a XML Type, return the Java class
*
* @param xmlType
* @return
*/
public Class getJavaType(QName xmlType);
/**
* Given a Java class, return the XML Type
*
* @param javaType
* @return
*/
public QName getXMLSchemaType(Class javaType);
/**
* Users can provide a customized map of java packages to xml namespace
* @param packageNamespaceMap The packageNamespaceMap to set.
*/
public void setPackageNamespaceMap(Map<String, String> packageNamespaceMap);
/**
* SchemaCreator maintains a map of namespaces that will be fed back
* into WSDLDefinitions for all custom namespaces
* @param nsuri
* @return
*/
public String allocatePrefix(String nsuri);
/**
* Set the XSModel representing the targetNS
* @param xsm
*/
public void setXSModel(JBossXSModel xsm);
}
|