Add experimental org.olap4j.transform package, and method ParseTreeNo…

…de.deepCopy() (contributed by Etienne Dube)

git-svn-id: https://olap4j.svn.sourceforge.net/svnroot/olap4j/trunk@107 c6a108a4-781c-0410-a6c6-c2d559e19af0

src/org/olap4j/mdx/AxisNode.java

@@ -3,13 +3,14 @@
 // This software is subject to the terms of the Common Public License
 // Agreement, available at the following URL:
 // http://www.opensource.org/licenses/cpl.html.
-// Copyright (C) 2007-2007 Julian Hyde
+// Copyright (C) 2007-2008 Julian Hyde
 // All Rights Reserved.
 // You must accept the terms of that agreement to use this software.
 */
 package org.olap4j.mdx;
 
 import java.io.PrintWriter;
+import java.util.ArrayList;
 import java.util.List;
 import java.util.Collections;
 
@@ -158,6 +159,15 @@ public Type getType() {
  // Try AxisNode.getExpression().getType() instead.
  return null;
  }
+
+ public AxisNode deepCopy() {
+ return new AxisNode(
+ this.region,
+ this.nonEmpty,
+ this.axis,
+ MdxUtil.deepCopyList(dimensionProperties),
+ this.expression.deepCopy());
+ }
 }
 
 // End AxisNode.java

src/org/olap4j/mdx/CallNode.java

@@ -3,7 +3,7 @@
 // This software is subject to the terms of the Common Public License
 // Agreement, available at the following URL:
 // http://www.opensource.org/licenses/cpl.html.
-// Copyright (C) 2007-2007 Julian Hyde
+// Copyright (C) 2007-2008 Julian Hyde
 // All Rights Reserved.
 // You must accept the terms of that agreement to use this software.
 */
