Author: jkaputin
Date: Fri Feb  2 10:27:01 2007
New Revision: 502685

URL: http://svn.apache.org/viewvc?view=rev&rev=502685
Log:
Improved the Javadoc for the org.apache.woden.wsdl20 package

Modified:
    incubator/woden/branches/M7/src/org/apache/woden/wsdl20/Binding.java
    incubator/woden/branches/M7/src/org/apache/woden/wsdl20/BindingFault.java
    
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/BindingFaultReference.java
    
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/BindingMessageReference.java
    
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/BindingOperation.java
    incubator/woden/branches/M7/src/org/apache/woden/wsdl20/Description.java
    
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/ElementDeclaration.java
    incubator/woden/branches/M7/src/org/apache/woden/wsdl20/Endpoint.java
    incubator/woden/branches/M7/src/org/apache/woden/wsdl20/Interface.java
    incubator/woden/branches/M7/src/org/apache/woden/wsdl20/InterfaceFault.java
    
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/InterfaceFaultReference.java
    
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/InterfaceMessageReference.java
    
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/InterfaceOperation.java
    incubator/woden/branches/M7/src/org/apache/woden/wsdl20/NestedComponent.java
    incubator/woden/branches/M7/src/org/apache/woden/wsdl20/Service.java
    incubator/woden/branches/M7/src/org/apache/woden/wsdl20/TypeDefinition.java
    incubator/woden/branches/M7/src/org/apache/woden/wsdl20/WSDLComponent.java

Modified: incubator/woden/branches/M7/src/org/apache/woden/wsdl20/Binding.java
URL: 
http://svn.apache.org/viewvc/incubator/woden/branches/M7/src/org/apache/woden/wsdl20/Binding.java?view=diff&rev=502685&r1=502684&r2=502685
==============================================================================
--- incubator/woden/branches/M7/src/org/apache/woden/wsdl20/Binding.java 
(original)
+++ incubator/woden/branches/M7/src/org/apache/woden/wsdl20/Binding.java Fri 
Feb  2 10:27:01 2007
@@ -25,19 +25,62 @@
 /**
  * Represents the Binding component from the WSDL 2.0 Component model.
  * 
- * @author [EMAIL PROTECTED]
+ * @author John Kaputin ([EMAIL PROTECTED])
  */
 public interface Binding extends WSDLComponent
 {
+    /**
+     * Returns a QName representing the {name} property of the Binding 
component.
+     *  
+     * @return QName the qualified name of the Binding
+     */
     public QName getName();
     
+    /**
+     * Represents the {interface} property of the Binding component. This is 
the Interface component
+     * that this Binding defines concrete bindings for.  For an 
'interface-less' or 'generic' binding, 
+     * this method will return null.
+     * 
+     * @return Interface for which bindings are provided by this Binding
+     */
     public Interface getInterface();
     
+    /**
+     * Returns a URI representing the {type} property of the Binding 
component. 
+     * <p>
+     * For example:
+     * <br/>
+     * For a SOAP binding this will be the uri 
"http://www.w3.org/2006/01/wsdl/soap";.
+     * <br/>
+     * For an HTTP binding this will be the uri 
"http://www.w3.org/2006/01/wsdl/http";.
+     * 
+     * @return URI representing the binding type
+     */
     public URI getType();
     
+    /**
+     * Represents the {binding faults} property of the Binding component. This 
is the set of
+     * binding faults declared by this binding. The method will return an 
empty array if there
+     * are no binding faults.
+     * 
+     * @return an array of BindingFault objects
+     */
     public BindingFault[] getBindingFaults();
     
+    /**
+     * Represents the {binding operations} property of the Binding component. 
This is the set of
+     * binding operations declared by this binding. The method will return an 
empty array if there
+     * are no binding operations.
+     * 
+     * @return an array of BindingOperation objects
+     */
     public BindingOperation[] getBindingOperations();
 
+    /**
+     * Returns a WSDLElement that represents the element information item from 
the WSDL 2.0 
+     * infoset that maps to this WSDLComponent. 
+     * 
+     * @return the BindingElement that maps to this Binding
+     */
     public BindingElement toElement();
 }

Modified: 
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/BindingFault.java
URL: 
http://svn.apache.org/viewvc/incubator/woden/branches/M7/src/org/apache/woden/wsdl20/BindingFault.java?view=diff&rev=502685&r1=502684&r2=502685
==============================================================================
--- incubator/woden/branches/M7/src/org/apache/woden/wsdl20/BindingFault.java 
(original)
+++ incubator/woden/branches/M7/src/org/apache/woden/wsdl20/BindingFault.java 
Fri Feb  2 10:27:01 2007
@@ -19,13 +19,26 @@
 import org.apache.woden.wsdl20.xml.BindingFaultElement;
 
 /**
- * This interface represents the BindingFault component from the WSDL 2.0 
Component model.
+ * Represents the BindingFault component from the WSDL 2.0 Component model.
  * 
- * @author [EMAIL PROTECTED]
+ * @author John Kaputin ([EMAIL PROTECTED])
  */
 public interface BindingFault extends NestedComponent 
 {
+    /**
+     * Returns an InterfaceFault representing the {interface fault} property 
of the
+     * BindingFault component. That is, the interface fault that this binding 
fault
+     * provides concrete bindings for.
+     * 
+     * @return an InterfaceFault bound by this BindingFault
+     */
     public InterfaceFault getInterfaceFault();
     
+    /**
+     * Returns a WSDLElement that represents the element information item from 
the WSDL 2.0 
+     * infoset that maps to this WSDLComponent. 
+     * 
+     * @return the BindingFaultElement that maps to this BindingFault
+     */
     public BindingFaultElement toElement();
 }

Modified: 
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/BindingFaultReference.java
URL: 
http://svn.apache.org/viewvc/incubator/woden/branches/M7/src/org/apache/woden/wsdl20/BindingFaultReference.java?view=diff&rev=502685&r1=502684&r2=502685
==============================================================================
--- 
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/BindingFaultReference.java
 (original)
+++ 
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/BindingFaultReference.java
 Fri Feb  2 10:27:01 2007
