You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@beehive.apache.org by ek...@apache.org on 2005/05/12 00:41:33 UTC

svn commit: r169707 - in /incubator/beehive/trunk: controls/src/api/org/apache/beehive/controls/api/bean/ docs/forrest/src/documentation/content/xdocs/controls/ docs/forrest/src/documentation/content/xdocs/pageflow/ docs/forrest/src/documentation/content/xdocs/wsm/

Author: ekoneil
Date: Wed May 11 15:41:32 2005
New Revision: 169707

URL: http://svn.apache.org/viewcvs?rev=169707&view=rev
Log:
Various documentation bug fixes.  Patch from Chad Schoettger.

JIRA 691, 682, 693, 646, 657, 682

BB: self
DRT: none


Modified:
    incubator/beehive/trunk/controls/src/api/org/apache/beehive/controls/api/bean/ControlInterface.java
    incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/controls/tutorial_controls.xml
    incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/tutorial_pageflow.xml
    incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/wsm/tutorial_wsm.xml
    incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/wsm/wsm_overview.xml

Modified: incubator/beehive/trunk/controls/src/api/org/apache/beehive/controls/api/bean/ControlInterface.java
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/controls/src/api/org/apache/beehive/controls/api/bean/ControlInterface.java?rev=169707&r1=169706&r2=169707&view=diff
==============================================================================
--- incubator/beehive/trunk/controls/src/api/org/apache/beehive/controls/api/bean/ControlInterface.java (original)
+++ incubator/beehive/trunk/controls/src/api/org/apache/beehive/controls/api/bean/ControlInterface.java Wed May 11 15:41:32 2005
@@ -36,7 +36,25 @@
      */
     static final String INTERFACE_NAME = "<InterfaceName>";
 
+    /**
+     * Specify the fully qualified name of the control implementation for this control interface.
+     * If no value is specified the implementation will be the name of the interface with 'Impl' appended.
+     * */
     String defaultBinding() default INTERFACE_NAME + "Impl";
-    Class<? extends ControlChecker> checkerClass() default DefaultControlChecker.class; // DEPRECATED
+
+    /**
+     * @deprecated Replaced by checker() element.
+     */
+    Class<? extends ControlChecker> checkerClass() default DefaultControlChecker.class;
+
+    /**
+     *  Used by control authors wishing to enforce rich semantic validation on extension and field
+     *  instance declarations of their controls. By supplying a ControlChecker implementation
+     *  (a "checker") and associating it with your control's public interface, when an
+     *  extension of your control is processed at build-time, the checker will be invoked and
+     *  can do rich validation of the extension type and field instances via introspection and
+     *  analysis of the control extension's type structure, signatures and annotations.
+     * @see org.apache.beehive.controls.api.bean.ControlChecker
+     */
     Class<? extends ControlChecker> checker() default DefaultControlChecker.class;
 }

Modified: incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/controls/tutorial_controls.xml
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/controls/tutorial_controls.xml?rev=169707&r1=169706&r2=169707&view=diff
==============================================================================
--- incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/controls/tutorial_controls.xml (original)
+++ incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/controls/tutorial_controls.xml Wed May 11 15:41:32 2005
@@ -191,7 +191,7 @@
     
     @Jpf.Action(
       forwards={
-        @Jpf.Forward( name="success", path="index.jsp" )
+        @Jpf.Forward(name="success", path="index.jsp")
       }
     )
     protected Forward begin() throws Exception

Modified: incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/tutorial_pageflow.xml
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/tutorial_pageflow.xml?rev=169707&r1=169706&r2=169707&view=diff
==============================================================================
--- incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/tutorial_pageflow.xml (original)
+++ incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/pageflow/tutorial_pageflow.xml Wed May 11 15:41:32 2005
@@ -408,7 +408,7 @@
 {
     <strong>@Jpf.Action(
         forwards = { 
-            @Jpf.Forward(name = "success", path = "page2.jsp")
+            @Jpf.Forward(name="success", path="page2.jsp")
         }
     )
     public Forward processData(ProfileForm form)
@@ -460,7 +460,7 @@
             <title>Step 5: Processing and Displaying Data</title>
             <section id="create_jsp">
                 <title>To Create a JSP Page to Display Submitted Data</title>
-                <p>In the directory <code>C:/pageflow_tutorial</code> Create a file named 
+                <p>In the directory <code>C:/beehive-projects/pageflow_tutorial</code> create a file named 
 					<strong><code>displayData.jsp</code></strong>. </p>
 				<p>Edit <code>displayData.jsp</code> so it appears as follows.</p>
                 

Modified: incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/wsm/tutorial_wsm.xml
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/wsm/tutorial_wsm.xml?rev=169707&r1=169706&r2=169707&view=diff
==============================================================================
--- incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/wsm/tutorial_wsm.xml (original)
+++ incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/wsm/tutorial_wsm.xml Wed May 11 15:41:32 2005
@@ -234,7 +234,7 @@
 
     <strong>public String sayNothingOverTheWeb()
     {
-        return "Not for for Web consumption!";
+        return "Not for Web consumption!";
     }</strong>
 }
 </source>
@@ -295,7 +295,7 @@
 
     public String sayNothingOverTheWeb()
     {
-        return "Not for for Web consumption!";
+        return "Not for Web consumption!";
     }
 }</source>
 </section>

Modified: incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/wsm/wsm_overview.xml
URL: http://svn.apache.org/viewcvs/incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/wsm/wsm_overview.xml?rev=169707&r1=169706&r2=169707&view=diff
==============================================================================
--- incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/wsm/wsm_overview.xml (original)
+++ incubator/beehive/trunk/docs/forrest/src/documentation/content/xdocs/wsm/wsm_overview.xml Wed May 11 15:41:32 2005
@@ -13,8 +13,8 @@
 				quick way to change the web service implementation.  The annotations offer
 				implementations of the most common web service features, such as 
 				(1) conforming to basic SOAP and WSDL standards, (2) separating the public contract 
-				and the private implementation, and (3) creating asynchronous communitication between the 
-				web service and its clients.  The basic idea underlying all Beehive web service developement
+				and the private implementation, and (3) creating asynchronous communication between the 
+				web service and its clients.  The basic idea underlying all Beehive web service development
 				is that the developer writes an ordinary Java class, whose functionality is exposed
 				as a web service.  The manner of exposure is specified by the metadata annotations
 				that decorate the class and its methods.</p>
@@ -23,13 +23,13 @@
 				the <a class="fork" href="http://jcp.org/en/jsr/detail?id=181">JSR 181</a>
 				web service standard.  JSR 181 sets out the core annotations used to expose
 				Java classes as web services.</p>
-			<p><strong>No Expertice with APIs and Deployment Descriptors Required</strong></p>
+			<p><strong>No expertise with APIs and Deployment Descriptors Required</strong></p>
 			<p>Beehive web services are implemented as ordinary Java classes decorated with 
 				metadata annotations.  The metadata annotations (1) replace the deployment descriptors
 				(that would ordinarily be used to configure the Java class)
 				and (2) encapsulate the web service APIs (that would ordinarily be used by the developer
 				as an implementation resource).  The result is a web service implementation that is much
-				easier to learn and understand.  Instead of keeping multiple Java clases and XML configuration 
+				easier to learn and understand.  Instead of keeping multiple Java classes and XML configuration 
 				files in sync, the developer needs to edit only one file: the annotated Java class.</p>
 			<!--<p><strong>Containers</strong></p>
 			<p>[todo]</p> -->