Author: jkaputin
Date: Tue Feb 6 19:00:30 2007
New Revision: 504421
URL: http://svn.apache.org/viewvc?view=rev&rev=504421
Log:
API javadoc improvements in the org.apache.woden.wsdl20.xml package
Modified:
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/BindingElement.java
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/BindingFaultElement.java
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/BindingFaultReferenceElement.java
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/BindingOperationElement.java
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/DescriptionElement.java
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/DocumentableElement.java
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/DocumentationElement.java
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/EndpointElement.java
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/ImportElement.java
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/IncludeElement.java
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/InterfaceFaultElement.java
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/InterfaceFaultReferenceElement.java
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/InterfaceMessageReferenceElement.java
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/NestedElement.java
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/ServiceElement.java
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/TypesElement.java
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/WSDLElement.java
Modified:
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/BindingElement.java
URL:
http://svn.apache.org/viewvc/incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/BindingElement.java?view=diff&rev=504421&r1=504420&r2=504421
==============================================================================
---
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/BindingElement.java
(original)
+++
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/BindingElement.java
Tue Feb 6 19:00:30 2007
@@ -68,7 +68,7 @@
/**
* Return the InterfaceElement referred to by this BindingElement.
- * This equates to the <interface> element referred to in the
<code>interface</code>
+ * This equates to the <interface> element referred to by the
<code>interface</code>
* attribute of the <binding> element.
* If this reference cannot be resolved to an InterfaceElement or if this
BindingElement
* is a generic (interface-less) binding, this method will return null.
@@ -109,7 +109,7 @@
/**
* Return the set of BindingFaultElements within this BindingElement.
- * This equates to the set of <fault> elements within the
<binding>.
+ * This equates to the set of <fault> elements within the
<binding> element.
* If no BindingFaultElements exist, an empty array is returned.
*
* @return an array of BindingFaultElement
@@ -129,7 +129,7 @@
/**
* Return the set of BindingOperationElements within this BindingElement
- * This equates to the set of <operation> elements within the
<binding>.
+ * This equates to the set of <operation> elements within the
<binding> element.
* If no BindingOperationElements exist, an empty array is returned.
*
* @return an array of BindingOperationElement
Modified:
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/BindingFaultElement.java
URL:
http://svn.apache.org/viewvc/incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/BindingFaultElement.java?view=diff&rev=504421&r1=504420&r2=504421
==============================================================================
---
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/BindingFaultElement.java
(original)
+++
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/BindingFaultElement.java
Tue Feb 6 19:00:30 2007
@@ -46,9 +46,9 @@
/**
* Return the InterfaceFaultElement referred to by this
BindingFaultElement.
- * This is resolved from the QName specified in the <code>ref</code>
attribute of
- * the binding <fault> element.
- * If this QName does not resolve to an InterfaceFaultElement, this method
will
+ * This equates to the interface <fault> element referred to by the
+ * <code>ref</code> attribute of the binding <fault> element.
+ * If this reference cannot be resolved to an InterfaceFaultElement, this
method will
* return null.
*
* @return the InterfaceFaultElement
Modified:
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/BindingFaultReferenceElement.java
URL:
http://svn.apache.org/viewvc/incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/BindingFaultReferenceElement.java?view=diff&rev=504421&r1=504420&r2=504421
==============================================================================
---
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/BindingFaultReferenceElement.java
(original)
+++
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/BindingFaultReferenceElement.java
Tue Feb 6 19:00:30 2007
@@ -51,10 +51,11 @@
/**
* Return the InterfaceFaultReferenceElement referred to by this
BindingFaultReferenceElement.
- * This is resolved from the QName specified in the <code>ref</code>
attribute of
- * the binding operation <infault> or <outfault> element.
- * If this reference is not resolved to an InterfaceFaultReferenceElement,
- * this method will return null.
+ * This equates to the interface operation <infault> or
<outfault> element
+ * referred to by the <code>ref</code> attribute of the binding operation
<infault>
+ * or <outfault> element.
+ * If this reference cannot be resolved to an
InterfaceFaultReferenceElement, this method will
+ * return null.
*
* @return the InterfaceFaultReferenceElement
*/
Modified:
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/BindingOperationElement.java
URL:
http://svn.apache.org/viewvc/incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/BindingOperationElement.java?view=diff&rev=504421&r1=504420&r2=504421
==============================================================================
---
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/BindingOperationElement.java
(original)
+++
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/BindingOperationElement.java
Tue Feb 6 19:00:30 2007
@@ -50,10 +50,10 @@
/**
* Return the InterfaceOperationElement referred to by this
BindingOperationElement.
- * This is resolved from the QName specified in the <code>ref</code>
attribute of
- * the binding <operation> element.
- * If this reference cannot be resolved to an InterfaceOperationElement,
- * this method will return null.
+ * This equates to the interface <operation> element referred to by
the
+ * <code>ref</code> attribute of the binding <operation> element.
+ * If this reference cannot be resolved to an InterfaceOperationElement,
this method will
+ * return null.
*
* @return the InterfaceOperationElement
*/
Modified:
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/DescriptionElement.java
URL:
http://svn.apache.org/viewvc/incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/DescriptionElement.java?view=diff&rev=504421&r1=504420&r2=504421
==============================================================================
---
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/DescriptionElement.java
(original)
+++
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/DescriptionElement.java
Tue Feb 6 19:00:30 2007
@@ -23,73 +23,151 @@
import org.apache.woden.wsdl20.extensions.ExtensionRegistry;
/**
- * This interface represents a <wsdl:description> element.
- * It declares the behaviour required to support
- * parsing, creating and manipulating a <description> element.
+ * Represents the WSDL 2.0 <description> element.
*
- * TODO initially, have added a method to get the WSDL component
- * model from the xml instance (i.e. get a Description from this
- * instance of DescriptionElement). Still need to decide
- * where on the API to put this. Maybe in WSDLReader?
- *
- * @author [EMAIL PROTECTED]
+ * @author John Kaputin ([EMAIL PROTECTED])
*/
public interface DescriptionElement extends DocumentableElement
{
+ /**
+ * Set the document base URI to the specified URI.
+ * This is the base URI used to locate the <description> element
that this
+ * DescriptionElement corresponds to.
+ * This is used to resolve relative paths specified within this WSDL
description that
+ * refer to other WSDL or Schema documents. For example, via
<xs:import>, <wsdl:import>
+ * or <wsdl:include> elements.
+ *
+ * @param documentBaseURI the base URI of the WSDL
+ */
public void setDocumentBaseURI(URI documentBaseURI);
+
+ /**
+ * Return the document base URI that was used to locate the
<description> element that
+ * this DescriptionElement corresponds to. This is used to resolve
relative paths within this
+ * WSDL description that refer to other WSDL or Schema documents.
+ *
+ * @return the document base URI
+ */
public URI getDocumentBaseURI();
/*
* Attributes and namespaces
*/
+
+ /**
+ * Set the target namespace to the specified URI.
+ * This corresponds to the <code>targetNamespace</code> attribute of the
<description>
+ * element.
+ *
+ * @param namespaceURI the target namespace URI
+ */
public void setTargetNamespace(URI namespaceURI);
+
+ /**
+ * Return the target namespace URI.
+ * This corresponds to the <code>targetNamespace</code> attribute of the
<description>
+ * element.
+ *
+ * @return the target namespace URI.
+ */
public URI getTargetNamespace();
/**
- * This is a way to add a namespace association to a definition.
- * It is similar to adding a namespace prefix declaration to the
- * top of a <wsdl:definition> element. This has nothing to do
- * with the <wsdl:import> element; there are separate methods for
- * dealing with information described by <wsdl:import> elements.
+ * Associate the specified prefix with the specified namespace URI.
+ * This equates to adding an <code>xmlns</code> namespace declaration to
the
+ * <description> element.
+ * To define the default namespace, specify null or the empty string ""
for the prefix.
+ * If null is specified for the namespace URI, the prefix/namespace
association will be
+ * removed (i.e. the same behaviour as the <code>removeNamespace</code>
method).
+ * If the specified prefix is already associated with a namespace URI,
+ * that association will be replaced by the specified prefix/namespace
association.
*
- * @param prefix the prefix to use for this namespace (when
- * rendering this information as XML). Use null or an empty string
- * to describe the default namespace (i.e. xmlns="...").
- * @param namespace the namespace URI to associate the prefix
- * with. If you use null, the namespace association will be removed.
+ * @param prefix the prefix String associated with <code>namespace</code>
+ * @param namespace the namespace URI associated with <code>prefix</code>
*/
public void addNamespace(String prefix, URI namespace);
+ /**
+ * Remove the namespace URI associated with the specified prefix.
+ * This equates to removing an <code>xmlns</code> namespace declaration
from the
+ * <description> element.
+ * To remove the default namespace, specify null or the empty string ""
for the prefix.
+ * If the specified prefix is not associated with a namespace, no action
is performed.
+ *
+ * @param prefix the prefix String associated with a namespace
+ */
public void removeNamespace(String prefix);
/**
- * Get the namespace URI associated with this prefix. Or null if
- * there is no namespace URI associated with this prefix. This is
- * unrelated to the <wsdl:import> element.
- *
- * @see #addNamespace(String, URI)
+ * Return the namespace URI associated with the specified prefix.
+ * This equates to an <code>xmlns</code> namespace declaration on the
+ * <description> element.
+ * To return the default namespace, specify null or the empty string ""
for the prefix.
+ * If the specified prefix is not associated with a namespace, null is
returned.
+ *
+ * @param prefix the prefix String associated with a namespace
*/
public URI getNamespace(String prefix);
- public Map getNamespaces();//TODO return arrays instead of Map?
+ /**
+ * Return the set of all prefix/namespace URI associations.
+ * This equates to all of the <code>xmlns</code> namespace declaration on
the
+ * <description> element.
+ *
+ * @deprecated in M7, to be replaced in M8 with a type-safe return type
(WODEN-140)
+ *
+ * @return a Map of prefix String / namespace URI pairs
+ */
+ public Map getNamespaces(); //TODO type-safe return type
/*
* Element factory methods
*/
+ /**
+ * Create an ImportElement with this DescriptionElement as its parent and
+ * return a reference to it.
+ * This equates to adding an <import> element to the
<description> element.
+ *
+ * @return the ImportElement
+ */
public ImportElement addImportElement();
+ /**
+ * Create an IncludeElement with this DescriptionElement as its parent and
+ * return a reference to it.
+ * This equates to adding an <include> element to the
<description> element.
+ *
+ * @return the IncludeElement
+ */
public IncludeElement addIncludeElement();
/**
- * Create a new InterfaceElement in this DescriptionElement
- * @return the InterfaceElement created
+ * Create an InterfaceElement with this DescriptionElement as its parent
and
+ * return a reference to it.
+ * This equates to adding an <interface> element to the
<description> element.
+ *
+ * @return the InterfaceElement
*/
public InterfaceElement addInterfaceElement();
+ /**
+ * Create a BindingElement with this DescriptionElement as its parent and
+ * return a reference to it.
+ * This equates to adding an <binding> element to the
<description> element.
+ *
+ * @return the BindingElement
+ */
public BindingElement addBindingElement();
+ /**
+ * Create a ServiceElement with this DescriptionElement as its parent and
+ * return a reference to it.
+ * This equates to adding an <service> element to the
<description> element.
+ *
+ * @return the ServiceElement
+ */
public ServiceElement addServiceElement();
/*
@@ -99,25 +177,101 @@
*
*/
+ /**
+ * Return the set of ImportElements within this DescriptionElement.
+ * This equates to the set of <import> elements within the
<description> element.
+ * If no ImportElements exist, an empty array is returned.
+ *
+ * @return an array of ImportElement
+ */
public ImportElement[] getImportElements();
+ /**
+ * Return the set of IncludeElements within this DescriptionElement.
+ * This equates to the set of <include> elements within the
<description> element.
+ * If no IncludeElements exist, an empty array is returned.
+ *
+ * @return an array of IncludeElement
+ */
public IncludeElement[] getIncludeElements();
+ /**
+ * Return the TypesElement within this DescriptionElement.
+ * This corresponds to the <types> element within the
<description> element.
+ * If no TypesElement exists, one will be created with this
DescriptionElement as its parent.
+ * <p>
+ * TODO modify this behaviour to return null if none exists and define a
new factory method called createTypesElement() WODEN-141
+ *
+ * @return the TypesElement
+ */
public TypesElement getTypesElement();
+ /**
+ * Return the set of InterfaceElements within this DescriptionElement.
+ * This equates to the set of <interface> elements within the
<description> element.
+ * If no InterfaceElements exist, an empty array is returned.
+ *
+ * @return an array of InterfaceElement
+ */
public InterfaceElement[] getInterfaceElements();
+ /**
+ * Return the set of BindingElements within this DescriptionElement.
+ * This equates to the set of <binding> elements within the
<description> element.
+ * If no BindingElements exist, an empty array is returned.
+ *
+ * @return an array of BindingElement
+ */
public BindingElement[] getBindingElements();
+ /**
+ * Return the set of ServiceElements within this DescriptionElement.
+ * This equates to the set of <service> elements within the
<description> element.
+ * If no ServiceElements exist, an empty array is returned.
+ *
+ * @return an array of ServiceElement
+ */
public ServiceElement[] getServiceElements();
- //TODO extension elements
-
+ /**
+ * Specify the ExtensionRegistry to be used handle WSDL extensions defined
by this
+ * DescriptionElement and by any WSDL elements nested within it.
+ *
+ * @param extReg the ExtensionRegistry used with this description
+ */
public void setExtensionRegistry(ExtensionRegistry extReg);
+
+ /**
+ * Return the ExtensionRegistry used handle WSDL extensions defined by this
+ * DescriptionElement and by any WSDL elements nested within it.
+ *
+ * @return the ExtensionRegistry used with this description
+ */
public ExtensionRegistry getExtensionRegistry();
/**
- * @return the Description component for this DescriptionElement.
+ * Return the Description component derived from this DescriptionElement.
+ * <p>
+ * The Description component is unlike other WSDL components which map
neatly to a single
+ * WSDL element. Description represents a 'flattened' view of the entire
WSDL infoset tree,
+ * including the WSDL components from any imported or included WSDL
documents, so it could
+ * contain the content of multiple <description> elements.
+ * <p>
+ * If this DescriptionElement imports or includes other
DescriptionElements (that is,
+ * if it is the root of a composite WSDL document), the behaviour of this
method is equivalent
+ * to traversing the WSDL tree recursively and aggregating the WSDL
content of each
+ * DescriptionElement into a single Description component.
+ * <p>
+ * This equates to retrieving the root <description> element and
traversing any
+ * <wsdl:import> or <wsdl:include> elements to retrieve WSDL
content of
+ * any nested <description> elements.
+ * <p>
+ * The <code>toComponent()</code> method is only defined for
DescriptionElement, not for
+ * other WSDL Element interfaces. This is because the WSDL 2.0 Component
model is a nested
+ * hierarchy with a single Description component at the top. To access
WSDL components,
+ * we must start at the Description and traverse the component model from
there.
+
+ * @return the Description component derived from this DescriptionElement
*/
public Description toComponent();
Modified:
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/DocumentableElement.java
URL:
http://svn.apache.org/viewvc/incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/DocumentableElement.java?view=diff&rev=504421&r1=504420&r2=504421
==============================================================================
---
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/DocumentableElement.java
(original)
+++
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/DocumentableElement.java
Tue Feb 6 19:00:30 2007
@@ -17,17 +17,37 @@
package org.apache.woden.wsdl20.xml;
/**
- * Interfaces for WSDL 2.0 elements which may have <documentation>
- * child elements will extend this interface. That is, all WSDL 2.0 elements
- * except the <documentation> element itself.
+ * Represents WSDL 2.0 elements that can have <documentation> child
elements.
+ * That is, all WSDL 2.0 elements except the <documentation> element
itself.
+ * The Java interfaces that correspond to these WSDL elements will extend this
+ * interface to inherit the behaviour for getting, adding and removing
+ * DocumentationElements.
+ * <p>
+ * TODO a removeDocmentationElement method
*
- * @author [EMAIL PROTECTED]
+ * @author John Kaputin ([EMAIL PROTECTED])
*/
public interface DocumentableElement extends WSDLElement
{
+ /**
+ * Create a DocumentationElement with this WSDLElement as its parent and
+ * return a reference to it.
+ * This equates to adding a <documentation> element to any of the
other
+ * WSDL elements (except the <documentation> element itself).
+ *
+ * @return the DocumentationElement
+ */
public DocumentationElement addDocumentationElement();
+ /**
+ * Return the set of DocumentationElements defined directly within this
WSDLElement.
+ * This equates to the set of <documentation> elements declared
within a WSDL
+ * element.
+ * If no DocumentationElements exist, an empty array is returned.
+ *
+ * @return array of DocumentationElement
+ */
public DocumentationElement[] getDocumentationElements();
- //TODO a remove method
+ //TODO a removeDocmentationElement method
}
Modified:
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/DocumentationElement.java
URL:
http://svn.apache.org/viewvc/incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/DocumentationElement.java?view=diff&rev=504421&r1=504420&r2=504421
==============================================================================
---
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/DocumentationElement.java
(original)
+++
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/DocumentationElement.java
Tue Feb 6 19:00:30 2007
@@ -17,16 +17,25 @@
package org.apache.woden.wsdl20.xml;
/**
- * This interface represents the WSDL 2.0 <wsdl:documentation> XML
element.
- * The <wsdl:documentation> element may contain mixed content, but this
- * interface does not attempt to understand that content. Instead it just wraps
- * the <wsdl:documentation> element's content model as a
java.lang.Object.
+ * Represents the WSDL 2.0 <documentation> element.
+ * <p>
+ * The <documentation> element may contain mixed content, but this
+ * interface does not define methods that interpret that content. Instead it
just wraps
+ * the <documentation> element as a java.lang.Object.
+ * <p>
+ * TODO Should use XMLElement as the wrapper type, but also consider if/how to
represent mixed type.
*
- * @author [EMAIL PROTECTED]
+ * @author John Kaputin ([EMAIL PROTECTED])
*/
public interface DocumentationElement extends WSDLElement {
+ /**
+ * @deprecated In M7, to be replaced in M8. See JIRA WODEN-142.
+ */
public void setContent(Object docEl);
+ /**
+ * @deprecated In M7, to be replaced in M8. See JIRA WODEN-142.
+ */
public Object getContent();
}
Modified:
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/EndpointElement.java
URL:
http://svn.apache.org/viewvc/incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/EndpointElement.java?view=diff&rev=504421&r1=504420&r2=504421
==============================================================================
---
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/EndpointElement.java
(original)
+++
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/EndpointElement.java
Tue Feb 6 19:00:30 2007
@@ -23,21 +23,71 @@
import org.apache.woden.types.NCName;
/**
- * This interface represents an <endpoint> element
- * information item, a child element of WSDL <service>.
+ * Represents the WSDL 2.0 <endpoint> element,
+ * declared as a child of the <service> element.
*
- * @author [EMAIL PROTECTED]
+ * @author John Kaputin ([EMAIL PROTECTED])
*/
public interface EndpointElement extends DocumentableElement,
NestedElement
{
+ /**
+ * Set the name of this EndpointElement to the specified NCName.
+ * This corresponds to the <code>name</code> attribute of the
<endpoint> element.
+ *
+ * @param name the NCName that represents the local name of this endpoint
+ */
public void setName(NCName name);
+
+ /**
+ * Return the qualified name of this EndpointElement, which consists of its
+ * local name and the targetNamespace of the enclosing DescriptionElement.
+ *
+ * @return the endpoint QName
+ */
public NCName getName();
- public void setBindingName(QName qname);
+ /**
+ * Specify the name of the BindingElement referred to by this
EndpointElement.
+ * The specified QName corresponds to the <code>binding</code> attribute
of the
+ * <endpoint> element.
+ *
+ * @param bindingName the QName of the binding
+ */
+ public void setBindingName(QName bindingName);
+
+ /**
+ * Return the name of the BindingElement referred to by this
EndpointElement.
+ * This corresponds to the <code>binding</code> attribute of the
+ * <endpoint> element.
+ *
+ * @return the QName of the binding
+ */
public QName getBindingName();
+
+ /**
+ * Return the BindingElement referred to by this EndpointElement.
+ * This equates to the <binding> element referred to by the
<code>binding</code>
+ * attribute of the <endpoint> element.
+ * If this reference cannot be resolved to a BindingElement, this method
will return null.
+ *
+ * @return the BindingElement
+ */
public BindingElement getBindingElement();
- public void setAddress(URI uri);
+ /**
+ * Set the endpoint address of this EndpointElement to the specified URI.
+ * This corresponds to the <code>address</code> attribute of the
<endpoint> element.
+ *
+ * @param address the endpoint address URI
+ */
+ public void setAddress(URI address);
+
+ /**
+ * Return the URI representing the endpoint address of this
EndpointElement.
+ * This corresponds to the <code>address</code> attribute of the
<endpoint> element.
+ *
+ * @return the endpoint address URI
+ */
public URI getAddress();
}
Modified:
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/ImportElement.java
URL:
http://svn.apache.org/viewvc/incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/ImportElement.java?view=diff&rev=504421&r1=504420&r2=504421
==============================================================================
---
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/ImportElement.java
(original)
+++
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/ImportElement.java
Tue Feb 6 19:00:30 2007
@@ -19,11 +19,9 @@
import java.net.URI;
/**
- * This interface represents a <import> XML element
- * information item. It declares the behaviour required to support
- * parsing, creating and manipulating a <import> element.
+ * Represents the WSDL 2.0 <import> element.
*
- * @author [EMAIL PROTECTED]
+ * @author John Kaputin ([EMAIL PROTECTED])
*/
public interface ImportElement extends DocumentableElement
{
Modified:
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/IncludeElement.java
URL:
http://svn.apache.org/viewvc/incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/IncludeElement.java?view=diff&rev=504421&r1=504420&r2=504421
==============================================================================
---
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/IncludeElement.java
(original)
+++
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/IncludeElement.java
Tue Feb 6 19:00:30 2007
@@ -19,11 +19,9 @@
import java.net.URI;
/**
- * This interface represents a <include> XML element
- * information item. It declares the behaviour required to support
- * parsing, creating and manipulating a <include> element.
+ * Represents the WSDL 2.0 <include> element.
*
- * @author [EMAIL PROTECTED]
+ * @author John Kaputin ([EMAIL PROTECTED])
*/
public interface IncludeElement extends DocumentableElement
{
Modified:
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/InterfaceFaultElement.java
URL:
http://svn.apache.org/viewvc/incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/InterfaceFaultElement.java?view=diff&rev=504421&r1=504420&r2=504421
==============================================================================
---
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/InterfaceFaultElement.java
(original)
+++
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/InterfaceFaultElement.java
Tue Feb 6 19:00:30 2007
@@ -34,7 +34,7 @@
* Set the name of this InterfaceFaultElement to the specified NCName.
* This corresponds to the <code>name</code> attribute of the interface
<fault> element.
*
- * @param name the NCName that represents the local name of this interface
fault.
+ * @param name the NCName that represents the local name of this interface
fault
*/
public void setName(NCName name);
@@ -69,10 +69,10 @@
/**
* Return the XmlSchemaElement representing the global schema element
declaration
* referred to by this InterfaceFaultElement.
- * This is resolved from the QName specified in the <code>element</code>
attribute of
- * the interface <fault> element.
- * If this QName cannot be not resolved to an element declaration in a
schema that
- * is visible to the enclosing <description> element, this method
will return null.
+ * This equates to the <xs:element> element referred to by the
<code>element</code>
+ * attribute of the interface <fault> element.
+ * If this reference cannot be resolved to an element declaration in a
schema that
+ * is visible to the enclosing <description>, this method will
return null.
* To be visible, the schema must have been correctly imported or inlined
within
* the <types> element.
*
Modified:
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/InterfaceFaultReferenceElement.java
URL:
http://svn.apache.org/viewvc/incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/InterfaceFaultReferenceElement.java?view=diff&rev=504421&r1=504420&r2=504421
==============================================================================
---
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/InterfaceFaultReferenceElement.java
(original)
+++
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/InterfaceFaultReferenceElement.java
Tue Feb 6 19:00:30 2007
@@ -52,10 +52,10 @@
/**
* Return the InterfaceFaultElement referred to by this
InterfaceFaultReferenceElement.
- * This is resolved from the QName specified in the <code>ref</code>
attribute of
- * the interface operation <infault> or <outfault> element.
- * If this reference is not resolved to an InterfaceFaultElement,
- * this method will return null.
+ * This equates to the interface <fault> element referred to by the
<code>ref</code>
+ * attribute of the interface operation <infault> or
<outfault> element.
+ * If this reference cannot be resolved to an InterfaceFaultElement, this
method will
+ * return null.
*
* @return the InterfaceFaultElement
*/
Modified:
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/InterfaceMessageReferenceElement.java
URL:
http://svn.apache.org/viewvc/incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/InterfaceMessageReferenceElement.java?view=diff&rev=504421&r1=504420&r2=504421
==============================================================================
---
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/InterfaceMessageReferenceElement.java
(original)
+++
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/InterfaceMessageReferenceElement.java
Tue Feb 6 19:00:30 2007
@@ -54,17 +54,15 @@
public NCName getMessageLabel();
/**
- * This is a property of the component model, not the infoset.
- * <p>
- * TODO Post-M7, deprecate/remove this method from this interface.
+ * @deprecated This is a property of the component model, not the infoset,
so it is deprecated in M7
+ * and will be removed for M8 (WODEN-136)
*/
public void setMessageContentModel(String nmToken);
/**
- * This is a property of the component model, not the infoset.
- * <p>
- * TODO Post-M7, deprecate/remove this method from this interface.
+ * @deprecated This is a property of the component model, not the infoset,
so it is deprecated in M7
+ * and will be removed for M8 (WODEN-136)
*/
public String getMessageContentModel();
@@ -91,10 +89,10 @@
/**
* Return the XmlSchemaElement representing the global schema element
declaration
* referred to by this InterfaceMessageReferenceElement.
- * This is resolved from the QName specified in the <code>element</code>
attribute of
- * the interface operation <input> or <output> element.
- * If this QName cannot be not resolved to an element declaration in a
schema that
- * is visible to the enclosing <description> element, this method
will return null.
+ * This equates to the <xs:element> element referred to by the
<code>element</code>
+ * attribute of the interface operation <input> or <output>
element.
+ * If this reference cannot be resolved to an element declaration in a
schema that
+ * is visible to the enclosing <description>, this method will
return null.
* To be visible, the schema must have been correctly imported or inlined
within
* the <types> element.
*
Modified:
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/NestedElement.java
URL:
http://svn.apache.org/viewvc/incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/NestedElement.java?view=diff&rev=504421&r1=504420&r2=504421
==============================================================================
---
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/NestedElement.java
(original)
+++
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/NestedElement.java
Tue Feb 6 19:00:30 2007
@@ -17,15 +17,15 @@
package org.apache.woden.wsdl20.xml;
/**
- * Elements which are nested within a 'top-level' WSDL element will
- * extend this interface. These are the child elements of <interface>,
- * <binding> and <service>.
+ * Represents the WSDL 2.0 elements that are nested within the
<description>
+ * element. That is, all WSDL 2.0 elements except <description> itself.
+ * The Java interfaces that represent these WSDL elements will extend this
+ * interface to inherit behaviour for specifying and accessing their parent
+ * WSDLElement.
* <p>
- * The elements which are not nested are <description>,
- * <import>, <include>, <types>, <interface>,
- * <binding> and <service>.
+ * TODO make DocumentationElement, ImportElement and IncludeElement subtypes
of NestedElement
*
- * @author [EMAIL PROTECTED]
+ * @author John Kaputin ([EMAIL PROTECTED])
*/
public interface NestedElement extends WSDLElement {
Modified:
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/ServiceElement.java
URL:
http://svn.apache.org/viewvc/incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/ServiceElement.java?view=diff&rev=504421&r1=504420&r2=504421
==============================================================================
---
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/ServiceElement.java
(original)
+++
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/ServiceElement.java
Tue Feb 6 19:00:30 2007
@@ -21,20 +21,72 @@
import org.apache.woden.types.NCName;
/**
- * This interface represents the <service> element.
+ * Represents the WSDL 2.0 <service> element.
*
- * @author [EMAIL PROTECTED]
+ * @author John Kaputin ([EMAIL PROTECTED])
*/
public interface ServiceElement extends DocumentableElement,
NestedElement
{
+ /**
+ * Set the name of this ServiceElement to the specified NCName.
+ * This corresponds to the <code>name</code> attribute of the
<service> element.
+ *
+ * @param name the NCName that represents the local name of this service
+ */
public void setName(NCName name);
+
+ /**
+ * Return the qualified name of this ServiceElement, which consists of its
+ * local name and the targetNamespace of the enclosing DescriptionElement.
+ *
+ * @return the service QName
+ */
public QName getName();
- public void setInterfaceName(QName qname);
+ /**
+ * Specify the name of the InterfaceElement referred to by this
ServiceElement.
+ * The specified QName corresponds to the <code>interface</code> attribute
of the
+ * <service> element.
+ *
+ * @param interfaceName the QName of the interface
+ */
+ public void setInterfaceName(QName interfaceName);
+
+ /**
+ * Return the name of the InterfaceElement referred to by this
ServiceElement.
+ * This corresponds to the <code>interface</code> attribute of the
+ * <service> element.
+ *
+ * @return the QName of the interface
+ */
public QName getInterfaceName();
+
+ /**
+ * Return the InterfaceElement referred to by this ServiceElement.
+ * This equates to the <interface> element referred to by the
<code>interface</code>
+ * attribute of the <service> element.
+ * If this reference cannot be resolved to an InterfaceElement, this
method will return null.
+ *
+ * @return the InterfaceElement
+ */
public InterfaceElement getInterfaceElement();
+ /**
+ * Create an EndpointElement with this ServiceElement as its parent and
+ * return a reference to it.
+ * This equates to adding an <endpoint> element to the
<service> element.
+ *
+ * @return the EndpointElement
+ */
public EndpointElement addEndpointElement();
+
+ /**
+ * Return the set of EndpointElements within this ServiceElement.
+ * This equates to the set of <endpoint> elements within the
<service> element.
+ * If no EndpointElements exist, an empty array is returned.
+ *
+ * @return an array of EndpointElement
+ */
public EndpointElement[] getEndpointElements();
}
Modified:
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/TypesElement.java
URL:
http://svn.apache.org/viewvc/incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/TypesElement.java?view=diff&rev=504421&r1=504420&r2=504421
==============================================================================
---
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/TypesElement.java
(original)
+++
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/TypesElement.java
Tue Feb 6 19:00:30 2007
@@ -23,19 +23,9 @@
import org.apache.woden.schema.Schema;
/**
- * This interface represents the <wsdl:types> element.
- * It supports parsing, creating and manipulating a <types> element.
- * <p>
- * The data types used in WSDL elements are typically defined within a
- * <types> element using a type system such as W3C XML Schema.
- * Schemas may be imported or inlined within <types>.
- * A <types> element may contain multiple schema import elements with
- * the same namespace attribute, so the schemaLocation attribute may be used
- * to distinguish them.
- * Likewise, it is valid to have multiple inline schemas, so the id attribute
- * may be used to distinguish them.
+ * Represents the WSDL 2.0 <types> element.
*
- * @author [EMAIL PROTECTED]
+ * @author John Kaputin ([EMAIL PROTECTED])
*/
public interface TypesElement extends DocumentableElement, NestedElement
{
Modified:
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/WSDLElement.java
URL:
http://svn.apache.org/viewvc/incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/WSDLElement.java?view=diff&rev=504421&r1=504420&r2=504421
==============================================================================
---
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/WSDLElement.java
(original)
+++
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/xml/WSDLElement.java
Tue Feb 6 19:00:30 2007
@@ -20,10 +20,10 @@
import org.apache.woden.wsdl20.extensions.ElementExtensible;
/**
- * All WSDL 2.0 element interfaces will directly or indirectly extend this
interface,
- * so it provides a common type for all such elements.
+ * Represents all WSDL 2.0 elements. The Java interfaces representing the WSDL
2.0
+ * elements will directly or indirectly extend this interface.
*
- * @author [EMAIL PROTECTED]
+ * @author John Kaputin ([EMAIL PROTECTED])
*/
public interface WSDLElement extends AttributeExtensible, ElementExtensible
{
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