@@ -19,14 +19,26 @@
 import org.apache.woden.wsdl20.xml.BindingFaultReferenceElement;
 
 /**
- * This interface represents the BindingFaultReference component of the
- * WSDL 2.0 Component model.
+ * Represents the BindingFaultReference component from the WSDL 2.0 Component 
model.
  * 
- * @author [EMAIL PROTECTED]
+ * @author John Kaputin ([EMAIL PROTECTED])
  */
 public interface BindingFaultReference extends NestedComponent
 {
+    /**
+     * Returns an InterfaceFaultReference representing the {interface fault 
reference} 
+     * property of the BindingFaultReference component. That is, the interface 
fault 
+     * reference that this binding fault reference provides concrete bindings 
for.
+     * 
+     * @return an InterfaceFaultReference bound by this BindingFaultReference
+     */
     public InterfaceFaultReference getInterfaceFaultReference();
     
+    /**
+     * Returns a WSDLElement that represents the element information item from 
the WSDL 2.0 
+     * infoset that maps to this WSDLComponent. 
+     * 
+     * @return the BindingFaultReferenceElement that maps to this 
BindingFaultReference
+     */
     public BindingFaultReferenceElement toElement();
 }

Modified: 
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/BindingMessageReference.java
URL: 
http://svn.apache.org/viewvc/incubator/woden/branches/M7/src/org/apache/woden/wsdl20/BindingMessageReference.java?view=diff&rev=502685&r1=502684&r2=502685
==============================================================================
--- 
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/BindingMessageReference.java
 (original)
+++ 
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/BindingMessageReference.java
 Fri Feb  2 10:27:01 2007
@@ -19,14 +19,26 @@
 import org.apache.woden.wsdl20.xml.BindingMessageReferenceElement;
 
 /**
- * This interface represents the BindingMessageReference component 
- * of the WSDL 2.0 Component model
+ * Represents the BindingMessageReference component from the WSDL 2.0 
Component model
  * 
- * @author [EMAIL PROTECTED]
+ * @author John Kaputin ([EMAIL PROTECTED])
  */
 public interface BindingMessageReference extends NestedComponent 
 {
+    /**
+     * Returns an InterfaceMessageReference representing the {interface 
message reference} 
+     * property of the BindingMessageReference component. That is, the 
interface message 
+     * reference that this binding message reference provides concrete 
bindings for.
+     * 
+     * @return an InterfaceMessageReference bound by this 
BindingMessageReference
+     */
     public InterfaceMessageReference getInterfaceMessageReference();
     
+    /**
+     * Returns a WSDLElement that represents the element information item from 
the WSDL 2.0 
+     * infoset that maps to this WSDLComponent. 
+     * 
+     * @return the BindingMessageReferenceElement that maps to this 
BindingMessageReference
+     */
     public BindingMessageReferenceElement toElement();
 }

Modified: 
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/BindingOperation.java
URL: 
http://svn.apache.org/viewvc/incubator/woden/branches/M7/src/org/apache/woden/wsdl20/BindingOperation.java?view=diff&rev=502685&r1=502684&r2=502685
==============================================================================
--- 
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/BindingOperation.java 
(original)
+++ 
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/BindingOperation.java 
Fri Feb  2 10:27:01 2007
@@ -19,17 +19,46 @@
 import org.apache.woden.wsdl20.xml.BindingOperationElement;
 
 /**
- * This interface represents the BindingOperation component from the WSDL 2.0 
Component model.
+ * Represents the BindingOperation component from the WSDL 2.0 Component model.
  * 
- * @author [EMAIL PROTECTED]
+ * @author John Kaputin ([EMAIL PROTECTED])
  */
 public interface BindingOperation extends NestedComponent 
 {
+    /**
+     * Returns an InterfaceOperation representing the {interface operation} 
property
+     * of the BindingOperation component. That is, the interface operation 
that this
+     * binding operation provides concrete bindings for.
+     * 
+     * @return InterfaceOperation bound by this BindingOperation
+     */
     public InterfaceOperation getInterfaceOperation();
     
+    /**
+     * Represents the {binding message references} property of the 
BindingOperation component.
+     * This is the set of binding message references declared by this binding 
operation.
+     * This method will return an empty array if there are no binding message 
references for
+     * this binding operation.
+     * 
+     * @return an array of BindingMessageReference
+     */
     public BindingMessageReference[] getBindingMessageReferences();
     
+    /**
+     * Represents the {binding fault references} property of the 
BindingOperation component.
+     * This is the set of binding fault references declared by this binding 
operation.
+     * This method will return an empty array if there are no binding fault 
references for
+     * this binding operation.
+     * 
+     * @return an array of BindingFaultReference
+     */
     public BindingFaultReference[] getBindingFaultReferences();
 
+    /**
+     * Returns a WSDLElement that represents the element information item from 
the WSDL 2.0 
+     * infoset that maps to this WSDLComponent. 
+     * 
+     * @return the BindingOperationElement that maps to this BindingOperation
+     */
     public BindingOperationElement toElement();
 }

