Author: jkaputin
Date: Wed Jan 17 15:37:50 2007
New Revision: 497246
URL: http://svn.apache.org/viewvc?view=rev&rev=497246
Log:
Improved Javadoc and non-javadoc comments
Modified:
incubator/woden/trunk/java/src/org/apache/woden/WSDLReader.java
incubator/woden/trunk/java/src/org/apache/woden/internal/DOMWSDLReader.java
Modified: incubator/woden/trunk/java/src/org/apache/woden/WSDLReader.java
URL:
http://svn.apache.org/viewvc/incubator/woden/trunk/java/src/org/apache/woden/WSDLReader.java?view=diff&rev=497246&r1=497245&r2=497246
==============================================================================
--- incubator/woden/trunk/java/src/org/apache/woden/WSDLReader.java (original)
+++ incubator/woden/trunk/java/src/org/apache/woden/WSDLReader.java Wed Jan 17
15:37:50 2007
@@ -20,17 +20,15 @@
import org.apache.woden.wsdl20.xml.DescriptionElement;
/**
- * This interface declares the WSDL reader API for parsing WSDL documents.
- * <p>
- * TODO after WSDL 2.0 parsing is implemented, consider if/how to make this
reader
- * API independent of the WSDL version (definition/description) or whether to
make it
- * support both versions. Also, make it independent of the type of XML parser
if
- * possible (e.g. no DOM objects in signatures).
- * <p>
- * TODO add to the API methods to get/set features and properties of the
- * Woden framework. Similar to WSDLReader.setFeature in WSDL4J, a named
- * feature will be turned on or off with a boolean. A named property will be
- * set with some object representing the property value.
+ * This interface declares an API for reading WSDL descriptions from different
sources
+ * such as WSDL documents or files, parsed XML elements and input byte streams.
+ * It contains various <code>readWSDL</code> methods that obtain the WSDL
infoset from
+ * the specified source, parse it into the Woden object model and return this
as a WSDL
+ * <code>Description</code> component containing the WSDL components derived
from that infoset.
+ * If the WSDL is comprised of a composite set of documents nested via
wsdl:import
+ * or wsdl:include, the Description component will represent the abstract,
'flattened' view
+ * of the WSDL tree, containing all of the WSDL components derived from the
various WSDL
+ * documents, but without the document structure.
*
* @author John Kaputin ([EMAIL PROTECTED])
*/
@@ -108,11 +106,11 @@
"http://www.w3.org/2001/XMLSchema";;
/**
- * Read the WSDL document accessible via the specified
- * URI into a WSDL description.
+ * Read the WSDL document at the specified URI and return a WSDL
Description component
+ * containing the WSDL components derived from that document.
+ *
+ * TODO change the return type to Desription per WODEN-120
*
- * TODO: return value is WSDL 2.0 specific. May be refactored.
- *
* @param wsdlURI a URI (absolute filename or URL) pointing to a
* WSDL document.
* @return the description element of the WSDL document.
@@ -122,11 +120,13 @@
public DescriptionElement readWSDL(String wsdlURI) throws WSDLException;
/**
- * Read the WSDL document accessible via the specified
- * URI into a WSDL description.
+ * Read the WSDL document at the specified URI and return a WSDL
Description component
+ * containing the WSDL components derived from that document.
+ * Use the specified custom error handler rather than the Woden default
handler to handle
+ * any WSDL parsing or validation error messages.
+ *
+ * TODO change the return type to Descriptioin per WODEN-120
*
- * TODO: return value is WSDL 2.0 specific. May be refactored.
- *
* @param wsdlURI a URI (absolute filename or URL) pointing to a
* WSDL document.
* @param errorHandler An error handler that will handle reporting of
errors and warnings.
@@ -137,15 +137,15 @@
public DescriptionElement readWSDL(String wsdlURI, ErrorHandler
errorHandler) throws WSDLException;
/**
- * Read the WSDL document contained in the specified WSDLSource object.
- * The WSDLSource must contain the WSDL in a format compatible with the
- * concrete WSDLReader implementation.
+ * Read the WSDL obtained from the specified WSDLSource object and return
a WSDL Description
+ * component containing the WSDL components derived from that WSDL source.
* <p>
- * For example, if the WSDLReader implementation is Woden's DOMWSDLReader
- * then the WSDLSource may contain a DOM Element or Document representing
- * the <wsdl:description> element.
- * <p>
- * TODO update this Javadoc comment at development of WSDLSource
progresses.
+ * The WSDLSource object must represent the WSDL using a type that the
WSDLReader
+ * implementation can understand. That is, the WSDLSource and WSDLReader
implementations
+ * must be compatible.
+ * For example, a DOM-based WSDLReader implementation will likely require
the WSDLSource
+ * object to represent the WSDL as a DOM Document or Element
(org.w3c.dom.Document
+ * or org.w3c.dom.Element), both of which should be type compatible the
DOM-based reader.
*
* @param wsdlSource contains an object representing the WSDL
* @return the DescriptionElement representing the parsed WSDL
@@ -155,16 +155,17 @@
public DescriptionElement readWSDL(WSDLSource wsdlSource) throws
WSDLException;
/**
- * Read the WSDL document contained in the specified WSDLSource object,
- * using the specified custom ErrorHandler to report any errors.
- * The WSDLSource must contain the WSDL in a format compatible with the
- * concrete WSDLReader implementation.
- * <p>
- * For example, if the WSDLReader implementation is Woden's DOMWSDLReader
- * then the WSDLSource may contain a DOM Element or Document representing
- * the <wsdl:description> element.
+ * Read the WSDL obtained from the specified WSDLSource object and return
a WSDL Description
+ * component containing the WSDL components derived from that WSDL source.
+ * Use the specified custom error handler rather than the Woden default
handler to handle
+ * any WSDL parsing or validation error messages.
* <p>
- * TODO update this Javadoc comment at development of WSDLSource
progresses.
+ * The WSDLSource object must represent the WSDL using a type that the
WSDLReader
+ * implementation can understand. That is, the WSDLSource and WSDLReader
implementations
+ * must be compatible.
+ * For example, a DOM-based WSDLReader implementation will likely require
the WSDLSource
+ * object to represent the WSDL as a DOM Document or Element
(org.w3c.dom.Document
+ * or org.w3c.dom.Element), both of which should be type compatible the
DOM-based reader.
*
* @param wsdlSource contains an object representing the WSDL
* @param errorHandler a custom error handler that overrides the default
handler
@@ -174,17 +175,18 @@
*/
public DescriptionElement readWSDL(WSDLSource wsdlSource, ErrorHandler
errorHandler) throws WSDLException;
- //TODO - a readWSDL method that returns a Description (eg a component)
-
//TODO - decide if an API method createXMLElement() is needed.
/**
- * Returns a concrete implementation of WSDLSource that is compatible with
- * the WSDLReader implementation. That is, it will accept objects
representing
- * WSDL source in formats that the WSDLReader implementation can
understand.
- * For example, a DOM-based implementation of WSDLReader will return a DOM-
- * based implementation of WSDLSource that accepts WSDL source as a DOM
- * Element or Document.
+ * Returns a WSDLSource object that is compatible with the WSDLReader
implementation.
+ * That is, a WSDLSource implementation that represents WSDL using types
that
+ * the WSDLReader implementation can understand.
+ * For example, DOM-based WSDLReader implementation will likely return a
WSDLSource
+ * object that represents the WSDL as a DOM Document or Element
(org.w3c.dom.Document
+ * or org.w3c.dom.Element), both of which should be type compatible the
DOM-based reader.
+ * <p>
+ * This WSDLSource object can be used to encapsulate the WSDL and is then
passed to the
+ * WSDLReader as a parameter to its <code>readWSDL</code> methods.
*
* @return the WSDLSource class compatible with the WSDLReader
implementation.
*/
Modified:
incubator/woden/trunk/java/src/org/apache/woden/internal/DOMWSDLReader.java
URL:
http://svn.apache.org/viewvc/incubator/woden/trunk/java/src/org/apache/woden/internal/DOMWSDLReader.java?view=diff&rev=497246&r1=497245&r2=497246
==============================================================================
--- incubator/woden/trunk/java/src/org/apache/woden/internal/DOMWSDLReader.java
(original)
+++ incubator/woden/trunk/java/src/org/apache/woden/internal/DOMWSDLReader.java
Wed Jan 17 15:37:50 2007
@@ -97,8 +97,6 @@
/*
* @see org.apache.woden.WSDLReader#readWSDL(String)
- *
- * TODO change uri args on public readWSDL methods to java.net.URI
*/
public DescriptionElement readWSDL(String wsdlURI) throws WSDLException
{
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
