diff --git a/src/org/olap4j/query/LimitFunction.java b/src/org/olap4j/query/LimitFunction.java index afcadb1..4e50f52 100644 --- a/src/org/olap4j/query/LimitFunction.java +++ b/src/org/olap4j/query/LimitFunction.java @@ -18,7 +18,7 @@ package org.olap4j.query; /** - * Defines in what order to perform sort operations. + * Defines the function used to limit an optionally sorted set. * * @author Paul Stoellberger * @since 1.0.1 diff --git a/src/org/olap4j/query/QueryAxis.java b/src/org/olap4j/query/QueryAxis.java index ade1712..ae54f87 100644 --- a/src/org/olap4j/query/QueryAxis.java +++ b/src/org/olap4j/query/QueryAxis.java @@ -358,7 +358,7 @@ public String getSortIdentifierNodeName() { /** * Returns a specified number of items from the - * top of the axis set + * top of the axis set. * @param n */ public void topCount(BigDecimal n) { @@ -368,7 +368,7 @@ public void topCount(BigDecimal n) { /** * Returns a specified number of items from the - * bottom of the axis set + * bottom of the axis set. * @param n */ public void bottomCount(BigDecimal n) { @@ -378,7 +378,7 @@ public void bottomCount(BigDecimal n) { /** * Limit the axis set to a specified number of items depending - * on the sortLiteral and {@link LimitFunction} + * on the limitSortLiteral and {@link LimitFunction}. * @param n - number of items/cumulative sum/percentage */ public void limit(LimitFunction function, BigDecimal n, String limitSortLiteral) { @@ -388,7 +388,7 @@ public void limit(LimitFunction function, BigDecimal n, String limitSortLiteral) } /** - * Clears the limit parameters of that axis + * Clears the limit parameters of that axis. */ public void clearLimitFunction() { this.limitFunction = null; @@ -404,8 +404,8 @@ public LimitFunction getLimitFunction() { } /** - * @return the number of items/cumulative sum/percentage - * being used by the {@link LimitFunction)} + * @return The number of items or cumulative sum or percentage + * being used by the {@link LimitFunction}. */ public BigDecimal getLimitFunctionN() { return limitFunctionN; @@ -422,7 +422,7 @@ public BigDecimal getLimitFunctionN() { /** * Filter the axis using the given condition before TopCount / Order - * are applied + * are applied. * @param filterCondition - the condition used for Filter() */ public void filter(String filterCondition) { @@ -430,7 +430,7 @@ public void filter(String filterCondition) { } /** - * Returns the Filter Condition used to filter the axis set + * Returns the Filter Condition used to filter the axis set. * @return filter condition */ public String getFilterCondition() { @@ -438,7 +438,7 @@ public String getFilterCondition() { } /** - * Clears the filter for this axis + * Clears the filter condition for this axis. */ public void clearFilter() { this.filterCondition = null;