Modified: 
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/Description.java
URL: 
http://svn.apache.org/viewvc/incubator/woden/branches/M7/src/org/apache/woden/wsdl20/Description.java?view=diff&rev=502685&r1=502684&r2=502685
==============================================================================
--- incubator/woden/branches/M7/src/org/apache/woden/wsdl20/Description.java 
(original)
+++ incubator/woden/branches/M7/src/org/apache/woden/wsdl20/Description.java 
Fri Feb  2 10:27:01 2007
@@ -22,76 +22,132 @@
 
 
 /**
- * This interface represents the Description component from the WSDL Component
- * Model, as described in the WSDL 2.0 specification.  It provides an abstract
+ * Represents the Description component from the WSDL 2.0 Component model, 
+ * as described in the W3C WSDL 2.0 specification.  It provides an abstract
  * view of a WSDL document by flattening the composite document structure 
created 
- * by the use of &lt;wsdl:import&gt; or &lt;wsdl:include&gt; into a single 
top-level
- * WSDL Description containing all of the inlined, imported or included WSDL 
content.
- * In doing so, it elimates the need to 'walk' the XML tree to access the WSDL 
content.
- * This also means that a Description component may not correspond 1-to-1 
- * to a lt;wsdl:description&gt; element in XML (i.e. it may contain WSDL 
content 
- * from composite WSDL documents, each with its own &lt;wsdl:description&gt; 
root
- * element). 
+ * by the use of &lt;wsdl:import&gt; or &lt;wsdl:include&gt; elements into a 
single
+ * WSDL Description component containing the WSDL components declared within 
+ * the root &lt;description&gt; and within any imported or included 
descriptions.
+ * <p>
+ * In other words, if a WSDL component model is derived from composite WSDL 
document
+ * made up of WSDL imports or includes, then its Description component acts as 
a 
+ * container for all of the top-level WSDL components in the WSDL tree, 
starting with the 
+ * root &lt;description&gt; element. These top-level WSDL components include 
Interface,
+ * Binding, Service, ElementDeclaration and TypeDefinition.
  * 
- * @author [EMAIL PROTECTED]
+ * @author John Kaputin ([EMAIL PROTECTED])
  */
 public interface Description extends WSDLComponent 
 {
     
     /**
      * Represents the {interfaces} property of the Description component. This 
is the set of
-     * all interfaces available to the description, including those that are 
directly declared
-     * and any that are imported or included.
+     * all interfaces available to the Description, including those that are 
declared in the
+     * root WSDL document and any declared in included or imported WSDL 
documents.
      * 
      * @return an array of Interface objects
      */
     public Interface[] getInterfaces();
     
+    /**
+     * Returns an Interface with the specified name from the {interfaces} 
property of this 
+     * Description.
+     * 
+     * @param name the QName of the required Interface
+     * @return an Interface with the specified name
+     */
     public Interface getInterface(QName name);
     
     /**
      * Represents the {bindings} property of the Description component. This 
is the set of
-     * all bindings available to the description, including those that are 
directly declared
-     * and any that are imported or included.
+     * all bindings available to the Description, including those that are 
declared in the
+     * root WSDL document and any declared in included or imported WSDL 
documents.
      * 
      * @return an array of Binding objects
      */
     public Binding[] getBindings();
     
+    /**
+     * Returns a Binding with the specified name from the {bindings} property 
of this 
+     * Description.
+     * 
+     * @param name the QName of the required Binding
+     * @return a Binding with the specified name
+     */
     public Binding getBinding(QName name);
     
     /**
      * Represents the {services} property of the Description component. This 
is the set of
-     * all services available to the description, including those that are 
directly declared
-     * and any that are imported or included.
+     * all services available to the Description, including those that are 
declared in the
+     * root WSDL document and any declared in included or imported WSDL 
documents.
      * 
      * @return an array of Service objects
      */
     public Service[] getServices();
 
+    /**
+     * Returns a Service with the specified name from the {services} property 
of this 
+     * Description.
+     * 
+     * @param name the QName of the required Service
+     * @return a Service with the specified name
+     */
     public Service getService(QName name);
 
     /**
      * Represents the {element declarations} property of the Description 
component. This is the set of
-     * all global element declarations available to the description, including 
those that are directly 
-     * declared in this description's &lt;types&gt; element and any that are 
that are imported or included.
+     * all global element declarations available to the Description, including 
those that are declared 
+     * by schemas inlined or imported by the root WSDL document and those 
declared by schemas inlined 
+     * or imported by WSDL documents that the root WSDL document includes or 
imports, directly or 
+     * indirectly.
      * 
      * @return an array of ElementDeclaration objects
      */
     public ElementDeclaration[] getElementDeclarations();
     
+    /**
+     * Returns the ElementDeclaration with the specified name from the set of 
ElementDeclarations 
+     * represented by the {element declarations} property of this Description.
+     * 
+     * @param name the QName of the required ElementDeclaration
+     * @return the named ElementDeclaration
+     */
     public ElementDeclaration getElementDeclaration(QName name);
     
     /**
      * Represents the {type definitions} property of the Description 
component. This is the set of
-     * all global type definitions available to the description, including 
those that are directly 
-     * declared in this description's &lt;types&gt; element and any that are 
that are imported or included.
+     * all global type definitions available to the Description, including 
those that are defined 
+     * by schemas inlined or imported by the root WSDL document and those 
defined by schemas inlined 
+     * or imported by WSDL documents that the root WSDL document includes or 
imports, directly or 
+     * indirectly.
      * 
      * @return an array of TypeDefinition objects
      */
     public TypeDefinition[] getTypeDefinitions();
     
-    public TypeDefinition getTypeDefinition(QName qname);
+    /**
+     * Returns the TypeDefinition with the specified name from the set of 
TypeDefinitions 
+     * represented by the {type definitions} property of this Description.
+     * 
+     * @param name the QName of the required TypeDefinition
+     * @return the named TypeDefinition
+     */
+    public TypeDefinition getTypeDefinition(QName name);
     
+    /**
+     * Returns a WSDLElement that represents the element information item from 
the WSDL 2.0 
+     * infoset that maps to this WSDLComponent. 
+     * <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 &lt;wsdl:description&gt; elements.
+     * <p>
+     * If the Component model has been derived from such a composite WSDL 
infoset, the behaviour 
+     * of this method is to return the DescriptionElement that represents the 
root 
+     * &lt;wsdl:description&gt; element.  
+     * 
+     * @return the DescriptionElement that maps to this Description
+     */
     public DescriptionElement toElement();
 }

