annotate WebServiceExtensionsV1.1/WebServiceToolWorkflow_REST_SOAP/lib/SAWADLParser/src/javax/wadls/Grammars.java @ 0:049760c677de default tip

Galaxy WSExtensions added successfully
author uga-galaxy-group
date Tue, 05 Jul 2011 19:34:18 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
1
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
2 package javax.wadls;
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
3
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
4 import java.net.URISyntaxException;
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
5 import java.util.List;
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
6 import java.util.Map;
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
7
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
8 import javax.wadls.extensions.ElementExtensible;
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
9 import javax.wadls.extensions.schema.Schema;
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
10 import javax.wadls.Application;
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
11 import javax.wadls.ModelReference;
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
12 import javax.wadls.WADLSException;
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
13 import javax.xml.namespace.QName;
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
14
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
15 import org.w3c.dom.Element;
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
16
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
17 /**
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
18 * This interface represents the <types> section of a WSDL document.
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
19 *
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
20 * @author Zixin Wu (wuzixin@uga.edu)
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
21 * @author Matthew J. Duftler (duftler@us.ibm.com)
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
22 */
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
23 public interface Grammars extends java.io.Serializable,ModelReferenceExtensible
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
24 {public List getTopLevelSchemas();
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
25
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
26 /**
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
27 * Get the DOM elements of all the schemas in this Types.
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
28 * @return A list of DOM elements of all the schemas in this Types.
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
29 */
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
30 public Map getSchemas();
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
31
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
32 public void setSchemas(Map allSchemas);
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
33
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
34
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
35
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
36 /**
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
37 * Get the DOM element of the first schema in this Types.
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
38 * @return The DOM element of the first schema in this Types.
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
39 */
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
40 public Schema getFirstSchema();
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
41
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
42 public ModelReference getModelReference(Element startElement, String path, Application app) throws WADLSException, URISyntaxException;
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
43
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
44 /**
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
45 * Set the modelReference on the element located by the given path.
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
46 * @param startElement The starting element of the path
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
47 * @param path
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
48 * @param modelReference The desired modelReference
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
49 */
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
50 public void addModelReference(Element startElement, String path, ModelReference modelReference) throws WADLSException;
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
51
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
52 public void setModelReferences(Element startElement, String path, List<ModelReference> refs) throws WADLSException;
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
53
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
54 /**
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
55 * Get the LiftingSchemaMapping on the element located by the given path.
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
56 * @param startElement The starting element of the path
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
57 * @param path
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
58 * @return The schemaMapping value
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
59 */
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
60 public String getLiftingSchemaMapping(Element startElement, String path) throws WADLSException;
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
61
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
62 /**
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
63 * Set the LiftingSchemaMapping on the element located by the given path.
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
64 * @param startElement The starting element of the path
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
65 * @param path
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
66 * @param schemaMapping The desired schemaMapping
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
67 */
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
68 public void setLiftingSchemaMapping(Element startElement, String path, String schemaMapping) throws WADLSException;
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
69
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
70 /**
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
71 * Get the LiftingSchemaMapping on the element located by the given path.
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
72 * @param startElement The starting element of the path
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
73 * @param path
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
74 * @return The schemaMapping value
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
75 */
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
76 public String getLoweringSchemaMapping(Element startElement, String path) throws WADLSException;
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
77
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
78 /**
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
79 * Set the LiftingSchemaMapping on the element located by the given path.
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
80 * @param startElement The starting element of the path
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
81 * @param path
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
82 * @param schemaMapping The desired schemaMapping
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
83 */
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
84 public void setLoweringSchemaMapping(Element startElement, String path, String schemaMapping) throws WADLSException;
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
85
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
86 /**
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
87 * Set the documentation element for this document. This dependency
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
88 * on org.w3c.dom.Element should eventually be removed when a more
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
89 * appropriate way of representing this information is employed.
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
90 *
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
91 * @param docEl the documentation element
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
92 */
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
93 public void setDocumentationElement(Element docEl);
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
94
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
95 /**
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
96 * Get the documentation element. This dependency on org.w3c.dom.Element
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
97 * should eventually be removed when a more appropriate way of
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
98 * representing this information is employed.
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
99 *
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
100 * @return the documentation element
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
101 */
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
102 public Element getDocumentationElement();
049760c677de Galaxy WSExtensions added successfully
uga-galaxy-group
parents:
diff changeset
103 }