Added option to include 'All member' when place hierarchy

Author: hiberus-os

pivot4j-core/src/main/java/org/pivot4j/transform/PlaceHierarchiesOnAxes.java

@@ -21,16 +21,16 @@
  * <li>The GUI will examine the result of the olap query to find out which
  * hierarchies are currently displayed on what axes. It will use
  * Axis.getHierarchies() for this.</li>
- * 
+ *
  * <li>Then it will find out what Hierarchies exist by calling
  * OlapModel.getDimensions() and Dimension.getHierarchies().</li>
- * 
+ *
  * <li>The Information will be presented to the user and he will be allowed to
  * change the mapping between axes and hierarchies.</li>
- * 
+ *
  * <li>For every Hierarchy that the user selected for display on an axis, the
  * GUI will call createMemberExpression().</li>
- * 
+ *
  * <li>For each axis the system will build the the array of memberExpressions
  * and call setAxis once.</li>
  * </ul>
@@ -45,9 +45,22 @@ public interface PlaceHierarchiesOnAxes extends Transform {
 	 * @param expandAllMember
 	 *            If this flag is set and an "All" member is put onto an axis,
 	 *            the children of the All member will be added as well.
+	 * @param includeAllMember
+	 * 			  If this flag is set and an "All" member is put onto axis,
+	 * 			  include Union (All + Children). If it's false, only includes Children.
 	 */
-	void placeHierarchies(Axis axis, List<Hierarchy> hierarchies,
-			boolean expandAllMember);
+	void placeHierarchies(Axis axis, List<Hierarchy> hierarchies, boolean expandAllMember, boolean includeAllMember);
+
+	/**
+	 * @param axis
+	 *            The target axis
+	 * @param hierarchies
+	 *            The hierarchies to put
+	 * @param expandAllMember
+	 *            If this flag is set and an "All" member is put onto an axis,
+	 *            the children of the All member will be added as well.
+	 */
+	void placeHierarchies(Axis axis, List<Hierarchy> hierarchies, boolean expandAllMember);
 
 	/**
 	 * @param axis
@@ -60,7 +73,24 @@ void placeHierarchies(Axis axis, List<Hierarchy> hierarchies,
 	 *            than ZERO will put the hierarchy at the end of the axis.
 	 */
 	void addHierarchy(Axis axis, Hierarchy hierarchy, boolean expandAllMember,
-			int position);
+					  int position);
+
+	/**
+	 * @param axis
+	 *            The target axis
+	 * @param hierarchy
+	 *            The hierarchy to add
+	 * @param expandAllMember
+	 *
+	 * @param includeAllMember
+	 * 			  If this flag is set and an "All" member is put onto axis,
+	 * 			  include Union (All + Children). If it's false, only includes Children.
+	 * @param position
+	 *            The position index where to add the hierarchy. Any value less
+	 *            than ZERO will put the hierarchy at the end of the axis.
+	 */
+	void addHierarchy(Axis axis, Hierarchy hierarchy, boolean expandAllMember, boolean includeAllMember,
+					  int position);
 
 	/**
 	 * @param axis
@@ -83,7 +113,7 @@ void addHierarchy(Axis axis, Hierarchy hierarchy, boolean expandAllMember,
 	/**
 	 * Collects all hierarchies on a given axis in the result. If no hierarchies
 	 * are visible, it returns an empty list.
-	 * 
+	 *
 	 * @param axis
 	 *            the axis to use
 	 * @return A list of hierarchies

pivot4j-core/src/main/java/org/pivot4j/transform/impl/PlaceHierarchiesOnAxesImpl.java

@@ -42,22 +42,26 @@ public class PlaceHierarchiesOnAxesImpl extends AbstractTransform implements
 	 * @param connection
 	 */
 	public PlaceHierarchiesOnAxesImpl(QueryAdapter queryAdapter,
-			OlapConnection connection) {
+									  OlapConnection connection) {
 		super(queryAdapter, connection);
 	}
 
+	public void placeHierarchies(Axis axis, List<Hierarchy> hierarchies,
+								 boolean expandAllMember) {
+		placeHierarchies(axis, hierarchies, expandAllMember, true);
+	}
 	/**
 	 * @see org.pivot4j.transform.PlaceHierarchiesOnAxes#placeHierarchies(org.olap4j.Axis,
-	 *      java.util.List, boolean)
+	 *      java.util.List, boolean, boolean)
 	 */
 	public void placeHierarchies(Axis axis, List<Hierarchy> hierarchies,
-			boolean expandAllMember) {
+								 boolean expandAllMember, boolean includeAllMember) {
 		QueryAdapter adapter = getQueryAdapter();
 
 		List<Exp> memberExpressions = new ArrayList<Exp>();
 		for (Hierarchy hierarchy : hierarchies) {
 			memberExpressions.add(createMemberExpression(hierarchy,
-					expandAllMember));
+					expandAllMember, includeAllMember));
 		}
 
 		Quax quax = adapter.getQuax(axis);
