You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by da...@apache.org on 2010/11/16 15:40:10 UTC

svn commit: r1035645 - in /incubator/isis/trunk/viewer/bdd: common/src/main/java/org/apache/isis/viewer/bdd/common/ concordion/src/main/java/org/apache/isis/viewer/bdd/concordion/internal/fixtures/ concordion/src/main/java/org/apache/isis/viewer/bdd/co...

Author: danhaywood
Date: Tue Nov 16 14:40:09 2010
New Revision: 1035645

URL: http://svn.apache.org/viewvc?rev=1035645&view=rev
Log:
minor refactorings in the BDD viewer

Added:
    incubator/isis/trunk/viewer/bdd/common/src/main/java/org/apache/isis/viewer/bdd/common/CellBindingDefault.java
      - copied, changed from r1035640, incubator/isis/trunk/viewer/bdd/concordion/src/main/java/org/apache/isis/viewer/bdd/concordion/internal/fixtures/bindings/CellBindingForConcordion.java
    incubator/isis/trunk/viewer/bdd/common/src/main/java/org/apache/isis/viewer/bdd/common/StoryCellDefault.java
      - copied, changed from r1035640, incubator/isis/trunk/viewer/bdd/concordion/src/main/java/org/apache/isis/viewer/bdd/concordion/internal/fixtures/perform/StoryCellForConcordion.java
Removed:
    incubator/isis/trunk/viewer/bdd/concordion/src/main/java/org/apache/isis/viewer/bdd/concordion/internal/fixtures/bindings/CellBindingForConcordion.java
    incubator/isis/trunk/viewer/bdd/concordion/src/main/java/org/apache/isis/viewer/bdd/concordion/internal/fixtures/perform/StoryCellForConcordion.java
Modified:
    incubator/isis/trunk/viewer/bdd/concordion/src/main/java/org/apache/isis/viewer/bdd/concordion/internal/fixtures/AliasItemsInListForConcordion.java
    incubator/isis/trunk/viewer/bdd/concordion/src/main/java/org/apache/isis/viewer/bdd/concordion/internal/fixtures/SetUpObjectsForConcordion.java
    incubator/isis/trunk/viewer/bdd/concordion/src/main/java/org/apache/isis/viewer/bdd/concordion/internal/fixtures/UsingIsisViewerForConcordion.java
    incubator/isis/trunk/viewer/bdd/src/docbkx/guide/isis-bdd-viewer.xml

Copied: incubator/isis/trunk/viewer/bdd/common/src/main/java/org/apache/isis/viewer/bdd/common/CellBindingDefault.java (from r1035640, incubator/isis/trunk/viewer/bdd/concordion/src/main/java/org/apache/isis/viewer/bdd/concordion/internal/fixtures/bindings/CellBindingForConcordion.java)
URL: http://svn.apache.org/viewvc/incubator/isis/trunk/viewer/bdd/common/src/main/java/org/apache/isis/viewer/bdd/common/CellBindingDefault.java?p2=incubator/isis/trunk/viewer/bdd/common/src/main/java/org/apache/isis/viewer/bdd/common/CellBindingDefault.java&p1=incubator/isis/trunk/viewer/bdd/concordion/src/main/java/org/apache/isis/viewer/bdd/concordion/internal/fixtures/bindings/CellBindingForConcordion.java&r1=1035640&r2=1035645&rev=1035645&view=diff
==============================================================================
--- incubator/isis/trunk/viewer/bdd/concordion/src/main/java/org/apache/isis/viewer/bdd/concordion/internal/fixtures/bindings/CellBindingForConcordion.java (original)
+++ incubator/isis/trunk/viewer/bdd/common/src/main/java/org/apache/isis/viewer/bdd/common/CellBindingDefault.java Tue Nov 16 14:40:09 2010
@@ -1,9 +1,7 @@
-package org.apache.isis.viewer.bdd.concordion.internal.fixtures.bindings;
+package org.apache.isis.viewer.bdd.common;
 
-import org.apache.isis.viewer.bdd.common.CellBinding;
-import org.apache.isis.viewer.bdd.common.StoryCell;
 
