Implement the Caption MDX function.

[git-p4: depot-paths = "//open/mondrian/": change = 2966]
pentaho · Dec 17, 2004 · f0dbfdc · f0dbfdc
1 parent 13fc8f3
commit f0dbfdc
Show file tree

Hide file tree

Showing 2 changed files with 48 additions and 3 deletions.
diff --git a/src/main/mondrian/olap/fun/BuiltinFunTable.java b/src/main/mondrian/olap/fun/BuiltinFunTable.java
@@ -1954,6 +1954,30 @@ public Object evaluate(Evaluator evaluator, Exp[] args) {
 					return getStringArg(evaluator, args, 2, null);
 			}
 		});
+		define(new FunDefBase("Caption", "<Dimension>.Caption", "Returns the caption of a dimension.", "pSd") {
+			public Object evaluate(Evaluator evaluator, Exp[] args) {
+				Dimension dimension = getDimensionArg(evaluator, args, 0, true);
+				return dimension.getCaption();
+			}
+		});
+		define(new FunDefBase("Caption", "<Hierarchy>.Caption", "Returns the caption of a hierarchy.", "pSh") {
+			public Object evaluate(Evaluator evaluator, Exp[] args) {
+				Hierarchy hierarchy = getHierarchyArg(evaluator, args, 0, true);
+				return hierarchy.getCaption();
+			}
+		});
+		define(new FunDefBase("Caption", "<Level>.Caption", "Returns the caption of a level.", "pSl") {
+			public Object evaluate(Evaluator evaluator, Exp[] args) {
+				Level level = getLevelArg(evaluator, args, 0, true);
+				return level.getCaption();
+			}
+		});
+		define(new FunDefBase("Caption", "<Member>.Caption", "Returns the caption of a member.", "pSm") {
+			public Object evaluate(Evaluator evaluator, Exp[] args) {
+				Member member = getMemberArg(evaluator, args, 0, true);
+				return member.getCaption();
+			}
+		});
 		define(new FunDefBase("Name", "<Dimension>.Name", "Returns the name of a dimension.", "pSd") {
 			public Object evaluate(Evaluator evaluator, Exp[] args) {
 				Dimension dimension = getDimensionArg(evaluator, args, 0, true);

diff --git a/testsrc/main/mondrian/olap/fun/FunctionTest.java b/testsrc/main/mondrian/olap/fun/FunctionTest.java
@@ -1623,7 +1623,28 @@ public void testIIf() {
         Assert.assertEquals("Yes", s);
     }
 
+
+    public void testDimensionCaption() {
+        String s = executeExpr("[Time].[1997].Dimension.Caption");
+        Assert.assertEquals("Time", s);
+    }
+
+    public void testHierarchyCaption() {
+        String s = executeExpr("[Time].[1997].Hierarchy.Caption");
+        Assert.assertEquals("Time", s);
+    }
 
+    public void testLevelCaption() {
+        String s = executeExpr("[Time].[1997].Level.Caption");
+        Assert.assertEquals("Year", s);
+    }
+
+    public void testMemberCaption() {
+        String s = executeExpr("[Time].[1997].Caption");
+        Assert.assertEquals("1997", s);
+    }
+
+
     public void testDimensionName() {
         String s = executeExpr("[Time].[1997].Dimension.Name");
         Assert.assertEquals("Time", s);
@@ -1633,18 +1654,18 @@ public void testHierarchyName() {
         String s = executeExpr("[Time].[1997].Hierarchy.Name");
         Assert.assertEquals("Time", s);
     }
-
+    
     public void testLevelName() {
         String s = executeExpr("[Time].[1997].Level.Name");
         Assert.assertEquals("Year", s);
     }
-
+    
     public void testMemberName() {
         String s = executeExpr("[Time].[1997].Name");
         Assert.assertEquals("1997", s);
     }
 
-
+    
     public void testDimensionUniqueName() {
         String s = executeExpr("[Gender].DefaultMember.Dimension.UniqueName");
         Assert.assertEquals("[Gender]", s);