@@ -100,7 +104,17 @@ public void placeHierarchies(Axis axis, List<Hierarchy> hierarchies,
 	 */
 	@Override
 	public void addHierarchy(Axis axis, Hierarchy hierarchy,
-			boolean expandAllMember, int position) {
+							 boolean expandAllMember, int position) {
+		addHierarchy(axis, hierarchy, expandAllMember, true, position);
+	}
+
+	/**
+	 * @see org.pivot4j.transform.PlaceHierarchiesOnAxes#addHierarchy(org.olap4j.Axis,
+	 *      org.olap4j.metadata.Hierarchy, boolean, boolean, int)
+	 */
+	@Override
+	public void addHierarchy(Axis axis, Hierarchy hierarchy,
+							 boolean expandAllMember, boolean includeAllMember, int position) {
 		List<Hierarchy> hierarchies = findVisibleHierarchies(axis);
 
 		if (hierarchies.contains(hierarchy)) {
@@ -116,7 +130,7 @@ public void addHierarchy(Axis axis, Hierarchy hierarchy,
 			hierarchies.add(position, hierarchy);
 		}
 
-		placeHierarchies(axis, hierarchies, expandAllMember);
+		placeHierarchies(axis, hierarchies, expandAllMember, includeAllMember);
 	}
 
 	/**
@@ -199,7 +213,7 @@ public List<Hierarchy> findVisibleHierarchies(Axis axis) {
 	 * @return
 	 */
 	protected Exp createMemberExpression(Hierarchy hierarchy,
-			boolean expandAllMember) {
+										 boolean expandAllMember, boolean includeAllMember) {
 		// if the query does not contain the hierarchy,
 		// just return the highest level
 		QueryAdapter adapter = getQueryAdapter();
@@ -209,7 +223,7 @@ protected Exp createMemberExpression(Hierarchy hierarchy,
 		if (quax == null) {
 			adapter.getCurrentMdx(true);
 			// the hierarchy was not found on any axis
-			return topLevelMembers(hierarchy, expandAllMember);
+			return topLevelMembers(hierarchy, expandAllMember, includeAllMember);
 			// return top level members of the hierarchy
 		}
 
@@ -222,12 +236,12 @@ protected Exp createMemberExpression(Hierarchy hierarchy,
 
 	/**
 	 * TODO Merge with {@link QuaxUtil#topLevelMembers(Hierarchy, boolean)}
-	 * 
+	 *
 	 * @param hierarchy
 	 * @param expandAllMember
 	 * @return
 	 */
-	protected Exp topLevelMembers(Hierarchy hierarchy, boolean expandAllMember) {
+	protected Exp topLevelMembers(Hierarchy hierarchy, boolean expandAllMember, boolean includeAllMember) {
 		try {
 			if (hierarchy.hasAll()) {
 				// an "All" member is present -get it
@@ -260,20 +274,29 @@ protected Exp topLevelMembers(Hierarchy hierarchy, boolean expandAllMember) {
 
 					// must expand
 					// create Union({AllMember}, AllMember.children)
-					Exp allExp = new MemberExp(allMember);
+					if (includeAllMember) {
+						Exp allExp = new MemberExp(allMember);
 
-					FunCall allSet = new FunCall("{}", Syntax.Braces);
-					allSet.getArgs().add(allExp);
+						FunCall allSet = new FunCall("{}", Syntax.Braces);
+						allSet.getArgs().add(allExp);
 
-					FunCall mAllChildren = new FunCall("Children",
-							Syntax.Property);
-					mAllChildren.getArgs().add(allExp);
+						FunCall mAllChildren = new FunCall("Children",
+								Syntax.Property);
+						mAllChildren.getArgs().add(allExp);
 
-					FunCall union = new FunCall("Union", Syntax.Function);
-					union.getArgs().add(allSet);
-					union.getArgs().add(mAllChildren);
+						FunCall union = new FunCall("Union", Syntax.Function);
+						union.getArgs().add(allSet);
+						union.getArgs().add(mAllChildren);
 
-					return union;
+						return union;
+					} else {
+						Exp allExp = new MemberExp(allMember);
+
+						FunCall mAllChildren = new FunCall("Children",
+								Syntax.Property);
+						mAllChildren.getArgs().add(allExp);
+						return mAllChildren;
+					}
 				}
 			}
 
@@ -304,4 +327,4 @@ protected Exp topLevelMembers(Hierarchy hierarchy, boolean expandAllMember) {
 			throw new PivotException(e);
 		}
 	}
-}
+}