Modified: 
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/ElementDeclaration.java
URL: 
http://svn.apache.org/viewvc/incubator/woden/branches/M7/src/org/apache/woden/wsdl20/ElementDeclaration.java?view=diff&rev=502685&r1=502684&r2=502685
==============================================================================
--- 
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/ElementDeclaration.java 
(original)
+++ 
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/ElementDeclaration.java 
Fri Feb  2 10:27:01 2007
@@ -21,49 +21,54 @@
 import javax.xml.namespace.QName;
 
 /**
- * This interface represents the ElementDeclaration component described
- * in the WSDL 2.0 Component Model specification (within the Description 
- * Component section). An ElementDeclaration refers to an element, such as
- * a global element declaration in the XML Schema type system 
- * (&lt;xs:element&gt;), that describes the content of WSDL input, output
- * and fault messages.  However, it does not impose XML Schema as the type 
system.  
- * It returns a String representing the content model or type system 
- * (e.g. "http://www.w3.org/2001/XMLSchema";) and a java.lang.Object 
- * representing the content of the element declaration. This Object may
- * be cast to a type appropriate for the content model.
+ * Represents the ElementDeclaration component described in the WSDL 2.0 
component 
+ * model (within the Description Component section of the W3C WSDL 2.0 spec). 
+ * It describes the content of WSDL input, output and fault messages.
+ * This component represents global element declarations such as top-level,
+ * named element declarations in W3C XML Schema (i.e. &lt;xs:element&gt;).
+ * <p>
+ * However, it does not mandate W3C XML Schema as the type system. 
+ * It defines behaviour to query the type system and the underlying content
+ * model or API being used to represent the element declarations, and to 
+ * return a java.lang.Object representing the actual element declaration 
object.
+ * Based on the type system and content model, the application must cast this
+ * Object to the appropriate type to manipulate its contents.
+ * <p>
+ * Note that while ElementDeclaration is described along with the Component 
model
+ * in the W3C WSDL 2.0 specification, it is not a WSDL component itself. 
+ * It simply provides a way of representing components from the underlying 
type 
+ * system within the WSDL Component model.
  * 
- * TODO consider whether this interface should extend WSDLComponent too
- * (i.e. it is described in the spec within the Description component section, 
- * but it doesn't correspond directly to a WSDL element).
- * 
- * @author [EMAIL PROTECTED]
+ * @author John Kaputin ([EMAIL PROTECTED])
  */
 public interface ElementDeclaration {
     
     /**
-     * A constant representing the DOM API, 
-     * used to indicate the content model.
+     * A constant representing the DOM API. This may be used to indicate the 
+     * content model of the underlying element declaration.
      */
     public static final String API_W3C_DOM =
         "org.w3c.dom";
 
     /**
-     * A constant representing the Apache Ws-Commons XmlSchema API, 
-     * used to indicate the content model.
+     * A constant representing the Apache WS-Commons XmlSchema API. This may 
be used to 
+     * indicate the content model of the underlying element declaration.
      */
     public static final String API_APACHE_WS_XS =
         "org.apache.ws.commons.schema";
 
     /**
-     * @return the QName identifying this element declaration in the
-     * underlying type system definition.
-     *  
+     * Representing the {name} property of the ElementDeclaration component, 
this 
+     * method returns the qualified name of this ElementDeclaration.
+     * 
+     * @return the QName that identifies this ElementDeclaration
      */
     public QName getName();
     
     /**
-     * Indicates the underlying type system of this element declaration.
-     * For example, "http://www.w3.org/2001/XMLSchema"; indicates the W3 XML 
Schema
+     * Representing the {system} property of the ElementDeclaration component, 
this
+     * method indicates the type system from which this element declaration is 
derived.
+     * For example, "http://www.w3.org/2001/XMLSchema"; indicates the W3C XML 
Schema
      * type system.
      *  
      * @return the URI identifying the type system
@@ -71,28 +76,30 @@
     public URI getSystem();
     
     /**
-     * Indicates the type of model or API used to represent components from 
the 
-     * underlying type system identified by the getSystem() method.
+     * Indicates the type of object model or API which should be used to 
+     * access the content of the underlying element declaration.
+     * This can be used to determine how to cast the Object returned by
+     * the <code>getContent()</code> method.
      * <p>
      * For example:
      * <ul>
-     * <li>"org.w3c.dom" indicates that the DOM API is used, so the element 
declaration
-     * content will be represented by a org.w3c.dom.Element.
-     * <li>"org.apache.ws.commons.schema" indicates that the XmlSchema API 
from the
-     * Apache WebServices project is used, so an XmlSchemaElement will 
represent the 
-     * element declaration content. 
+     * <li>The content model "org.w3c.dom" indicates that the DOM API should 
be used, 
+     * so the type org.w3c.dom.Element will be used to represent the content 
of the
+     * element declaration.
+     * <li>The content model "org.apache.ws.commons.schema" indicates that the 
+     * WS-Commons XmlSchema API from the Apache WebServices project is used, 
+     * so an org.apache.ws.commons.schema.XmlSchemaElement will be used to 
represent the 
+     * content of the element declaration. 
      * </ul>
      * 
-     * @return a String identifying the content model or API used to represent 
this 
-     * element declaration
+     * @return a String identifying the element declaration's content model
      */
     public String getContentModel();
     
     /**
-     * Returns the content of the element declaration in an object
-     * specific to the underlying content model API. The caller may then
-     * cast this Object to the appropriate type, based on the content model
-     * API indicated by the getContent() method.
+     * Returns the underlying element declaration as a java.lang.Object, which 
should
+     * be cast to the appropriate type as indicated by the 
<code>getContentModel()</code> 
+     * method.
      * 
      * @return the Object representing the content of the element declaration
      */

Modified: incubator/woden/branches/M7/src/org/apache/woden/wsdl20/Endpoint.java
URL: 
http://svn.apache.org/viewvc/incubator/woden/branches/M7/src/org/apache/woden/wsdl20/Endpoint.java?view=diff&rev=502685&r1=502684&r2=502685
==============================================================================
--- incubator/woden/branches/M7/src/org/apache/woden/wsdl20/Endpoint.java 
(original)
+++ incubator/woden/branches/M7/src/org/apache/woden/wsdl20/Endpoint.java Fri 
Feb  2 10:27:01 2007
@@ -28,11 +28,35 @@
  */
 public interface Endpoint extends NestedComponent 
 {
+    /**
+     * Returns the local name representing the {name} property of this 
Endpoint.
+     * 
+     * @return NCName representing the name of this Endpoint
+     */
     public NCName getName();
     
+    /**
+     * Represents the {binding} property of the Endpoint component. This is 
the Binding component
+     * that this Endpoint is associated with.
+     * 
+     * @return Binding associated with this Endpoint
+     */
     public Binding getBinding();
     
+    /**
+     * Returns a URI that represents the {address} property of this Endpoint.
+     * This is the network address at which the parent service can be found 
using the
+     * binding associated with this endpoint.
+     * 
+     * @return the URI address of the Service via this Endpoint
+     */
     public URI getAddress();
     
+    /**
+     * Returns a WSDLElement that represents the element information item from 
the WSDL 2.0 
+     * infoset that maps to this WSDLComponent. 
+     * 
+     * @return the EndpointElement that maps to this Endpoint
+     */
     public EndpointElement toElement();
 }

Modified: incubator/woden/branches/M7/src/org/apache/woden/wsdl20/Interface.java
URL: 
http://svn.apache.org/viewvc/incubator/woden/branches/M7/src/org/apache/woden/wsdl20/Interface.java?view=diff&rev=502685&r1=502684&r2=502685
==============================================================================
--- incubator/woden/branches/M7/src/org/apache/woden/wsdl20/Interface.java 
(original)
+++ incubator/woden/branches/M7/src/org/apache/woden/wsdl20/Interface.java Fri 
Feb  2 10:27:01 2007
@@ -22,25 +22,45 @@
 
 /**
  * Represents the Interface component from the WSDL 2.0 Component model.
- * This component provides a read-only, abstract view of the WSDL 
- * interface, including any interface information defined within
- * imported or included WSDL documents. 
+ * Defines behaviour for accessing the WSDL components nested within
+ * the Interface component, including those inherited via Interface extension.
  *
- * @author [EMAIL PROTECTED]
+ * @author John Kaputin ([EMAIL PROTECTED])
  */
 public interface Interface  extends WSDLComponent 
 {
-    
+    /**
+     * Returns the qualified name representing the {name} property of this 
Interface.
+     * 
+     * @return QName representing the name of this Interface
+     */
     public QName getName();
     
-    public Interface getExtendedInterface(QName qname);
-    
+    /**
+     * Represents the {extended interfaces} property of the Interface 
component. 
+     * This is the set of declared Interface components that this Interface 
directly 
+     * extends, but does not include any Interfaces that those Interfaces 
extend.
+     * The method will return an empty array if there are no extended 
interfaces.
+     * 
+     * @return an array of Interface components
+     */
     public Interface[] getExtendedInterfaces();
     
     /**
-     * Returns the set of InterfaceFault components representing the 
{interface faults} 
-     * property of this Interface. That is, the InterfaceFaults declared by 
this Interface 
-     * but not those declared by any Interfaces it extends, directly or 
indirectly.
+     * Return the named Interface from the {extended interfaces} property of 
this Interface.
+     * That is, from the set of declared Interfaces that this Interface 
directly extends.
+     * If null is specified for the name, this method will return null.
+     * 
+     * @param interfaceName the qualified name of the required Interface
+     * @return the named Interface
+     */
+    public Interface getExtendedInterface(QName interfaceName);
+    
+    /**
+     * Represents the {interface faults} property of the Interface component. 
This is the set of
+     * interface faults declared directly by this interface, but not those 
defined by any 
+     * interfaces that this interface extends.
+     * The method will return an empty array if there are no interface faults.
      * 
      * @return array of InterfaceFault components
      */
@@ -48,8 +68,9 @@
     
     /**
      * Returns the InterfaceFault with the specified name from the {interface 
faults}
-     * property of this Interface. That is, a named InterfaceFault declared by 
this Interface 
-     * only, which excludes any inherited directly or indirectly from extended 
Interfaces.
+     * property of this Interface. That is, from the set of InterfaceFaults 
declared 
+     * directly by this Interface and excluding any inherited directly or 
indirectly 
+     * from extended Interfaces.
      * If the name parameter is null, this method will return null.
      * 
      * @param faultName the qualified name of the InterfaceFault
@@ -59,8 +80,9 @@
     
     /**
      * Returns the set of all InterfaceFault components available to this 
Interface,
-     * which includes those declared by this Interface and those declared by 
any Interfaces 
+     * which includes those declared by this Interface and those defined by 
any Interfaces 
      * it extends, directly or indirectly. 
+     * The method will return an empty array if there are no interface faults.
      * 
      * @return array of InterfaceFault components
      */
@@ -69,7 +91,7 @@
     /**
      * Returns the InterfaceFault with the specified name from the set of all 
InterfaceFaults
      * available to this Interface, which includes those declared by this 
Interface and those
-     * declared by any Interfaces it extends, directly or indirectly.
+     * defined by any Interfaces it extends, directly or indirectly.
      * If the name parameter is null, this method will return null.
      * 
      * @param faultName the qualified name of the InterfaceFault
@@ -78,9 +100,10 @@
     public InterfaceFault getFromAllInterfaceFaults(QName faultName);
     
     /**
-     * Returns the set of InterfaceOperation components representing the 
{interface operations} 
-     * property of this Interface. That is, the InterfaceOperations declared 
by this Interface 
-     * but not those declared by any Interfaces it extends, directly or 
indirectly.
+     * Represents the {interface operations} property of the Interface 
component. This is the set 
+     * of interface operations declared directly by this interface, but not 
those defined by any 
+     * interfaces that this interface extends.
+     * The method will return an empty array if there are no interface 
operations.
      * 
      * @return array of InterfaceOperation components
      */
@@ -88,8 +111,9 @@
     
     /**
      * Returns the InterfaceOperation with the specified name from the 
{interface operations}
-     * property of this Interface. That is, a named InterfaceOperation 
declared by this Interface 
-     * only, which excludes any inherited directly or indirectly from extended 
Interfaces.
+     * property of this Interface. That is, from the set of 
InterfaceOperations declared directly
+     * by this Interface and excluding any inherited directly or indirectly 
from extended 
+     * Interfaces.
      * If the name parameter is null, this method will return null.
      * 
      * @param operName the qualified name of the required InterfaceOperation
@@ -98,9 +122,10 @@
     public InterfaceOperation getInterfaceOperation(QName operName);
     
     /**
-     * Returns the set of all InterfaceOperation components referenceable by 
this Interface,
-     * include those declared by this Interface and those declared by the 
Interfaces 
+     * Returns the set of all InterfaceOperation components available to this 
Interface,
+     * which includes those declared by this Interface and those defined by 
the Interfaces 
      * it extends, directly or indirectly.
+     * The method will return an empty array if there are no interface 
operations.
      * 
      * @return array of InterfaceOperation components
      */
@@ -109,7 +134,7 @@
     /**
      * Returns the InterfaceOperation with the specified name from the set of 
all InterfaceOperations
      * available to this Interface, which includes those declared by this 
Interface and those
-     * declared by any Interfaces it extends, directly or indirectly. 
+     * defined by any Interfaces it extends, directly or indirectly. 
      * If the name parameter is null, this method will return null.
      * 
      * @param operName the qualified name of the InterfaceOperation
@@ -117,6 +142,12 @@
      */
     public InterfaceOperation getFromAllInterfaceOperations(QName operName);
     
+    /**
+     * Returns a WSDLElement that represents the element information item from 
the WSDL 2.0 
+     * infoset that maps to this WSDLComponent. 
+     * 
+     * @return the InterfaceElement that maps to this Interface
+     */
     public InterfaceElement toElement();
     
 }

Modified: 
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/InterfaceFault.java
URL: 
http://svn.apache.org/viewvc/incubator/woden/branches/M7/src/org/apache/woden/wsdl20/InterfaceFault.java?view=diff&rev=502685&r1=502684&r2=502685
==============================================================================
--- incubator/woden/branches/M7/src/org/apache/woden/wsdl20/InterfaceFault.java 
(original)
+++ incubator/woden/branches/M7/src/org/apache/woden/wsdl20/InterfaceFault.java 
Fri Feb  2 10:27:01 2007
@@ -22,14 +22,33 @@
 
 
 /**
- * @author [EMAIL PROTECTED]
+ * Represents the InterfaceFault component from the WSDL 2.0 Component model.
+ * 
+ * @author John Kaputin ([EMAIL PROTECTED])
  */
 public interface InterfaceFault extends NestedComponent {
 
+    /**
+     * Returns the qualified name representing the {name} property of this 
InterfaceFault.
+     * 
+     * @return QName representing the name of this InterfaceFault
+     */
     public QName getName();
     
+    /**
+     * Returns the ElementDeclaration representing the {element declaration} 
property
+     * of this InterfaceFault. This describes the content or "payload" of the 
fault.
+     * 
+     * @return the ElementDeclaration that describes the fault content.
+     */
     public ElementDeclaration getElementDeclaration();
     
+    /**
+     * Returns a WSDLElement that represents the element information item from 
the WSDL 2.0 
+     * infoset that maps to this WSDLComponent. 
+     * 
+     * @return the InterfaceFaultElement that maps to this InterfaceFault
+     */
     public InterfaceFaultElement toElement();
     
 }

Modified: 
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/InterfaceFaultReference.java
URL: 
http://svn.apache.org/viewvc/incubator/woden/branches/M7/src/org/apache/woden/wsdl20/InterfaceFaultReference.java?view=diff&rev=502685&r1=502684&r2=502685
==============================================================================
--- 
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/InterfaceFaultReference.java
 (original)
+++ 
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/InterfaceFaultReference.java
 Fri Feb  2 10:27:01 2007
@@ -21,19 +21,46 @@
 import org.apache.woden.wsdl20.xml.InterfaceFaultReferenceElement;
 
 /**
- * This interface represents the InterfaceFaultReference component
- * of the WSDL 2.0 Component model.
+ * Represents the InterfaceFaultReference component from the WSDL 2.0 
Component model.
  * 
- * @author [EMAIL PROTECTED]
+ * @author John Kaputin ([EMAIL PROTECTED])
  */
 public interface InterfaceFaultReference extends NestedComponent {
     
+    
+    /**
+     * Returns an InterfaceFault representing the {interface fault} property 
of this
+     * InterfaceFaultReference. It identifies the interface fault that is 
associated 
+     * with the parent interface operation by this interface fault reference.
+     * 
+     * @return an InterfaceFault associated by this InterfaceFaultReference
+     */
     public InterfaceFault getInterfaceFault();
     
+    /**
+     * Returns an NCName representing the {message label} property of this 
InterfaceFaultReference.
+     * This associates the fault with a placeholder message in the message 
exchange pattern
+     * identified by the parent interface operation.
+     * 
+     * @return an NCName representing the message label
+     */
     public NCName getMessageLabel();
     
+    /**
+     * Returns an enumerated type, Direction, that represents the {direction} 
property
+     * of this InterfaceFaultReference. This indicates the direction in which 
this fault
+     * is used; 'in' or 'out'.
+     * 
+     * @return the Direction of this fault
+     */
     public Direction getDirection();
     
+    /**
+     * Returns a WSDLElement that represents the element information item from 
the WSDL 2.0 
+     * infoset that maps to this WSDLComponent. 
+     * 
+     * @return the InterfaceFaultReferenceElement that maps to this 
InterfaceFaultReference
+     */
     public InterfaceFaultReferenceElement toElement();
     
 }

Modified: 
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/InterfaceMessageReference.java
URL: 
http://svn.apache.org/viewvc/incubator/woden/branches/M7/src/org/apache/woden/wsdl20/InterfaceMessageReference.java?view=diff&rev=502685&r1=502684&r2=502685
==============================================================================
--- 
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/InterfaceMessageReference.java
 (original)
+++ 
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/InterfaceMessageReference.java
 Fri Feb  2 10:27:01 2007
@@ -22,26 +22,55 @@
 
 
 /**
- * @author [EMAIL PROTECTED]
+ * Represents the InterfaceMessageReference component from the WSDL 2.0 
Component model.
+ * 
+ * @author John Kaputin ([EMAIL PROTECTED])
  */
 public interface InterfaceMessageReference extends NestedComponent {
     
+    /**
+     * Returns an NCName representing the {message label} property of this 
+     * InterfaceMessageReference. This associates the message with a 
placeholder message
+     * in the message exchange pattern identified by the parent interface 
operation.
+     * 
+     * @return an NCName representing the message label
+     */
     public NCName getMessageLabel();
     
+    /**
+     * Returns an enumerated type, Direction, that represents the {direction} 
property
+     * of this InterfaceMessageReference. This indicates the direction in 
which this message
+     * is used; 'in' or 'out'.
+     * 
+     * @return the Direction of this message
+     */
     public Direction getDirection();
     
     /**
-     * Represents a token indicating the type of message content. 
+     * Returns a String representing the {message content model} property of 
this
+     * InterfaceMessageReference. This specifies a token indicating the type 
of message content. 
      * '#any' means any single element, '#none' means no message content, 
      * '#other' means non-XML extension type system and '#element' means 
      * XML Schema global element definition.
      *   
-     * @return string representing the type of message content
+     * @return String representing the type of message content
      */
     public String getMessageContentModel();
     
+    /**
+     * Returns the ElementDeclaration representing the {element declaration} 
property
+     * of this InterfaceMessageReference. This describes the content or 
"payload" of the message.
+     * 
+     * @return the ElementDeclaration that describes the message content.
+     */
     public ElementDeclaration getElementDeclaration();
     
+    /**
+     * Returns a WSDLElement that represents the element information item from 
the WSDL 2.0 
+     * infoset that maps to this WSDLComponent. 
+     * 
+     * @return the InterfaceMessageReferenceElement that maps to this 
InterfaceMessageReference
+     */
     public InterfaceMessageReferenceElement toElement();
     
 }

Modified: 
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/InterfaceOperation.java
URL: 
http://svn.apache.org/viewvc/incubator/woden/branches/M7/src/org/apache/woden/wsdl20/InterfaceOperation.java?view=diff&rev=502685&r1=502684&r2=502685
==============================================================================
--- 
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/InterfaceOperation.java 
(original)
+++ 
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/InterfaceOperation.java 
Fri Feb  2 10:27:01 2007
@@ -23,20 +23,63 @@
 import org.apache.woden.wsdl20.xml.InterfaceOperationElement;
 
 /**
- * @author [EMAIL PROTECTED]
+ * Represents the InterfaceMessageReference component from the WSDL 2.0 
Component model.
+ * 
+ * @author John Kaputin ([EMAIL PROTECTED])
  */
 public interface InterfaceOperation extends NestedComponent {
 
+    /**
+     * Returns the qualified name representing the {name} property of this 
InterfaceOperation.
+     * 
+     * @return QName representing the name of this InterfaceOperation
+     */
     public QName getName();
     
+    /**
+     * Returns a URI representing the {message exchange pattern} property of 
this 
+     * InterfaceOperation.
+     * 
+     * @return URI of the message exchange pattern.
+     */
     public URI getMessageExchangePattern();
     
+    /**
+     * Represents the {interface message references} property of the 
InterfaceOperation component.
+     * This is the set of interface message references declared by this 
interface operation.
+     * This method will return an empty array if there are no interface 
message references for
+     * this interface operation.
+     * 
+     * @return an array of InterfaceMessageReference
+     */
     public InterfaceMessageReference[] getInterfaceMessageReferences();
     
+    /**
+     * Represents the {interface fault references} property of the 
InterfaceOperation component.
+     * This is the set of interface fault references defined by this interface 
operation.
+     * This method will return an empty array if there are no interface fault 
references for
+     * this interface operation.
+     * 
+     * @return an array of InterfaceFaultReference
+     */
     public InterfaceFaultReference[] getInterfaceFaultReferences();
     
+    /**
+     * Represents the {style} property of the InterfaceOperation component.
+     * This is a set of URIs which specify the rules that constrain the 
content of
+     * input and output messages and faults of the interface operation.
+     * This method will return an empty array if there are no style URIs.
+     * 
+     * @return an array of URI
+     */
     public URI[] getStyle();
     
+    /**
+     * Returns a WSDLElement that represents the element information item from 
the WSDL 2.0 
+     * infoset that maps to this WSDLComponent. 
+     * 
+     * @return the InterfaceOperationElement that maps to this 
InterfaceOperation
+     */
     public InterfaceOperationElement toElement();
     
 }

Modified: 
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/NestedComponent.java
URL: 
http://svn.apache.org/viewvc/incubator/woden/branches/M7/src/org/apache/woden/wsdl20/NestedComponent.java?view=diff&rev=502685&r1=502684&r2=502685
==============================================================================
--- 
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/NestedComponent.java 
(original)
+++ 
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/NestedComponent.java 
Fri Feb  2 10:27:01 2007
@@ -17,17 +17,33 @@
 package org.apache.woden.wsdl20;
 
 /**
- * Components which are nested within a 'top-level' component will extend
- * this interface. These are the sub components of
- * Interface, Binding and Service. 
+ * Represents a super-type of all WSDL Components which are 'nested' directly
+ * or indirectly within the 'top-level' WSDL components; Interface, Binding 
+ * and Service. 
+ * This interface defines behaviour for retrieving the parent WSDL component.
  * <p>
- * The components which are not nested are Description, Interface, 
- * Binding, Service, ElementDeclaration and TypeDefinition.
+ * The nested WSDL components are:
+ * <ul>
+ *   <li>InterfaceFault</li>
+ *   <li>InterfaceOperation</li>
+ *   <li>InterfaceFaultReference</li>
+ *   <li>InterfaceMessageReference</li>
+ *   <li>BindingFault</li>
+ *   <li>BindingOperation</li>
+ *   <li>BindingFaultReference</li>
+ *   <li>BindingMessageReference</li>
+ *   <li>Endpoint</li>
+ * </ul>
  * 
- * @author [EMAIL PROTECTED]
+ * @author John Kaputin ([EMAIL PROTECTED])
  */
 public interface NestedComponent extends WSDLComponent {
 
+    /**
+     * Returns a WSDLComponent representing the parent of this nested 
component.
+     * 
+     * @return the parent WSDLComponent
+     */
     public WSDLComponent getParent();
     
 }

Modified: incubator/woden/branches/M7/src/org/apache/woden/wsdl20/Service.java
URL: 
http://svn.apache.org/viewvc/incubator/woden/branches/M7/src/org/apache/woden/wsdl20/Service.java?view=diff&rev=502685&r1=502684&r2=502685
==============================================================================
--- incubator/woden/branches/M7/src/org/apache/woden/wsdl20/Service.java 
(original)
+++ incubator/woden/branches/M7/src/org/apache/woden/wsdl20/Service.java Fri 
Feb  2 10:27:01 2007
@@ -22,17 +22,53 @@
 import org.apache.woden.wsdl20.xml.ServiceElement;
 
 /**
+ * Represents the Service component from the WSDL 2.0 Component model.
+ * 
  * @author John Kaputin ([EMAIL PROTECTED])
  */
 public interface Service extends WSDLComponent
 {
+    /**
+     * Returns the qualified name representing the {name} property of this 
Service.
+     * 
+     * @return QName representing the name of this Service
+     */
     public QName getName();
     
+    /**
+     * Represents the {interface} property of the Service component. This is 
the Interface component
+     * that this Service defines Endpoints for.
+     * 
+     * @return Interface associated with this Service
+     */
     public Interface getInterface();
     
-    public Endpoint getEndpoint(NCName name);
-    
+    /**
+     * Represents the {endpoints} property of the Service component. This is 
the set of
+     * Endpoints declared by this Service. The method will return an empty 
array if there
+     * are no endpoints.
+     * 
+     * @return an array of Endpoint objects
+     */
     public Endpoint[] getEndpoints();
     
+    
+    /**
+     * Returns the Endpoint with the specified local name from the {endpoints}
+     * property of this Service. That is, from the set of Endpoints defined 
+     * by this Service.
+     * If the name parameter is null, this method will return null.
+     * 
+     * @param name the local name of the Endpoint
+     * @return the named Endpoint
+     */
+    public Endpoint getEndpoint(NCName name);
+    
+    /**
+     * Returns a WSDLElement that represents the element information item from 
the WSDL 2.0 
+     * infoset that maps to this WSDLComponent. 
+     * 
+     * @return the ServiceElement that maps to this Service
+     */
     public ServiceElement toElement();
 }

Modified: 
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/TypeDefinition.java
URL: 
http://svn.apache.org/viewvc/incubator/woden/branches/M7/src/org/apache/woden/wsdl20/TypeDefinition.java?view=diff&rev=502685&r1=502684&r2=502685
==============================================================================
--- incubator/woden/branches/M7/src/org/apache/woden/wsdl20/TypeDefinition.java 
(original)
+++ incubator/woden/branches/M7/src/org/apache/woden/wsdl20/TypeDefinition.java 
Fri Feb  2 10:27:01 2007
@@ -21,49 +21,54 @@
 import javax.xml.namespace.QName;
 
 /**
- * This interface represents the TypeDefinition component described
- * in the WSDL 2.0 Component Model specification (within the Description 
- * Component section). This component refers to simple or complex data types 
- * defined in a type system such as XML Schema 
- * (e.g. &lt;xs:simpleType&gt; or &lt;xs:complexType&gt;).
- * However, it does not impose XML Schema as the type system.  
- * It returns a String representing the content model or type system 
- * (e.g. "http://www.w3.org/2001/XMLSchema";) and a java.lang.Object 
- * representing the content of the type definition. This Object may
- * be cast to a type appropriate for the content model.
+ * Represents the TypeDefinition component described in the WSDL 2.0 component 
model 
+ * (within the Description Component section of the W3C WSDL 2.0 spec). 
+ * This component represents global data type definitions such as top-level,
+ * named type definitions in W3C XML Schema (e.g. &lt;xs:simpleType&gt; or 
+ * &lt;xs:complexType&gt;).
+ * <p>
+ * However, it does not mandate W3C XML Schema as the type system. 
+ * It defines behaviour to query the type system and the underlying content
+ * model or API being used to represent the type definitions, and to 
+ * return a java.lang.Object representing the actual type definition object.
+ * Based on the type system and content model, the application must cast this
+ * Object to the appropriate type to manipulate its contents.
+ * <p>
+ * Note that while TypeDefinition is described along with the Component model
+ * in the W3C WSDL 2.0 specification, it is not a WSDL component itself. 
+ * It simply provides a way of representing components from the underlying 
type 
+ * system within the WSDL Component model.
  * 
- * TODO consider whether this interface should extend WSDLComponent too
- * (i.e. it is described in the spec within the Description component section, 
- * but it doesn't correspond directly to a WSDL element).
- *  
- * @author [EMAIL PROTECTED]
+ * @author John Kaputin ([EMAIL PROTECTED])
  */
 public interface TypeDefinition {
     
     /**
-     * A constant representing the DOM API, 
-     * used to indicate the content model.
+     * A constant representing the DOM API. This may be used to indicate the 
+     * content model of the underlying type definition.
      */
     public static final String API_W3C_DOM =
         "org.w3c.dom";
 
     /**
-     * A constant representing the Apache Ws-Commons XmlSchema API, 
-     * used to indicate the content model.
+     * A constant representing the Apache WS-Commons XmlSchema API. This may 
be used to 
+     * indicate the content model of the underlying type definition.
      */
     public static final String API_APACHE_WS_XS =
         "org.apache.ws.commons.schema";
 
     /**
-     * @return the QName identifying this type definition in the
-     * underlying type system definition.
-     *  
+     * Representing the {name} property of the TypeDefinition component, this 
+     * method returns the qualified name of this TypeDefinition.
+     * 
+     * @return the QName that identifies this TypeDefinition
      */
     public QName getName();
     
     /**
-     * Indicates the underlying type system of this type definition.
-     * For example, "http://www.w3.org/2001/XMLSchema"; indicates the W3 XML 
Schema
+     * Representing the {system} property of the TypeDefinition component, this
+     * method indicates the type system from which this type definition is 
derived.
+     * For example, "http://www.w3.org/2001/XMLSchema"; indicates the W3C XML 
Schema
      * type system.
      *  
      * @return the URI identifying the type system
@@ -71,28 +76,30 @@
     public URI getSystem();
     
     /**
-     * Indicates the type of model or API used to represent components from 
the 
-     * underlying type system identified by the getSystem() method.
+     * Indicates the type of object model or API which should be used to 
+     * access the content of the underlying type definition.
+     * This can be used to determine how to cast the Object returned by
+     * the <code>getContent()</code> method.
      * <p>
      * For example:
      * <ul>
-     * <li>"org.w3c.dom" indicates that the DOM API is used, so the type 
definition 
-     * content will be represented by a org.w3c.dom.Element.
-     * <li>"org.apache.ws.commons.schema" indicates that the XmlSchema API 
from the
-     * Apache WebServices project is used, so an XmlSchemaType will represent 
the 
-     * type definition content. 
+     * <li>The content model "org.w3c.dom" indicates that the DOM API should 
be used, 
+     * so the type org.w3c.dom.Element will be used to represent the content 
of the
+     * type definition.
+     * <li>The content model "org.apache.ws.commons.schema" indicates that the 
+     * WS-Commons XmlSchema API from the Apache WebServices project is used, 
+     * so an org.apache.ws.commons.schema.XmlSchemaType will be used to 
represent the 
+     * content of the type definition. 
      * </ul>
      * 
-     * @return a String identifying the content model or API used to represent 
this 
-     * type definition
+     * @return a String identifying the type definition's content model
      */
     public String getContentModel();
     
     /**
-     * Returns the content of the type definition in an object
-     * specific to the underlying content model API. The caller may then
-     * cast this Object to the appropriate type, based on the content model
-     * API indicated by the getContent() method.
+     * Returns the underlying type definition as a java.lang.Object, which 
should
+     * be cast to the appropriate type as indicated by the 
<code>getContentModel()</code> 
+     * method.
      * 
      * @return the Object representing the content of the type definition
      */

Modified: 
incubator/woden/branches/M7/src/org/apache/woden/wsdl20/WSDLComponent.java
URL: 
http://svn.apache.org/viewvc/incubator/woden/branches/M7/src/org/apache/woden/wsdl20/WSDLComponent.java?view=diff&rev=502685&r1=502684&r2=502685
==============================================================================
--- incubator/woden/branches/M7/src/org/apache/woden/wsdl20/WSDLComponent.java 
(original)
+++ incubator/woden/branches/M7/src/org/apache/woden/wsdl20/WSDLComponent.java 
Fri Feb  2 10:27:01 2007
@@ -21,8 +21,11 @@
 import org.apache.woden.wsdl20.extensions.ComponentExtensions;
 
 /**
- * All components directly or indirectly extend this interface, so it provides 
- * a common term of reference for all components.
+ * Represents the top-level super-type of all WSDL 2.0 Components. 
+ * Every WSDL 2.0 Component interface must extend this interface, directly or 
indirectly.
+ * It provides a common way to refer to any type of WSDL Component.
+ * It defines behaviour common to all WSDL components, such as testing for 
+ * equivalence and accessing extension properties. 
  * 
  * @author John Kaputin ([EMAIL PROTECTED])
  */



---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]

Reply via email to