From b86c27a769d83b1ce0e5497c25c72ee390366562 Mon Sep 17 00:00:00 2001
From: Oleg Zhurakousky <ozhurakousky@vmware.com>
Date: Tue, 16 Nov 2010 00:31:26 -0500
Subject: [PATCH] INT-500 addedschema docs for aggregator

---
 docs/src/reference/docbook/aggregator.xml     | 14 ++++----
 .../config/xml/spring-integration-2.0.xsd     | 35 +++++++++++++++++--
 2 files changed, 40 insertions(+), 9 deletions(-)

diff --git a/docs/src/reference/docbook/aggregator.xml b/docs/src/reference/docbook/aggregator.xml
index 6ed365cb08..a4c7c9f528 100644
--- a/docs/src/reference/docbook/aggregator.xml
+++ b/docs/src/reference/docbook/aggregator.xml
@@ -407,8 +407,8 @@
       
       <callout arearefs="aggxml11">
         <para>A method defined on the bean referenced by
-        <code>correlation-strategy</code>, <emphasis>that implements the
-        correlation decision algorithm.</emphasis> <emphasis>Optional, with
+        <code>correlation-strategy</code>, that implements the
+        correlation decision algorithm. <emphasis>Optional, with
         restrictions (requires <code>correlation-strategy</code> to be
         present).</emphasis></para>
       </callout>
@@ -421,8 +421,8 @@
     
       <callout arearefs="aggxml13">
         <para>A method defined on the bean referenced by <code>ref</code>,
-        <emphasis>that implements the message aggregation
-        algorithm.</emphasis> <emphasis>Optional, depends on <code>ref</code> attribute being defined.</emphasis></para>
+        that implements the message aggregation
+        algorithm. <emphasis>Optional, depends on <code>ref</code> attribute being defined.</emphasis></para>
       </callout>
       
       <callout arearefs="aggxml14">
@@ -436,8 +436,8 @@
 
       <callout arearefs="aggxml15">
         <para>A method defined on the bean referenced by
-        <code>release-strategy</code>, <emphasis>that implements the
-        completion decision algorithm.</emphasis> <emphasis>Optional, with
+        <code>release-strategy</code>, that implements the
+        completion decision algorithm. <emphasis>Optional, with
         restrictions (requires <code>release-strategy</code> to be
         present).</emphasis></para>
       </callout>
@@ -550,6 +550,8 @@
     <para>
     The same expression-based approach could be applied when dealing with custom <emphasis>Release</emphasis> and 
     <emphasis>Correlation</emphasis> strategies.
+    </para>
+    <para>
 	Instead of defining a bean for custom <classname>CorrelationStrategy</classname> via <code>correlation-strategy</code> 
 	attribute you can implement your simple correlation logic via SpEL expression and configure it via
 	<code>correlation-strategy-ecpression</code> attribute.
diff --git a/spring-integration-core/src/main/resources/org/springframework/integration/config/xml/spring-integration-2.0.xsd b/spring-integration-core/src/main/resources/org/springframework/integration/config/xml/spring-integration-2.0.xsd
index c9c58beaf6..e52c646cbd 100644
--- a/spring-integration-core/src/main/resources/org/springframework/integration/config/xml/spring-integration-2.0.xsd
+++ b/spring-integration-core/src/main/resources/org/springframework/integration/config/xml/spring-integration-2.0.xsd
@@ -2196,6 +2196,11 @@ Name of the header whose value to use.
 								<tool:expected-type type="java.lang.Object" />
 							</tool:annotation>
 						</xsd:appinfo>
+						<xsd:documentation>
+							A reference to a bean that implements the release strategy. 
+							The bean can be an implementation of the
+							ReleaseStrategy interface or a POJO
+						</xsd:documentation>
 					</xsd:annotation>
 				</xsd:attribute>
 				<xsd:attribute name="release-strategy-method" type="xsd:string">
@@ -2205,11 +2210,15 @@ Name of the header whose value to use.
 								<tool:expected-method type-ref="@release-strategy" />
 							</tool:annotation>
 						</xsd:appinfo>
+						<xsd:documentation>
+							A method defined on the bean referenced by release-strategy, that implements the completion
+							decision algorithm.
+						</xsd:documentation>
 					</xsd:annotation>
 				</xsd:attribute>
 				<xsd:attribute name="release-strategy-expression" type="xsd:string">
 					<xsd:annotation>
-						<xsd:documentation>An expression to apply to the message group</xsd:documentation>
+						<xsd:documentation>A SpEL expression to apply to the message group (e.g, payload.size() > 6)</xsd:documentation>
 					</xsd:annotation>
 				</xsd:attribute>
 				<xsd:attribute name="correlation-strategy" type="xsd:string">
@@ -2217,6 +2226,11 @@ Name of the header whose value to use.
 						<xsd:appinfo>
 							<tool:annotation kind="ref">
 								<tool:expected-type type="java.lang.Object" />
+								<xsd:documentation>
+							A reference to a bean that implements the decision algorithm as to whether a given 
+							message group is complete. The bean can be an implementation of the 
+							CorrelationStrategy interface or a POJO.
+							</xsd:documentation>
 							</tool:annotation>
 						</xsd:appinfo>
 					</xsd:annotation>
@@ -2228,11 +2242,15 @@ Name of the header whose value to use.
 								<tool:expected-method type-ref="@correlation-strategy" />
 							</tool:annotation>
 						</xsd:appinfo>
+						<xsd:documentation>
+						A method defined on the bean referenced by correlation-strategy, that implements the
+						correlation decision algorithm
+						</xsd:documentation>
 					</xsd:annotation>
 				</xsd:attribute>
 				<xsd:attribute name="correlation-strategy-expression" type="xsd:string">
 					<xsd:annotation>
-						<xsd:documentation>An expression to apply to the message group</xsd:documentation>
+						<xsd:documentation>A SpEL expression to apply to the Message</xsd:documentation>
 					</xsd:annotation>
 				</xsd:attribute>
 				<xsd:attribute name="discard-channel" type="xsd:string">
@@ -2242,6 +2260,10 @@ Name of the header whose value to use.
 								<tool:expected-type type="org.springframework.integration.core.MessageChannel" />
 							</tool:annotation>
 						</xsd:appinfo>
+						<xsd:documentation>
+						The channel where the aggregator will send the messages that timed out (if send-partial-results-
+						on-expiry is 'false').
+						</xsd:documentation>
 					</xsd:annotation>
 				</xsd:attribute>
 				<xsd:attribute name="message-store" type="xsd:string">
@@ -2265,7 +2287,14 @@ Name of the header whose value to use.
 						</xsd:appinfo>
 					</xsd:annotation>
 				</xsd:attribute>
-				<xsd:attribute name="send-partial-result-on-expiry" type="xsd:string" />
+				<xsd:attribute name="send-partial-result-on-expiry" type="xsd:string">
+					<xsd:annotation>
+						<xsd:documentation>
+						Tells if partially aggregated messages should be released when their storage time had expired (see
+						MessageGroupStore.expireMessageGroups(long))
+						</xsd:documentation>
+					</xsd:annotation>
+				</xsd:attribute>
 			</xsd:extension>
 		</xsd:complexContent>
 	</xsd:complexType>