0
|
1 /*
|
|
2 * (c) Copyright IBM Corp 2001, 2005
|
|
3 */
|
|
4
|
|
5 package javax.wadls;
|
|
6
|
|
7 import java.net.URISyntaxException;
|
|
8 import java.util.List;
|
|
9 import java.util.Map;
|
|
10 import javax.wadls.extensions.schema.Schema;
|
|
11 import javax.xml.namespace.QName;
|
|
12
|
|
13 import org.w3c.dom.Element;
|
|
14
|
|
15 /**
|
|
16 * This interface represents the <types> section of a WSDL document.
|
|
17 *
|
|
18 * @author Zixin Wu (wuzixin@uga.edu)
|
|
19 * @author Matthew J. Duftler (duftler@us.ibm.com)
|
|
20 */
|
|
21 public interface Params extends java.io.Serializable,ModelReferenceExtensible
|
|
22 {
|
|
23 /**
|
|
24 * Get the XSD simpleType with the given name.
|
|
25 * @param name The QName of the type
|
|
26 * @return A DOM Element representing the simpleType
|
|
27 * @throws WADLSException
|
|
28 */
|
|
29
|
|
30 public Element getXSDElement(String xpath) throws WADLSException;
|
|
31
|
|
32 /**
|
|
33 * Return a list of XSD elements contained in the startElement, search in only 1 level depth.
|
|
34 * @param startXSDElement
|
|
35 * @return A list of XSD elements contained in the startElement. If no XSD element is contained, the list has 0 element.
|
|
36 * @throws WADLSException
|
|
37 */
|
|
38 public List getXSDElementsInComplexType(Element startXSDElement) throws WADLSException;
|
|
39
|
|
40 /**
|
|
41 * Return a list of XSD elements contained in the startElement, search in only 1 level depth.
|
|
42 * @param startXSDComplexType
|
|
43 * @return A list of XSD elements contained in the startElement. If no XSD element is contained, the list has 0 element.
|
|
44 * @throws WADLSException
|
|
45 */
|
|
46 public List getXSDElementsInElement(Element startXSDComplexType) throws WADLSException;
|
|
47
|
|
48 /**
|
|
49 * Get the modelReference on the element located by the given path.
|
|
50 * @param startElement The starting element of the path
|
|
51 * @param path
|
|
52 * @return The modelReference
|
|
53 */
|
|
54 public ModelReference getModelReference(Element startElement, String path, Application app) throws WADLSException, URISyntaxException;
|
|
55
|
|
56 /**
|
|
57 * Set the modelReference on the element located by the given path.
|
|
58 * @param startElement The starting element of the path
|
|
59 * @param path
|
|
60 * @param modelReference The desired modelReference
|
|
61 */
|
|
62 public void addModelReference(Element startElement, String path, ModelReference modelReference) throws WADLSException;
|
|
63
|
|
64 public List<ModelReference> getModelReferences(Element startElement, String path, Application app) throws WADLSException, URISyntaxException;
|
|
65
|
|
66 public void setModelReferences(Element startElement, String path, List<ModelReference> refs) throws WADLSException;
|
|
67
|
|
68 /**
|
|
69 * Get the LiftingSchemaMapping on the element located by the given path.
|
|
70 * @param startElement The starting element of the path
|
|
71 * @param path
|
|
72 * @return The schemaMapping value
|
|
73 */
|
|
74 public String getLiftingSchemaMapping(Element startElement, String path) throws WADLSException;
|
|
75
|
|
76 /**
|
|
77 * Set the LiftingSchemaMapping on the element located by the given path.
|
|
78 * @param startElement The starting element of the path
|
|
79 * @param path
|
|
80 * @param schemaMapping The desired schemaMapping
|
|
81 */
|
|
82 public void setLiftingSchemaMapping(Element startElement, String path, String schemaMapping) throws WADLSException;
|
|
83
|
|
84 /**
|
|
85 * Get the LiftingSchemaMapping on the element located by the given path.
|
|
86 * @param startElement The starting element of the path
|
|
87 * @param path
|
|
88 * @return The schemaMapping value
|
|
89 */
|
|
90 public String getLoweringSchemaMapping(Element startElement, String path) throws WADLSException;
|
|
91
|
|
92 /**
|
|
93 * Set the LiftingSchemaMapping on the element located by the given path.
|
|
94 * @param startElement The starting element of the path
|
|
95 * @param path
|
|
96 * @param schemaMapping The desired schemaMapping
|
|
97 */
|
|
98 public void setLoweringSchemaMapping(Element startElement, String path, String schemaMapping) throws WADLSException;
|
|
99
|
|
100 /**
|
|
101 * Set the documentation element for this document. This dependency
|
|
102 * on org.w3c.dom.Element should eventually be removed when a more
|
|
103 * appropriate way of representing this information is employed.
|
|
104 *
|
|
105 * @param docEl the documentation element
|
|
106 */
|
|
107 public void setDocumentationElement(Element docEl);
|
|
108
|
|
109 /**
|
|
110 * Get the documentation element. This dependency on org.w3c.dom.Element
|
|
111 * should eventually be removed when a more appropriate way of
|
|
112 * representing this information is employed.
|
|
113 *
|
|
114 * @return the documentation element
|
|
115 */
|
|
116 public Element getDocumentationElement();
|
|
117 } |