Skip to content

Commit

Permalink
fix javadoc issue and improve comments
Browse files Browse the repository at this point in the history
  • Loading branch information
pstoellberger committed Jul 30, 2013
1 parent 807f104 commit b49f30f
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion src/org/olap4j/query/LimitFunction.java
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
18 changes: 9 additions & 9 deletions src/org/olap4j/query/QueryAxis.java
Original file line number Diff line number Diff line change
Expand Up @@ -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) {
Expand All @@ -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) {
Expand All @@ -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) {
Expand All @@ -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;
Expand All @@ -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;
Expand All @@ -422,23 +422,23 @@ 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) {
this.filterCondition = 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() {
return this.filterCondition;
}

/**
* Clears the filter for this axis
* Clears the filter condition for this axis.
*/
public void clearFilter() {
this.filterCondition = null;
Expand Down

0 comments on commit b49f30f

Please sign in to comment.