-public class CellBindingForConcordion extends CellBinding {
+public class CellBindingDefault extends CellBinding {
 
     public static class Builder {
         private final String name;
@@ -32,8 +30,8 @@ public class CellBindingForConcordion ex
             return this;
         }
 
-        public CellBindingForConcordion build() {
-            return new CellBindingForConcordion(name, autoCreate, ditto, optional, headText);
+        public CellBindingDefault build() {
+            return new CellBindingDefault(name, autoCreate, ditto, optional, headText);
         }
     }
 
@@ -41,7 +39,7 @@ public class CellBindingForConcordion ex
         return new Builder(name, headText);
     }
 
-    private CellBindingForConcordion(final String name, final boolean autoCreate,
+    private CellBindingDefault(final String name, final boolean autoCreate,
             final boolean ditto, final boolean optional,
             final String[] headTexts) {
     	super(name, autoCreate, ditto, optional, headTexts);

Copied: incubator/isis/trunk/viewer/bdd/common/src/main/java/org/apache/isis/viewer/bdd/common/StoryCellDefault.java (from r1035640, incubator/isis/trunk/viewer/bdd/concordion/src/main/java/org/apache/isis/viewer/bdd/concordion/internal/fixtures/perform/StoryCellForConcordion.java)
URL: http://svn.apache.org/viewvc/incubator/isis/trunk/viewer/bdd/common/src/main/java/org/apache/isis/viewer/bdd/common/StoryCellDefault.java?p2=incubator/isis/trunk/viewer/bdd/common/src/main/java/org/apache/isis/viewer/bdd/common/StoryCellDefault.java&p1=incubator/isis/trunk/viewer/bdd/concordion/src/main/java/org/apache/isis/viewer/bdd/concordion/internal/fixtures/perform/StoryCellForConcordion.java&r1=1035640&r2=1035645&rev=1035645&view=diff
==============================================================================
--- incubator/isis/trunk/viewer/bdd/concordion/src/main/java/org/apache/isis/viewer/bdd/concordion/internal/fixtures/perform/StoryCellForConcordion.java (original)
+++ incubator/isis/trunk/viewer/bdd/common/src/main/java/org/apache/isis/viewer/bdd/common/StoryCellDefault.java Tue Nov 16 14:40:09 2010
@@ -1,36 +1,34 @@
-package org.apache.isis.viewer.bdd.concordion.internal.fixtures.perform;
+package org.apache.isis.viewer.bdd.common;
 
-import org.apache.isis.viewer.bdd.common.StoryCell;
 
 /**
  * Simply holds the text.
- *
+ * 
  */
-public class StoryCellForConcordion implements StoryCell {
-	
-// for FitNesse, the source is a fit.Parse, which is a mutable table cell.
-//	private Parse source;
-	
-	private String source;
-
-	public StoryCellForConcordion(String source) {
-		this.source = source;
-	}
-
-	public String getText() {
-		return source;
-	}
-
-	public void setText(String str) {
-		this.source = str;
-	}
-
-	/**
-	 * The implementation-specific representation of this text.
-	 */
-	public Object getSource() {
-		return source;
-	}
+public class StoryCellDefault implements StoryCell {
+
+    private String source;
+
+    public StoryCellDefault(String source) {
+        this.source = source;
+    }
+
+    @Override
+    public String getText() {
+        return source;
+    }
+
+    @Override
+    public void setText(String str) {
+        this.source = str;
+    }
+
+    /**
+     * The implementation-specific representation of this text.
+     */
+    @Override
+    public Object getSource() {
+        return source;
+    }
 
-	
 }

Modified: incubator/isis/trunk/viewer/bdd/concordion/src/main/java/org/apache/isis/viewer/bdd/concordion/internal/fixtures/AliasItemsInListForConcordion.java
URL: http://svn.apache.org/viewvc/incubator/isis/trunk/viewer/bdd/concordion/src/main/java/org/apache/isis/viewer/bdd/concordion/internal/fixtures/AliasItemsInListForConcordion.java?rev=1035645&r1=1035644&r2=1035645&view=diff
==============================================================================
--- incubator/isis/trunk/viewer/bdd/concordion/src/main/java/org/apache/isis/viewer/bdd/concordion/internal/fixtures/AliasItemsInListForConcordion.java (original)
+++ incubator/isis/trunk/viewer/bdd/concordion/src/main/java/org/apache/isis/viewer/bdd/concordion/internal/fixtures/AliasItemsInListForConcordion.java Tue Nov 16 14:40:09 2010
@@ -2,23 +2,23 @@ package org.apache.isis.viewer.bdd.conco
 
 import org.apache.isis.viewer.bdd.common.AliasRegistry;
 import org.apache.isis.viewer.bdd.common.CellBinding;
+import org.apache.isis.viewer.bdd.common.CellBindingDefault;
 import org.apache.isis.viewer.bdd.common.Constants;
 import org.apache.isis.viewer.bdd.common.StoryBoundValueException;
+import org.apache.isis.viewer.bdd.common.StoryCellDefault;
 import org.apache.isis.viewer.bdd.common.StoryValueException;
 import org.apache.isis.viewer.bdd.common.fixtures.AliasItemsInListPeer;
-import org.apache.isis.viewer.bdd.concordion.internal.fixtures.bindings.CellBindingForConcordion;
-import org.apache.isis.viewer.bdd.concordion.internal.fixtures.perform.StoryCellForConcordion;
 
 public class AliasItemsInListForConcordion extends
 		AbstractFixture<AliasItemsInListPeer> {
 
 	public AliasItemsInListForConcordion(final AliasRegistry aliasRegistry,
 			final String listAlias) {
-		this(aliasRegistry, listAlias, CellBindingForConcordion.builder(
+		this(aliasRegistry, listAlias, CellBindingDefault.builder(
 				Constants.TITLE_NAME, Constants.TITLE_HEAD).build(),
-				CellBindingForConcordion.builder(Constants.TYPE_NAME,
+				CellBindingDefault.builder(Constants.TYPE_NAME,
 						Constants.TYPE_HEAD).optional().build(),
-				CellBindingForConcordion.builder(Constants.ALIAS_RESULT_NAME,
+				CellBindingDefault.builder(Constants.ALIAS_RESULT_NAME,
 						Constants.ALIAS_RESULT_HEAD_SET).autoCreate().build());
 	}
 
@@ -56,7 +56,7 @@ public class AliasItemsInListForConcordi
 
 		if (type != null) {
 			getPeer().getTypeBinding().foundHeadColumn(2,
-					new StoryCellForConcordion(type));
+					new StoryCellDefault(type));
 		}
 		
 		return null;
@@ -79,10 +79,10 @@ public class AliasItemsInListForConcordi
 	}
 
 	private void captureCurrent(String aliasAs, String title, String type) {
-		getPeer().getAliasBinding().captureCurrent(new StoryCellForConcordion(aliasAs));
-		getPeer().getTitleBinding().captureCurrent(new StoryCellForConcordion(title));
+		getPeer().getAliasBinding().captureCurrent(new StoryCellDefault(aliasAs));
+		getPeer().getTitleBinding().captureCurrent(new StoryCellDefault(title));
 		if (type != null) {
-			getPeer().getTitleBinding().captureCurrent(new StoryCellForConcordion(type));
+			getPeer().getTitleBinding().captureCurrent(new StoryCellDefault(type));
 		}
 	}
 

Modified: incubator/isis/trunk/viewer/bdd/concordion/src/main/java/org/apache/isis/viewer/bdd/concordion/internal/fixtures/SetUpObjectsForConcordion.java
URL: http://svn.apache.org/viewvc/incubator/isis/trunk/viewer/bdd/concordion/src/main/java/org/apache/isis/viewer/bdd/concordion/internal/fixtures/SetUpObjectsForConcordion.java?rev=1035645&r1=1035644&r2=1035645&view=diff
==============================================================================
--- incubator/isis/trunk/viewer/bdd/concordion/src/main/java/org/apache/isis/viewer/bdd/concordion/internal/fixtures/SetUpObjectsForConcordion.java (original)
+++ incubator/isis/trunk/viewer/bdd/concordion/src/main/java/org/apache/isis/viewer/bdd/concordion/internal/fixtures/SetUpObjectsForConcordion.java Tue Nov 16 14:40:09 2010
@@ -2,16 +2,16 @@ package org.apache.isis.viewer.bdd.conco
 
 import org.apache.isis.viewer.bdd.common.AliasRegistry;
 import org.apache.isis.viewer.bdd.common.CellBinding;
+import org.apache.isis.viewer.bdd.common.CellBindingDefault;
 import org.apache.isis.viewer.bdd.common.Constants;
 import org.apache.isis.viewer.bdd.common.StoryBoundValueException;
 import org.apache.isis.viewer.bdd.common.fixtures.SetUpObjectsPeer;
-import org.apache.isis.viewer.bdd.concordion.internal.fixtures.bindings.CellBindingForConcordion;
 
 public class SetUpObjectsForConcordion extends AbstractFixture<SetUpObjectsPeer> {
 
     public SetUpObjectsForConcordion(final AliasRegistry aliasesRegistry, final String className,
         final SetUpObjectsPeer.Mode mode) {
-        this(aliasesRegistry, className, mode, CellBindingForConcordion
+        this(aliasesRegistry, className, mode, CellBindingDefault
             .builder(Constants.ALIAS_RESULT_NAME, Constants.ALIAS_RESULT_HEAD_SET).autoCreate().build());
     }
 

Modified: incubator/isis/trunk/viewer/bdd/concordion/src/main/java/org/apache/isis/viewer/bdd/concordion/internal/fixtures/UsingIsisViewerForConcordion.java
URL: http://svn.apache.org/viewvc/incubator/isis/trunk/viewer/bdd/concordion/src/main/java/org/apache/isis/viewer/bdd/concordion/internal/fixtures/UsingIsisViewerForConcordion.java?rev=1035645&r1=1035644&r2=1035645&view=diff
==============================================================================
--- incubator/isis/trunk/viewer/bdd/concordion/src/main/java/org/apache/isis/viewer/bdd/concordion/internal/fixtures/UsingIsisViewerForConcordion.java (original)
+++ incubator/isis/trunk/viewer/bdd/concordion/src/main/java/org/apache/isis/viewer/bdd/concordion/internal/fixtures/UsingIsisViewerForConcordion.java Tue Nov 16 14:40:09 2010
@@ -7,13 +7,13 @@ import org.apache.isis.core.metamodel.ad
 import org.apache.isis.core.metamodel.spec.feature.ObjectMember;
 import org.apache.isis.viewer.bdd.common.AliasRegistry;
 import org.apache.isis.viewer.bdd.common.CellBinding;
+import org.apache.isis.viewer.bdd.common.CellBindingDefault;
 import org.apache.isis.viewer.bdd.common.Constants;
 import org.apache.isis.viewer.bdd.common.StoryBoundValueException;
 import org.apache.isis.viewer.bdd.common.StoryCell;
+import org.apache.isis.viewer.bdd.common.StoryCellDefault;
 import org.apache.isis.viewer.bdd.common.fixtures.UsingIsisViewerPeer;
 import org.apache.isis.viewer.bdd.common.fixtures.perform.Perform;
-import org.apache.isis.viewer.bdd.concordion.internal.fixtures.bindings.CellBindingForConcordion;
-import org.apache.isis.viewer.bdd.concordion.internal.fixtures.perform.StoryCellForConcordion;
 
 import com.google.common.collect.Lists;
 
@@ -26,22 +26,22 @@ public class UsingIsisViewerForConcordio
 			final AliasRegistry aliasesRegistry,
 			final Perform.Mode mode) {
 		this(aliasesRegistry, mode, 
-				CellBindingForConcordion.builder(
+				CellBindingDefault.builder(
 						Constants.ON_OBJECT_NAME, Constants.ON_OBJECT_HEAD_SET)
 						.ditto().build(),
-				CellBindingForConcordion.builder(
+				CellBindingDefault.builder(
 						Constants.ALIAS_RESULT_NAME, Constants.ALIAS_RESULT_HEAD_SET)
 						.optional().build(), 
-				CellBindingForConcordion.builder(
+				CellBindingDefault.builder(
 						Constants.PERFORM_NAME, Constants.PERFORM_HEAD_SET)
 						.ditto().build(), 
-				CellBindingForConcordion.builder(
+				CellBindingDefault.builder(
 						Constants.ON_MEMBER_NAME, Constants.ON_MEMBER_HEAD_SET)
 						.optional().build(),
-				CellBindingForConcordion.builder(
+				CellBindingDefault.builder(
 						Constants.THAT_IT_NAME, Constants.THAT_IT_HEAD_SET)
 						.ditto().optional().build(), 
-				CellBindingForConcordion.builder(
+				CellBindingDefault.builder(
 						Constants.WITH_ARGUMENTS_NAME, Constants.WITH_ARGUMENTS_HEAD_SET)
 						.optional().build());
 	}
@@ -90,15 +90,15 @@ public class UsingIsisViewerForConcordio
 				thatIt, arg0);
 
 		// capture current
-		getPeer().getOnObjectBinding().captureCurrent(new StoryCellForConcordion(onObject));
-		getPeer().getAliasResultAsBinding().captureCurrent(new StoryCellForConcordion(aliasResultAs));
-		getPeer().getPerformBinding().captureCurrent(new StoryCellForConcordion(perform));
-		getPeer().getOnMemberBinding().captureCurrent(new StoryCellForConcordion(usingMember));
+		getPeer().getOnObjectBinding().captureCurrent(new StoryCellDefault(onObject));
+		getPeer().getAliasResultAsBinding().captureCurrent(new StoryCellDefault(aliasResultAs));
+		getPeer().getPerformBinding().captureCurrent(new StoryCellDefault(perform));
+		getPeer().getOnMemberBinding().captureCurrent(new StoryCellDefault(usingMember));
 		if (getPeer().getThatItBinding().isFound()) {
-			getPeer().getThatItBinding().captureCurrent(new StoryCellForConcordion(thatIt));
+			getPeer().getThatItBinding().captureCurrent(new StoryCellDefault(thatIt));
 		}
 		if (getPeer().getArg0Binding().isFound()) {
-			getPeer().getArg0Binding().captureCurrent(new StoryCellForConcordion(arg0));
+			getPeer().getArg0Binding().captureCurrent(new StoryCellDefault(arg0));
 			argumentCells.add(arg0);
 		}
 		for (String arg: remainingArgs) {
@@ -132,7 +132,7 @@ public class UsingIsisViewerForConcordio
 	private static List<StoryCell> asValues(List<String> argumentCells) {
 		List<StoryCell> storyValues = Lists.newArrayList();
 		for (String arg : argumentCells) {
-			storyValues.add(new StoryCellForConcordion(arg));
+			storyValues.add(new StoryCellDefault(arg));
 		}
 		return storyValues;
 	}

Modified: incubator/isis/trunk/viewer/bdd/src/docbkx/guide/isis-bdd-viewer.xml
URL: http://svn.apache.org/viewvc/incubator/isis/trunk/viewer/bdd/src/docbkx/guide/isis-bdd-viewer.xml?rev=1035645&r1=1035644&r2=1035645&view=diff
==============================================================================
--- incubator/isis/trunk/viewer/bdd/src/docbkx/guide/isis-bdd-viewer.xml (original)
+++ incubator/isis/trunk/viewer/bdd/src/docbkx/guide/isis-bdd-viewer.xml Tue Nov 16 14:40:09 2010
@@ -1123,7 +1123,44 @@ Isis system &lt;span concordion:assertTr
           <title>Common</title>
 
           <para>The common library support for setting up objects using the
-          SetUpObjectsPeer.</para>
+          <classname>SetUpObjectsPeer</classname> class. The constructor for
+          this class takes the following arguments:</para>
+
+          <itemizedlist>
+            <listitem>
+              <para><classname>AliasRegistry</classname>
+              <varname>aliasRegistry</varname></para>
+
+              <para>the alias registry which is used to lookup aliases to
+              existing objects, and is populated with aliases for the new
+              created objects (if an alias binding is specified; see
+              below).</para>
+            </listitem>
+
+            <listitem>
+              <para><classname>String</classname>
+              <varname>className</varname></para>
+
+              <para>This is the fully qualified class name of the object to be
+              instantiated</para>
+            </listitem>
+
+            <listitem>
+              <para><classname>SetUpObjectsPeer.Mode</classname>
+              <varname>mode</varname></para>
+
+              <para>This is whether the object is to be persisted or
+              not</para>
+            </listitem>
+
+            <listitem>
+              <para><classname>CellBinding</classname> aliasBinding</para>
+
+              <para>This object represents a binding to a cell that will hold
+              the reference to each newly created object. It can be left
+              <literal>null</literal> if required.</para>
+            </listitem>
+          </itemizedlist>
 
           <para></para>