svn commit: r619304 - /lenya/trunk/src/java/org/apache/lenya/cms/cocoon/source/AggregatingFallbackSourceFactory.java

Author: andreas
Date: Thu Feb  7 00:09:45 2008
New Revision: 619304

URL: http://svn.apache.org/viewvc?rev=619304&view=rev
Log:
Added more javadocs to AggregatingFallbackSourceFactory.

Modified:
    lenya/trunk/src/java/org/apache/lenya/cms/cocoon/source/AggregatingFallbackSourceFactory.java

Modified: lenya/trunk/src/java/org/apache/lenya/cms/cocoon/source/AggregatingFallbackSourceFactory.java
URL: http://svn.apache.org/viewvc/lenya/trunk/src/java/org/apache/lenya/cms/cocoon/source/AggregatingFallbackSourceFactory.java?rev=619304&r1=619303&r2=619304&view=diff
==============================================================================
--- lenya/trunk/src/java/org/apache/lenya/cms/cocoon/source/AggregatingFallbackSourceFactory.java (original)
+++ lenya/trunk/src/java/org/apache/lenya/cms/cocoon/source/AggregatingFallbackSourceFactory.java Thu Feb  7 00:09:45 2008
@@ -38,8 +38,23 @@
 import org.apache.lenya.util.ServletHelper;
 
 /**
- * Aggregate all existing fallback URIs by merging their XML content under
- * the document element of the first encountered source.
+ * <p>
+ * Aggregate all existing fallback sources by adding their XML content under the document element of
+ * the first encountered source. The document element of all subsequent sources is stripped.
+ * </p>
+ * <p>
+ * The fallback sources are resolved in bottom-up order, i.e.
+ * </p>
+ * <ul>
+ * <li>current publication</li>
+ * <li>template of the current publication</li>
+ * <li>template of the template publication</li>
+ * <li>...</li>
+ * <li>core</li>
+ * </ul>
+ * <p>
+ * If one of the fallback sources is not a well-formed XML document, a RuntimeException is thrown.
+ * </p>
  */
 public class AggregatingFallbackSourceFactory extends FallbackSourceFactory {