Author: jkaputin
Date: Thu Feb 1 18:29:09 2007
New Revision: 502449
URL: http://svn.apache.org/viewvc?view=rev&rev=502449
Log:
Javadoc improvements for the org.apache.woden,
org.apache.woden.schema and org.apache.woden.types
packages.
Modified:
incubator/woden/branches/M7/src/org/apache/woden/ErrorLocator.java
incubator/woden/branches/M7/src/org/apache/woden/WSDLSource.java
incubator/woden/branches/M7/src/org/apache/woden/schema/ImportedSchema.java
incubator/woden/branches/M7/src/org/apache/woden/schema/InlinedSchema.java
incubator/woden/branches/M7/src/org/apache/woden/schema/Schema.java
incubator/woden/branches/M7/src/org/apache/woden/types/XMLChar.java
Modified: incubator/woden/branches/M7/src/org/apache/woden/ErrorLocator.java
URL:
http://svn.apache.org/viewvc/incubator/woden/branches/M7/src/org/apache/woden/ErrorLocator.java?view=diff&rev=502449&r1=502448&r2=502449
==============================================================================
--- incubator/woden/branches/M7/src/org/apache/woden/ErrorLocator.java
(original)
+++ incubator/woden/branches/M7/src/org/apache/woden/ErrorLocator.java Thu Feb
1 18:29:09 2007
@@ -17,13 +17,13 @@
package org.apache.woden;
/**
- * Represents the location of parsing error within a XML document.
+ * Represents the location of a parsing error within an XML document.
* Based on org.xml.sax.Locator.
- *
+ * <p>
* TODO decide if URI info of the document is needed,
* and maybe XPATH of the element or attribute in error.
*
- * @author kaputin
+ * @author John Kaputin ([EMAIL PROTECTED])
*/
public interface ErrorLocator {
Modified: incubator/woden/branches/M7/src/org/apache/woden/WSDLSource.java
URL:
http://svn.apache.org/viewvc/incubator/woden/branches/M7/src/org/apache/woden/WSDLSource.java?view=diff&rev=502449&r1=502448&r2=502449
==============================================================================
--- incubator/woden/branches/M7/src/org/apache/woden/WSDLSource.java (original)
+++ incubator/woden/branches/M7/src/org/apache/woden/WSDLSource.java Thu Feb 1
18:29:09 2007
@@ -42,8 +42,8 @@
* Programming example:
* <pre>
* //wsdlURI is the URI of the base wsdl document.
- * //domReader is an instance of DOMWSDLReader
- * //domElement is an org.w3c.dom.Element representing a description element.
+ * //domReader is a DOM-based implementation of WSDLReader
+ * //domElement is an org.w3c.dom.Element representing a
<wsdl:description> element.
*
* WSDLSource wsdlSource = domReader.createWSDLSource();
* wsdlSource.setBaseURI(wsdlURI);
Modified:
incubator/woden/branches/M7/src/org/apache/woden/schema/ImportedSchema.java
URL:
http://svn.apache.org/viewvc/incubator/woden/branches/M7/src/org/apache/woden/schema/ImportedSchema.java?view=diff&rev=502449&r1=502448&r2=502449
==============================================================================
--- incubator/woden/branches/M7/src/org/apache/woden/schema/ImportedSchema.java
(original)
+++ incubator/woden/branches/M7/src/org/apache/woden/schema/ImportedSchema.java
Thu Feb 1 18:29:09 2007
@@ -19,10 +19,10 @@
import java.net.URI;
/**
- * This interface represents a schema import, <xs:import>. It extends
the Schema
+ * This interface represents a schema import element, <xs:import>. It
extends the Schema
* interface, adding support for the <code>schemaLocation</code> attribute.
*
- * @author [EMAIL PROTECTED]
+ * @author John Kaputin ([EMAIL PROTECTED])
*/
public interface ImportedSchema extends Schema {
Modified:
incubator/woden/branches/M7/src/org/apache/woden/schema/InlinedSchema.java
URL:
http://svn.apache.org/viewvc/incubator/woden/branches/M7/src/org/apache/woden/schema/InlinedSchema.java?view=diff&rev=502449&r1=502448&r2=502449
==============================================================================
--- incubator/woden/branches/M7/src/org/apache/woden/schema/InlinedSchema.java
(original)
+++ incubator/woden/branches/M7/src/org/apache/woden/schema/InlinedSchema.java
Thu Feb 1 18:29:09 2007
@@ -18,10 +18,10 @@
/**
- * This interface represents an inlined schema, <xs:schema>. It extends
the Schema
+ * This interface represents an inlined schema element, <xs:schema>. It
extends the Schema
* interface, adding support for the <code>id</code> attribute.
*
- * @author [EMAIL PROTECTED]
+ * @author John Kaputin ([EMAIL PROTECTED])
*/
public interface InlinedSchema extends Schema {
Modified: incubator/woden/branches/M7/src/org/apache/woden/schema/Schema.java
URL:
http://svn.apache.org/viewvc/incubator/woden/branches/M7/src/org/apache/woden/schema/Schema.java?view=diff&rev=502449&r1=502448&r2=502449
==============================================================================
--- incubator/woden/branches/M7/src/org/apache/woden/schema/Schema.java
(original)
+++ incubator/woden/branches/M7/src/org/apache/woden/schema/Schema.java Thu Feb
1 18:29:09 2007
@@ -24,48 +24,78 @@
/**
* This interface provides an abstract representation of an XML Schema
referenced
- * within the WSDL <types> element. For example, via <xs:schema>
or
+ * within the <wsdl:types> element. For example, via <xs:schema>
or
* <xs:import>.
- * It contains the namespace used as the target namespace of an inlined schema
+ * It provides the namespace used as the target namespace of an inlined schema
* or as the imported namespace of a schema import.
- * It contains a reference to the actual schema definition, represented by
- * <code>org.apache.ws.commons.schema.XmlSchema</code>.
- * It also indicates whether the schema is 'referenceable' by the WSDL,
- * as defined by the schema referenceability rules in the WSDL 2.0 spec.
+ * It provides a reference to the actual schema definition, represented by
+ * <code>org.apache.ws.commons.schema.XmlSchema</code>.
+ * For applications that use other representations for XML Schema content,
+ * it also provides a reference to the <code>org.apache.woden.XMLElement</code>
+ * object that wraps the underlying <xs:schema> or <xs:import>
+ * element.
+ * It also indicates whether the schema is 'referenceable' by the surrounding
+ * WSDL document, as defined by the schema referenceability rules in the
+ * WSDL 2.0 spec.
* <p>
*
* NOTE: non-XML type systems like DTD are not handled by this interface. They
must be
* handled by WSDL 2.0 extension mechanisms.
+ * <br />
+ * TODO Need to determine if this interface is suitable for use with other
xml-based
+ * schema types like Relax NG or if some type of schema extension mechanism is
required.
*
- * TODO initially this will be tested with XML Schema. Need to determine if it
really
- * is sufficient for other xml-based schema types like Relax NG or if some
type of
- * schema extension mechanism is required.
- *
- * @author [EMAIL PROTECTED]
+ * @author John Kaputin ([EMAIL PROTECTED])
*/
public interface Schema {
/**
- * @return a URI representing the target namespace of an inline schema or
the
- * namespace attribute of a schema import.
+ * Returns a URI representing the <code>targetNamespace</code> attribute
of a
+ * <xs:schema> element or the <code>namespace</code> attribute of a
+ * <xs:import> element.
+ *
+ * @return a URI representing the schema's namespace
*/
public URI getNamespace();
+
+ /**
+ * Set the <code>targetNamespace</code> attribute of a <xs:schema>
element
+ * or the <code>namespace</code> attribute of a <xs:import> element.
+ * @param namespace
+ */
public void setNamespace(URI namespace);
/**
- * @return the XmlSchema object representing the schema contents.
+ * Returns an <code>XmlSchema</code> representing the schema definition
inlined by
+ * a <xs:schema> element or imported by a <xs:import> element.
+ *
+ * @return the <code>XmlSchema</code> representing schema definition.
*/
public XmlSchema getSchemaDefinition();
+
+ /**
+ * Sets the schema definition for an inlined schema or schema import to
the specified
+ * <code>XmlSchema</code>.
+ *
+ * @param schemaDef the <code>XmlSchema</code> representing this schema
+ */
public void setSchemaDefinition(XmlSchema schemaDef);
/**
- * Returns the XMLElement object representing the <code>xs:schema</code>
or <code>xs:import</code>
+ * Returns the XMLElement representing the <code>xs:schema</code> or
<code>xs:import</code>
* element within the <code>wsdl:types</code> element. This provides an
'wrapper' to the
* underlying XML Schema infoset for applications that need schema
processing alternatives to
* Apache WS Commons XmlSchema.
*
- * @return the XMLElement
+ * @return the XMLElement that wraps the underlying schema or schema
import element
*/
public XMLElement getXMLElement();
+
+ /**
+ * Sets the XMLElement representing the underlying <code>xs:schema</code>
or <code>xs:import</code>
+ * element.
+ *
+ * @param xsdElement the XMLElement
+ */
public void setXMLElement(XMLElement xsdElement);
}
Modified: incubator/woden/branches/M7/src/org/apache/woden/types/XMLChar.java
URL:
http://svn.apache.org/viewvc/incubator/woden/branches/M7/src/org/apache/woden/types/XMLChar.java?view=diff&rev=502449&r1=502448&r2=502449
==============================================================================
--- incubator/woden/branches/M7/src/org/apache/woden/types/XMLChar.java
(original)
+++ incubator/woden/branches/M7/src/org/apache/woden/types/XMLChar.java Thu Feb
1 18:29:09 2007
@@ -18,12 +18,12 @@
package org.apache.woden.types;
/**
- * This class has been copied from Axis into Woden to support the NCName class.
- *
* This class defines the basic XML character properties. The data
* in this class can be used to verify that a character is a valid
* XML character or if the character is a space, name start, or name
* character.
+ * <p>
+ * This class has been copied from Axis into Woden to support the NCName class.
* <p>
* A series of convenience methods are supplied to ease the burden
* of the developer. Because inlining the checks can improve per
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