@@ -49,7 +49,7 @@ public class CallNode implements ParseTreeNode {
  * <p>The <code>syntax</code> argument determines whether this is a prefix,
  * infix or postfix operator, a function call, and so forth.
  *
- * <p>The list of arguuments <code>args</code> must be specified, even if
+ * <p>The list of arguments <code>args</code> must be specified, even if
  * there are zero arguments, and each argument must be not null.
  *
  * <p>The type is initially null, but can be set using {@link #setType}
@@ -99,7 +99,7 @@ public CallNode(
  * <p>The <code>syntax</code> argument determines whether this is a prefix,
  * infix or postfix operator, a function call, and so forth.
  *
- * <p>The list of arguuments <code>args</code> must be specified, even if
+ * <p>The list of arguments <code>args</code> must be specified, even if
  * there are zero arguments, and each argument must be not null.
  *
  * @param region Region of source code
@@ -177,6 +177,14 @@ public Syntax getSyntax() {
  public List<ParseTreeNode> getArgList() {
  return argList;
  }
+
+ public CallNode deepCopy() {
+ return new CallNode(
+ this.region,
+ this.name,
+ this.syntax,
+ MdxUtil.deepCopyList(argList));
+ }
 }
 
 // End CallNode.java

src/org/olap4j/mdx/CubeNode.java

@@ -3,7 +3,7 @@
 // This software is subject to the terms of the Common Public License
 // Agreement, available at the following URL:
 // http://www.opensource.org/licenses/cpl.html.
-// Copyright (C) 2007-2007 Julian Hyde
+// Copyright (C) 2007-2008 Julian Hyde
 // All Rights Reserved.
 // You must accept the terms of that agreement to use this software.
 */
@@ -67,6 +67,12 @@ public void unparse(ParseTreeWriter writer) {
  public String toString() {
  return cube.getUniqueName();
  }
+
+ public CubeNode deepCopy() {
+ // CubeNode is immutable
+ return this;
+ }
+
 }
 
 // End CubeNode.java

src/org/olap4j/mdx/DimensionNode.java

@@ -3,7 +3,7 @@
 // This software is subject to the terms of the Common Public License
 // Agreement, available at the following URL:
 // http://www.opensource.org/licenses/cpl.html.
-// Copyright (C) 2007-2007 Julian Hyde
+// Copyright (C) 2007-2008 Julian Hyde
 // All Rights Reserved.
 // You must accept the terms of that agreement to use this software.
 */
@@ -67,6 +67,11 @@ public void unparse(ParseTreeWriter writer) {
  public String toString() {
  return dimension.getUniqueName();
  }
+
+ public DimensionNode deepCopy() {
+ // DimensionNode is immutable
+ return this;
+ }
 }
 
 // End DimensionNode.java

src/org/olap4j/mdx/HierarchyNode.java

@@ -3,7 +3,7 @@
 // This software is subject to the terms of the Common Public License
 // Agreement, available at the following URL:
 // http://www.opensource.org/licenses/cpl.html.
-// Copyright (C) 2007-2007 Julian Hyde
+// Copyright (C) 2007-2008 Julian Hyde
 // All Rights Reserved.
 // You must accept the terms of that agreement to use this software.
 */
@@ -69,6 +69,11 @@ public void unparse(ParseTreeWriter writer) {
  public String toString() {
  return hierarchy.getUniqueName();
  }
+
+ public HierarchyNode deepCopy() {
+ // HierarchyNode is immutable
+ return this;
+ }
 }
 
 // End HierarchyNode.java

src/org/olap4j/mdx/IdentifierNode.java

@@ -3,7 +3,7 @@
 // This software is subject to the terms of the Common Public License
 // Agreement, available at the following URL:
 // http://www.opensource.org/licenses/cpl.html.
-// Copyright (C) 2007-2007 Julian Hyde
+// Copyright (C) 2007-2008 Julian Hyde
 // All Rights Reserved.
 // You must accept the terms of that agreement to use this software.
 */
@@ -137,6 +137,11 @@ public String toString() {
  return buf.toString();
  }
 
+ public IdentifierNode deepCopy() {
+ // IdentifierNode is immutable
+ return this;
+ }
+
  /**
  * Parses an MDX identifier into a list of segments.
  *
@@ -270,7 +275,7 @@ static void quoteMdxIdentifier(String id, StringBuilder buf) {
  *
  * <p>For example, {"Store", "USA",
  * "California"} becomes "[Store].[USA].[California]".
- * 
+ *
  * @param ids List of segments
  * @return Segments as quoted string
  */

src/org/olap4j/mdx/LevelNode.java

@@ -3,7 +3,7 @@
 // This software is subject to the terms of the Common Public License
 // Agreement, available at the following URL:
 // http://www.opensource.org/licenses/cpl.html.
-// Copyright (C) 2007-2007 Julian Hyde
+// Copyright (C) 2007-2008 Julian Hyde
 // All Rights Reserved.
 // You must accept the terms of that agreement to use this software.
 */
@@ -70,6 +70,12 @@ public void unparse(ParseTreeWriter writer) {
  public String toString() {
  return level.getUniqueName();
  }
+
+ public LevelNode deepCopy() {
+ // LevelNode is immutable
+ return this;
+ }
+
 }
 
 // End LevelNode.java

src/org/olap4j/mdx/LiteralNode.java

@@ -3,7 +3,7 @@
 // This software is subject to the terms of the Common Public License
 // Agreement, available at the following URL:
 // http://www.opensource.org/licenses/cpl.html.
-// Copyright (C) 2007-2007 Julian Hyde
+// Copyright (C) 2007-2008 Julian Hyde
 // All Rights Reserved.
 // You must accept the terms of that agreement to use this software.
 */
@@ -20,6 +20,8 @@
  * <code>Order([Store].Members, [Measures].[Unit Sales], ASC)</code>, are
  * also represented as Literals.
  *
+ * <p>A LiteralNode is immutable.
+ *
  * @version $Id$
  * @author jhyde
  */
@@ -174,6 +176,12 @@ public void unparse(ParseTreeWriter writer) {
  throw new AssertionError("unexpected literal type " + type);
  }
  }
+
+ public LiteralNode deepCopy() {
+ // No need to copy: literal nodes are immutable.
+ return this;
+ }
+
 }
 
 // End LiteralNode.java

src/org/olap4j/mdx/MdxUtil.java

@@ -3,13 +3,14 @@
 // This software is subject to the terms of the Common Public License
 // Agreement, available at the following URL:
 // http://www.opensource.org/licenses/cpl.html.
-// Copyright (C) 2007-2007 Julian Hyde
+// Copyright (C) 2007-2008 Julian Hyde
 // All Rights Reserved.
 // You must accept the terms of that agreement to use this software.
 */
 package org.olap4j.mdx;
 
 import java.util.regex.Pattern;
+import java.util.*;
 import java.io.StringWriter;
 import java.io.PrintWriter;
 
@@ -28,6 +29,9 @@ class MdxUtil {
 
  /**
  * Converts a string into a double-quoted string.
+ *
+ * @param val String
+ * @return String enclosed in double-quotes
  */
  static String quoteForMdx(String val) {
  StringBuilder buf = new StringBuilder(val.length() + 20);
@@ -48,21 +52,43 @@ static String toString(ParseTreeNode node) {
 
  /**
  * Encodes string for MDX (escapes ] as ]] inside a name).
+ *
+ * @param st String
+ * @return String escaped for inclusion in an MDX identifier
  */
  static String mdxEncodeString(String st) {
  StringBuilder retString = new StringBuilder(st.length() + 20);
  for (int i = 0; i < st.length(); i++) {
  char c = st.charAt(i);
  if ((c == ']') &&
- ((i+1) < st.length()) &&
- (st.charAt(i+1) != '.')) {
+ ((i + 1) < st.length()) &&
+ (st.charAt(i + 1) != '.')) {
 
  retString.append(']'); //escaping character
  }
  retString.append(c);
  }
  return retString.toString();
  }
+
+ /**
+ * Creates a deep copy of a list.
+ *
+ * @param list List to be copied
+ * @return Copy of list, with each element deep copied
+ */
+ @SuppressWarnings({"unchecked"})
+ static <E extends ParseTreeNode> List<E> deepCopyList(List<E> list) {
+ // Don't make a copy of the system empty list. '==' is intentional.
+ if (list == Collections.EMPTY_LIST) {
+ return list;
+ }
+ final ArrayList<E> listCopy = new ArrayList<E>(list.size());
+ for (E e : list) {
+ listCopy.add((E) e.deepCopy());
+ }
+ return listCopy;
+ }
 }
 
 // End MdxUtil.java

src/org/olap4j/mdx/MemberNode.java

@@ -3,7 +3,7 @@
 // This software is subject to the terms of the Common Public License
 // Agreement, available at the following URL:
 // http://www.opensource.org/licenses/cpl.html.
-// Copyright (C) 2007-2007 Julian Hyde
+// Copyright (C) 2007-2008 Julian Hyde
 // All Rights Reserved.
 // You must accept the terms of that agreement to use this software.
 */
@@ -71,6 +71,11 @@ public void unparse(ParseTreeWriter writer) {
  public String toString() {
  return member.getUniqueName();
  }
+
+ public MemberNode deepCopy() {
+ // MemberNode is immutable
+ return this;
+ }
 }
 
 // End MemberNode.java

src/org/olap4j/mdx/ParameterNode.java

@@ -3,7 +3,7 @@
 // This software is subject to the terms of the Common Public License
 // Agreement, available at the following URL:
 // http://www.opensource.org/licenses/cpl.html.
-// Copyright (C) 2007-2007 Julian Hyde
+// Copyright (C) 2007-2008 Julian Hyde
 // All Rights Reserved.
 // You must accept the terms of that agreement to use this software.
 */
@@ -41,6 +41,7 @@ public class ParameterNode implements ParseTreeNode {
  * <code>defaultValueExpression</code> must be consistent with the
  * <code>type</code>.
  *
+ * @param region Region of source code
  * @param name Name of parameter
  * @param type Type of parameter
  * @param defaultValueExpression Expression which yields the default value
@@ -133,6 +134,13 @@ public void setDefaultValueExpression(ParseTreeNode defaultValueExpression) {
  this.defaultValueExpression = defaultValueExpression;
  }
 
+ public ParameterNode deepCopy() {
+ return new ParameterNode(
+ this.region,
+ this.name,
+ this.type, // types are immutable
+ this.defaultValueExpression.deepCopy());
+ }
 }
 
 // End ParameterNode.java

src/org/olap4j/mdx/ParseTreeNode.java

@@ -3,7 +3,7 @@
 // This software is subject to the terms of the Common Public License
 // Agreement, available at the following URL:
 // http://www.opensource.org/licenses/cpl.html.
-// Copyright (C) 2007-2007 Julian Hyde
+// Copyright (C) 2007-2008 Julian Hyde
 // All Rights Reserved.
 // You must accept the terms of that agreement to use this software.
 */
@@ -66,6 +66,17 @@ public interface ParseTreeNode {
  * created by parsing
  */
  ParseRegion getRegion();
+
+ /**
+ * Creates a deep copy of this ParseTreeNode object.
+ *
+ * <p>Note: implementing classes can return the concrete type instead
+ * of ParseTreeNode (using Java 1.5 covariant return types)
+ *
+ * @return The deep copy of this ParseTreeNode
+ */
+ ParseTreeNode deepCopy();
+
 }
 
 // End ParseTreeNode.java

src/org/olap4j/mdx/PropertyValueNode.java

@@ -3,7 +3,7 @@
 // This software is subject to the terms of the Common Public License
 // Agreement, available at the following URL:
 // http://www.opensource.org/licenses/cpl.html.
-// Copyright (C) 2007-2007 Julian Hyde
+// Copyright (C) 2007-2008 Julian Hyde
 // All Rights Reserved.
 // You must accept the terms of that agreement to use this software.
 */
@@ -81,6 +81,13 @@ public void unparse(ParseTreeWriter writer) {
  writer.getPrintWriter().print(name + " = ");
  expression.unparse(writer);
  }
+
+ public PropertyValueNode deepCopy() {
+ return new PropertyValueNode(
+ this.region,
+ this.name,
+ this.expression.deepCopy());
+ }
 }
 
 // End PropertyValueNode.java