GitHub-Spring
/
spring-data-mongodb
mirror of https://github.com/spring-projects/spring-data-mongodb.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

Polishing. 

Rename AngularDimension to AngularUnit. Tweak Javadoc. Simplify tests. Update reference docs.

See: #3710, #3714, #3728, #3730
Original pull request: #3755.
pull/3765/head
Mark Paluch 4 years ago
parent
c4c6267d91
commit
df0372eee1
No known key found for this signature in database
GPG Key ID: 4406B84C1661DCD1
5 changed files with 355 additions and 334 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 244
      spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/ArithmeticOperators.java
  2. 3
      spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/ConvertOperators.java
  3. 36
      spring-data-mongodb/src/test/java/org/springframework/data/mongodb/core/aggregation/ArithmeticOperatorsUnitTests.java
  4. 402
      spring-data-mongodb/src/test/java/org/springframework/data/mongodb/core/aggregation/SpelExpressionTransformerUnitTests.java
  5. 4
      src/main/asciidoc/reference/aggregation-framework.adoc

244
spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/ArithmeticOperators.java
Unescape View File

@ -678,34 +678,37 @@ public class ArithmeticOperators { @@ -678,34 +678,37 @@ public class ArithmeticOperators {
}
/**
* Creates new {@link AggregationExpression} that calculates the sine of a numeric value given in {@link AngularDimension#RADIANS radians}.
* Creates new {@link AggregationExpression} that calculates the sine of a numeric value given in
* {@link AngularUnit#RADIANS radians}.
*
* @return new instance of {@link Sin}.
* @since 3.3
*/
public Sin sin() {
return sin(AngularDimension.RADIANS);
return sin(AngularUnit.RADIANS);
}
/**
* Creates new {@link AggregationExpression} that calculates the sine of a numeric value in the given {@link AngularDimension unit}.
* Creates new {@link AggregationExpression} that calculates the sine of a numeric value in the given
* {@link AngularUnit unit}.
*
* @param unit the unit of measure.
* @return new instance of {@link Sin}.
* @since 3.3
*/
public Sin sin(AngularDimension unit) {
public Sin sin(AngularUnit unit) {
return usesFieldRef() ? Sin.sinOf(fieldReference, unit) : Sin.sinOf(expression, unit);
}
/**
* Creates new {@link AggregationExpression} that calculates the sine of a numeric value given in {@link AngularDimension#RADIANS radians}.
* Creates new {@link AggregationExpression} that calculates the sine of a numeric value given in
* {@link AngularUnit#RADIANS radians}.
*
* @return new instance of {@link Sin}.
* @since 3.3
*/
public Sinh sinh() {
return sinh(AngularDimension.RADIANS);
return sinh(AngularUnit.RADIANS);
}
/**
@ -715,42 +718,42 @@ public class ArithmeticOperators { @@ -715,42 +718,42 @@ public class ArithmeticOperators {
* @return new instance of {@link Sin}.
* @since 3.3
*/
public Sinh sinh(AngularDimension unit) {
public Sinh sinh(AngularUnit unit) {
return usesFieldRef() ? Sinh.sinhOf(fieldReference, unit) : Sinh.sinhOf(expression, unit);
}
/**
* Creates new {@link AggregationExpression} that calculates the cosine of a numeric value given in
* {@link AngularDimension#RADIANS radians}.
* {@link AngularUnit#RADIANS radians}.
*
* @return new instance of {@link Sin}.
* @since 3.3
*/
public Cos cos() {
return cos(AngularDimension.RADIANS);
return cos(AngularUnit.RADIANS);
}
/**
* Creates new {@link AggregationExpression} that calculates the cosine of a numeric value in the given
* {@link AngularDimension unit}.
* {@link AngularUnit unit}.
*
* @param unit the unit of measure.
* @return new instance of {@link Sin}.
* @since 3.3
*/
public Cos cos(AngularDimension unit) {
public Cos cos(AngularUnit unit) {
return usesFieldRef() ? Cos.cosOf(fieldReference, unit) : Cos.cosOf(expression, unit);
}
/**
* Creates new {@link AggregationExpression} that calculates the hyperbolic cosine of a numeric value given in
* {@link AngularDimension#RADIANS radians}.
* {@link AngularUnit#RADIANS radians}.
*
* @return new instance of {@link Sin}.
* @since 3.3
*/
public Cosh cosh() {
return cosh(AngularDimension.RADIANS);
return cosh(AngularUnit.RADIANS);
}
/**
@ -760,42 +763,42 @@ public class ArithmeticOperators { @@ -760,42 +763,42 @@ public class ArithmeticOperators {
* @return new instance of {@link Sin}.
* @since 3.3
*/
public Cosh cosh(AngularDimension unit) {
public Cosh cosh(AngularUnit unit) {
return usesFieldRef() ? Cosh.coshOf(fieldReference, unit) : Cosh.coshOf(expression, unit);
}
/**
* Creates new {@link AggregationExpression} that calculates the tangent of a numeric value given in
* {@link AngularDimension#RADIANS radians}.
* {@link AngularUnit#RADIANS radians}.
*
* @return new instance of {@link Sin}.
* @since 3.3
*/
public Tan tan() {
return tan(AngularDimension.RADIANS);
return tan(AngularUnit.RADIANS);
}
/**
* Creates new {@link AggregationExpression} that calculates the tangent of a numeric value in the given
* {@link AngularDimension unit}.
* {@link AngularUnit unit}.
*
* @param unit the unit of measure.
* @return new instance of {@link Sin}.
* @since 3.3
*/
public Tan tan(AngularDimension unit) {
public Tan tan(AngularUnit unit) {
return usesFieldRef() ? Tan.tanOf(fieldReference, unit) : Tan.tanOf(expression, unit);
}
/**
* Creates new {@link AggregationExpression} that calculates the hyperbolic tangent of a numeric value given in
* {@link AngularDimension#RADIANS radians}.
* {@link AngularUnit#RADIANS radians}.
*
* @return new instance of {@link Sin}.
* @since 3.3
*/
public Tanh tanh() {
return tanh(AngularDimension.RADIANS);
return tanh(AngularUnit.RADIANS);
}
/**
@ -805,7 +808,7 @@ public class ArithmeticOperators { @@ -805,7 +808,7 @@ public class ArithmeticOperators {
* @return new instance of {@link Sin}.
* @since 3.3
*/
public Tanh tanh(AngularDimension unit) {
public Tanh tanh(AngularUnit unit) {
return usesFieldRef() ? Tanh.tanhOf(fieldReference, unit) : Tanh.tanhOf(expression, unit);
}
@ -2047,7 +2050,7 @@ public class ArithmeticOperators { @@ -2047,7 +2050,7 @@ public class ArithmeticOperators {
* @author Christoph Strobl
* @since 3.3
*/
public enum AngularDimension {
public enum AngularUnit {
RADIANS, DEGREES
}
@ -2065,76 +2068,82 @@ public class ArithmeticOperators { @@ -2065,76 +2068,82 @@ public class ArithmeticOperators {
/**
* Creates a new {@link AggregationExpression} that calculates the sine of a value that is measured in
* {@link AngularDimension#RADIANS radians}.
* {@link AngularUnit#RADIANS radians}.
* <p />
* Use {@code sinhOf("angle", DEGREES)} as shortcut for <pre>{ $sinh : { $degreesToRadians : "$angle" } }</pre>.
* Use {@code sinhOf("angle", DEGREES)} as shortcut for
*
* <pre>
* { $sinh : { $degreesToRadians : "$angle" } }
* </pre>
*
* .
*
* @param fieldReference the name of the {@link Field field} that resolves to a numeric value.
* @return new instance of {@link Sin}.
*/
public static Sin sinOf(String fieldReference) {
return sinOf(fieldReference, AngularDimension.RADIANS);
return sinOf(fieldReference, AngularUnit.RADIANS);
}
/**
* Creates a new {@link AggregationExpression} that calculates the sine of a value that is measured in the given
* {@link AngularDimension unit}.
* {@link AngularUnit unit}.
*
* @param fieldReference the name of the {@link Field field} that resolves to a numeric value.
* @param unit the unit of measure used by the value of the given field.
* @return new instance of {@link Sin}.
*/
public static Sin sinOf(String fieldReference, AngularDimension unit) {
public static Sin sinOf(String fieldReference, AngularUnit unit) {
return sin(Fields.field(fieldReference), unit);
}
/**
* Creates a new {@link AggregationExpression} that calculates the sine of a value that is measured in
* {@link AngularDimension#RADIANS}.
* {@link AngularUnit#RADIANS}.
*
* @param expression the {@link AggregationExpression expression} that resolves to a numeric value.
* @return new instance of {@link Sin}.
*/
public static Sin sinOf(AggregationExpression expression) {
return sinOf(expression, AngularDimension.RADIANS);
return sinOf(expression, AngularUnit.RADIANS);
}
/**
* Creates a new {@link AggregationExpression} that calculates the sine of a value that is measured in the given
* {@link AngularDimension unit}.
* {@link AngularUnit unit}.
*
* @param expression the {@link AggregationExpression expression} that resolves to a numeric value.
* @param unit the unit of measure used by the value of the given field.
* @return new instance of {@link Sin}.
*/
public static Sin sinOf(AggregationExpression expression, AngularDimension unit) {
public static Sin sinOf(AggregationExpression expression, AngularUnit unit) {
return sin(expression, unit);
}
/**
* Creates a new {@link AggregationExpression} that calculates the sine of a value that is measured in
* {@link AngularDimension#RADIANS}.
* {@link AngularUnit#RADIANS}.
*
* @param value anything ({@link Field field}, {@link AggregationExpression expression}, ...) that resolves to a
* numeric value
* @return new instance of {@link Sin}.
*/
public static Sin sin(Object value) {
return sin(value, AngularDimension.RADIANS);
return sin(value, AngularUnit.RADIANS);
}
/**
* Creates a new {@link AggregationExpression} that calculates the sine of a value that is measured in the given
* {@link AngularDimension unit}.
* {@link AngularUnit unit}.
*
* @param value anything ({@link Field field}, {@link AggregationExpression expression}, ...) that resolves to a
* numeric value.
* @param unit the unit of measure used by the value of the given field.
* @return new instance of {@link Sin}.
*/
public static Sin sin(Object value, AngularDimension unit) {
public static Sin sin(Object value, AngularUnit unit) {
if (ObjectUtils.nullSafeEquals(AngularDimension.DEGREES, unit)) {
if (ObjectUtils.nullSafeEquals(AngularUnit.DEGREES, unit)) {
return new Sin(ConvertOperators.DegreesToRadians.degreesToRadians(value));
}
return new Sin(value);
@ -2148,7 +2157,7 @@ public class ArithmeticOperators { @@ -2148,7 +2157,7 @@ public class ArithmeticOperators {
/**
* An {@link AggregationExpression expression} that calculates the hyperbolic sine of a value that is measured in
* {@link AngularDimension#RADIANS}.
* {@link AngularUnit#RADIANS}.
*
* @author Christoph Strobl
* @since 3.3
@ -2161,78 +2170,85 @@ public class ArithmeticOperators { @@ -2161,78 +2170,85 @@ public class ArithmeticOperators {
/**
* Creates a new {@link AggregationExpression} that calculates the hyperbolic sine of a value that is measured in
* {@link AngularDimension#RADIANS}.
* {@link AngularUnit#RADIANS}.
*
* @param fieldReference the name of the {@link Field field} that resolves to a numeric value.
* @return new instance of {@link Sin}.
*/
public static Sinh sinhOf(String fieldReference) {
return sinhOf(fieldReference, AngularDimension.RADIANS);
return sinhOf(fieldReference, AngularUnit.RADIANS);
}
/**
* Creates a new {@link AggregationExpression} that calculates the hyperbolic sine of a value that is measured in
* the given {@link AngularDimension unit}.
* the given {@link AngularUnit unit}.
* <p />
* Use {@code sinhOf("angle", DEGREES)} as shortcut for <pre>{ $sinh : { $degreesToRadians : "$angle" } }</pre>.
* Use {@code sinhOf("angle", DEGREES)} as shortcut for
*
* <pre>
* { $sinh : { $degreesToRadians : "$angle" } }
* </pre>
*
* .
*
* @param fieldReference the name of the {@link Field field} that resolves to a numeric value.
* @param unit the unit of measure used by the value of the given field.
* @return new instance of {@link Sin}.
*/
public static Sinh sinhOf(String fieldReference, AngularDimension unit) {
public static Sinh sinhOf(String fieldReference, AngularUnit unit) {
return sinh(Fields.field(fieldReference), unit);
}
/**
* Creates a new {@link AggregationExpression} that calculates the hyperbolic sine of a value that is measured in
* {@link AngularDimension#RADIANS}.
* {@link AngularUnit#RADIANS}.
* <p />
* Use {@code sinhOf("angle", DEGREES)} as shortcut for eg. {@code sinhOf(ConvertOperators.valueOf("angle").degreesToRadians())}.
* Use {@code sinhOf("angle", DEGREES)} as shortcut for eg.
* {@code sinhOf(ConvertOperators.valueOf("angle").degreesToRadians())}.
*
* @param expression the {@link AggregationExpression expression} that resolves to a numeric value.
* @return new instance of {@link Sin}.
*/
public static Sinh sinhOf(AggregationExpression expression) {
return sinhOf(expression, AngularDimension.RADIANS);
return sinhOf(expression, AngularUnit.RADIANS);
}
/**
* Creates a new {@link AggregationExpression} that calculates the hyperbolic sine of a value that is measured in
* the given {@link AngularDimension unit}.
* the given {@link AngularUnit unit}.
*
* @param expression the {@link AggregationExpression expression} that resolves to a numeric value.
* @param unit the unit of measure used by the value of the given field.
* @return new instance of {@link Sin}.
*/
public static Sinh sinhOf(AggregationExpression expression, AngularDimension unit) {
public static Sinh sinhOf(AggregationExpression expression, AngularUnit unit) {
return sinh(expression, unit);
}
/**
* Creates a new {@link AggregationExpression} that calculates the hyperbolic sine of a value that is measured in
* {@link AngularDimension#RADIANS}.
* {@link AngularUnit#RADIANS}.
*
* @param value anything ({@link Field field}, {@link AggregationExpression expression}, ...) that resolves to a
* numeric value.
* @return new instance of {@link Sin}.
*/
public static Sinh sinh(Object value) {
return sinh(value, AngularDimension.RADIANS);
return sinh(value, AngularUnit.RADIANS);
}
/**
* Creates a new {@link AggregationExpression} that calculates the hyperbolic sine of a value that is measured in
* the given {@link AngularDimension unit}.
* the given {@link AngularUnit unit}.
*
* @param value anything ({@link Field field}, {@link AggregationExpression expression}, ...) that resolves to a
* numeric value
* @param unit the unit of measure used by the value of the given field.
* @return new instance of {@link Sin}.
*/
public static Sinh sinh(Object value, AngularDimension unit) {
public static Sinh sinh(Object value, AngularUnit unit) {
if (ObjectUtils.nullSafeEquals(AngularDimension.DEGREES, unit)) {
if (ObjectUtils.nullSafeEquals(AngularUnit.DEGREES, unit)) {
return new Sinh(ConvertOperators.DegreesToRadians.degreesToRadians(value));
}
return new Sinh(value);
@ -2258,82 +2274,82 @@ public class ArithmeticOperators { @@ -2258,82 +2274,82 @@ public class ArithmeticOperators {
/**
* Creates a new {@link AggregationExpression} that calculates the cosine of a value that is measured in
* {@link AngularDimension#RADIANS radians}.
* {@link AngularUnit#RADIANS radians}.
* <p />
* Use {@code cosOf("angle", DEGREES)} as shortcut for
*
*
* <pre>
* { $cos : { $degreesToRadians : "$angle" } }
* </pre>
*
*
* .
*
* @param fieldReference the name of the {@link Field field} that resolves to a numeric value.
* @return new instance of {@link Cos}.
*/
public static Cos cosOf(String fieldReference) {
return cosOf(fieldReference, AngularDimension.RADIANS);
return cosOf(fieldReference, AngularUnit.RADIANS);
}
/**
* Creates a new {@link AggregationExpression} that calculates the cosine of a value that is measured in the given
* {@link AngularDimension unit}.
* {@link AngularUnit unit}.
*
* @param fieldReference the name of the {@link Field field} that resolves to a numeric value.
* @param unit the unit of measure used by the value of the given field.
* @return new instance of {@link Cos}.
*/
public static Cos cosOf(String fieldReference, AngularDimension unit) {
public static Cos cosOf(String fieldReference, AngularUnit unit) {
return cos(Fields.field(fieldReference), unit);
}
/**
* Creates a new {@link AggregationExpression} that calculates the cosine of a value that is measured in
* {@link AngularDimension#RADIANS}.
* {@link AngularUnit#RADIANS}.
*
* @param expression the {@link AggregationExpression expression} that resolves to a numeric value.
* @return new instance of {@link Cos}.
*/
public static Cos cosOf(AggregationExpression expression) {
return cosOf(expression, AngularDimension.RADIANS);
return cosOf(expression, AngularUnit.RADIANS);
}
/**
* Creates a new {@link AggregationExpression} that calculates the cosine of a value that is measured in the given
* {@link AngularDimension unit}.
* {@link AngularUnit unit}.
*
* @param expression the {@link AggregationExpression expression} that resolves to a numeric value.
* @param unit the unit of measure used by the value of the given field.
* @return new instance of {@link Cos}.
*/
public static Cos cosOf(AggregationExpression expression, AngularDimension unit) {
public static Cos cosOf(AggregationExpression expression, AngularUnit unit) {
return cos(expression, unit);
}
/**
* Creates a new {@link AggregationExpression} that calculates the cosine of a value that is measured in
* {@link AngularDimension#RADIANS}.
* {@link AngularUnit#RADIANS}.
*
* @param value anything ({@link Field field}, {@link AggregationExpression expression}, ...) that resolves to a
* numeric value
* @return new instance of {@link Cos}.
*/
public static Cos cos(Object value) {
return cos(value, AngularDimension.RADIANS);
return cos(value, AngularUnit.RADIANS);
}
/**
* Creates a new {@link AggregationExpression} that calculates the cosine of a value that is measured in the given
* {@link AngularDimension unit}.
* {@link AngularUnit unit}.
*
* @param value anything ({@link Field field}, {@link AggregationExpression expression}, ...) that resolves to a
* numeric value.
* @param unit the unit of measure used by the value of the given field.
* @return new instance of {@link Cos}.
*/
public static Cos cos(Object value, AngularDimension unit) {
public static Cos cos(Object value, AngularUnit unit) {
if (ObjectUtils.nullSafeEquals(AngularDimension.DEGREES, unit)) {
if (ObjectUtils.nullSafeEquals(AngularUnit.DEGREES, unit)) {
return new Cos(ConvertOperators.DegreesToRadians.degreesToRadians(value));
}
return new Cos(value);
@ -2347,7 +2363,7 @@ public class ArithmeticOperators { @@ -2347,7 +2363,7 @@ public class ArithmeticOperators {
/**
* An {@link AggregationExpression expression} that calculates the hyperbolic cosine of a value that is measured in
* {@link AngularDimension#RADIANS}.
* {@link AngularUnit#RADIANS}.
*
* @author Christoph Strobl
* @since 3.3
@ -2360,38 +2376,38 @@ public class ArithmeticOperators { @@ -2360,38 +2376,38 @@ public class ArithmeticOperators {
/**
* Creates a new {@link AggregationExpression} that calculates the hyperbolic cosine of a value that is measured in
* {@link AngularDimension#RADIANS}.
* {@link AngularUnit#RADIANS}.
*
* @param fieldReference the name of the {@link Field field} that resolves to a numeric value.
* @return new instance of {@link Cosh}.
*/
public static Cosh coshOf(String fieldReference) {
return coshOf(fieldReference, AngularDimension.RADIANS);
return coshOf(fieldReference, AngularUnit.RADIANS);
}
/**
* Creates a new {@link AggregationExpression} that calculates the hyperbolic cosine of a value that is measured in
* the given {@link AngularDimension unit}.
* the given {@link AngularUnit unit}.
* <p />
* Use {@code coshOf("angle", DEGREES)} as shortcut for
*
*
* <pre>
* { $cosh : { $degreesToRadians : "$angle" } }
* </pre>
*
*
* .
*
* @param fieldReference the name of the {@link Field field} that resolves to a numeric value.
* @param unit the unit of measure used by the value of the given field.
* @return new instance of {@link Cosh}.
*/
public static Cosh coshOf(String fieldReference, AngularDimension unit) {
public static Cosh coshOf(String fieldReference, AngularUnit unit) {
return cosh(Fields.field(fieldReference), unit);
}
/**
* Creates a new {@link AggregationExpression} that calculates the hyperbolic cosine of a value that is measured in
* {@link AngularDimension#RADIANS}.
* {@link AngularUnit#RADIANS}.
* <p />
* Use {@code sinhOf("angle", DEGREES)} as shortcut for eg.
* {@code sinhOf(ConvertOperators.valueOf("angle").degreesToRadians())}.
@ -2400,45 +2416,45 @@ public class ArithmeticOperators { @@ -2400,45 +2416,45 @@ public class ArithmeticOperators {
* @return new instance of {@link Cosh}.
*/
public static Cosh coshOf(AggregationExpression expression) {
return coshOf(expression, AngularDimension.RADIANS);
return coshOf(expression, AngularUnit.RADIANS);
}
/**
* Creates a new {@link AggregationExpression} that calculates the hyperbolic cosine of a value that is measured in
* the given {@link AngularDimension unit}.
* the given {@link AngularUnit unit}.
*
* @param expression the {@link AggregationExpression expression} that resolves to a numeric value.
* @param unit the unit of measure used by the value of the given field.
* @return new instance of {@link Cosh}.
*/
public static Cosh coshOf(AggregationExpression expression, AngularDimension unit) {
public static Cosh coshOf(AggregationExpression expression, AngularUnit unit) {
return cosh(expression, unit);
}
/**
* Creates a new {@link AggregationExpression} that calculates the hyperbolic cosine of a value that is measured in
* {@link AngularDimension#RADIANS}.
* {@link AngularUnit#RADIANS}.
*
* @param value anything ({@link Field field}, {@link AggregationExpression expression}, ...) that resolves to a
* numeric value.
* @return new instance of {@link Cosh}.
*/
public static Cosh cosh(Object value) {
return cosh(value, AngularDimension.RADIANS);
return cosh(value, AngularUnit.RADIANS);
}
/**
* Creates a new {@link AggregationExpression} that calculates the hyperbolic cosine of a value that is measured in
* the given {@link AngularDimension unit}.
* the given {@link AngularUnit unit}.
*
* @param value anything ({@link Field field}, {@link AggregationExpression expression}, ...) that resolves to a
* numeric value
* @param unit the unit of measure used by the value of the given field.
* @return new instance of {@link Cosh}.
*/
public static Cosh cosh(Object value, AngularDimension unit) {
public static Cosh cosh(Object value, AngularUnit unit) {
if (ObjectUtils.nullSafeEquals(AngularDimension.DEGREES, unit)) {
if (ObjectUtils.nullSafeEquals(AngularUnit.DEGREES, unit)) {
return new Cosh(ConvertOperators.DegreesToRadians.degreesToRadians(value));
}
return new Cosh(value);
@ -2464,82 +2480,82 @@ public class ArithmeticOperators { @@ -2464,82 +2480,82 @@ public class ArithmeticOperators {
/**
* Creates a new {@link AggregationExpression} that calculates the tangent of a value that is measured in
* {@link AngularDimension#RADIANS radians}.
* {@link AngularUnit#RADIANS radians}.
* <p />
* Use {@code tanOf("angle", DEGREES)} as shortcut for
*
*
* <pre>
* { $tan : { $degreesToRadians : "$angle" } }
* </pre>
*
*
* .
*
* @param fieldReference the name of the {@link Field field} that resolves to a numeric value.
* @return new instance of {@link Tan}.
*/
public static Tan tanOf(String fieldReference) {
return tanOf(fieldReference, AngularDimension.RADIANS);
return tanOf(fieldReference, AngularUnit.RADIANS);
}
/**
* Creates a new {@link AggregationExpression} that calculates the tangent of a value that is measured in the given
* {@link AngularDimension unit}.
* {@link AngularUnit unit}.
*
* @param fieldReference the name of the {@link Field field} that resolves to a numeric value.
* @param unit the unit of measure used by the value of the given field.
* @return new instance of {@link Tan}.
*/
public static Tan tanOf(String fieldReference, AngularDimension unit) {
public static Tan tanOf(String fieldReference, AngularUnit unit) {
return tan(Fields.field(fieldReference), unit);
}
/**
* Creates a new {@link AggregationExpression} that calculates the tangent of a value that is measured in
* {@link AngularDimension#RADIANS}.
* {@link AngularUnit#RADIANS}.
*
* @param expression the {@link AggregationExpression expression} that resolves to a numeric value.
* @return new instance of {@link Tan}.
*/
public static Tan tanOf(AggregationExpression expression) {
return tanOf(expression, AngularDimension.RADIANS);
return tanOf(expression, AngularUnit.RADIANS);
}
/**
* Creates a new {@link AggregationExpression} that calculates the tangent of a value that is measured in the given
* {@link AngularDimension unit}.
* {@link AngularUnit unit}.
*
* @param expression the {@link AggregationExpression expression} that resolves to a numeric value.
* @param unit the unit of measure used by the value of the given field.
* @return new instance of {@link Tan}.
*/
public static Tan tanOf(AggregationExpression expression, AngularDimension unit) {
public static Tan tanOf(AggregationExpression expression, AngularUnit unit) {
return tan(expression, unit);
}
/**
* Creates a new {@link AggregationExpression} that calculates the tangent of a value that is measured in
* {@link AngularDimension#RADIANS}.
* {@link AngularUnit#RADIANS}.
*
* @param value anything ({@link Field field}, {@link AggregationExpression expression}, ...) that resolves to a
* numeric value
* @return new instance of {@link Tan}.
*/
public static Tan tan(Object value) {
return tan(value, AngularDimension.RADIANS);
return tan(value, AngularUnit.RADIANS);
}
/**
* Creates a new {@link AggregationExpression} that calculates the tangent of a value that is measured in the given
* {@link AngularDimension unit}.
* {@link AngularUnit unit}.
*
* @param value anything ({@link Field field}, {@link AggregationExpression expression}, ...) that resolves to a
* numeric value.
* @param unit the unit of measure used by the value of the given field.
* @return new instance of {@link Tan}.
*/
public static Tan tan(Object value, AngularDimension unit) {
public static Tan tan(Object value, AngularUnit unit) {
if (ObjectUtils.nullSafeEquals(AngularDimension.DEGREES, unit)) {
if (ObjectUtils.nullSafeEquals(AngularUnit.DEGREES, unit)) {
return new Tan(ConvertOperators.DegreesToRadians.degreesToRadians(value));
}
return new Tan(value);
@ -2553,7 +2569,7 @@ public class ArithmeticOperators { @@ -2553,7 +2569,7 @@ public class ArithmeticOperators {
/**
* An {@link AggregationExpression expression} that calculates the hyperbolic tangent of a value that is measured in
* {@link AngularDimension#RADIANS}.
* {@link AngularUnit#RADIANS}.
*
* @author Christoph Strobl
* @since 3.3
@ -2566,38 +2582,38 @@ public class ArithmeticOperators { @@ -2566,38 +2582,38 @@ public class ArithmeticOperators {
/**
* Creates a new {@link AggregationExpression} that calculates the hyperbolic tangent of a value that is measured in
* {@link AngularDimension#RADIANS}.
* {@link AngularUnit#RADIANS}.
*
* @param fieldReference the name of the {@link Field field} that resolves to a numeric value.
* @return new instance of {@link Tanh}.
*/
public static Tanh tanhOf(String fieldReference) {
return tanhOf(fieldReference, AngularDimension.RADIANS);
return tanhOf(fieldReference, AngularUnit.RADIANS);
}
/**
* Creates a new {@link AggregationExpression} that calculates the hyperbolic tangent of a value that is measured in
* the given {@link AngularDimension unit}.
* the given {@link AngularUnit unit}.
* <p />
* Use {@code tanhOf("angle", DEGREES)} as shortcut for
*
*
* <pre>
* { $tanh : { $degreesToRadians : "$angle" } }
* </pre>
*
*
* .
*
* @param fieldReference the name of the {@link Field field} that resolves to a numeric value.
* @param unit the unit of measure used by the value of the given field.
* @return new instance of {@link Tanh}.
*/
public static Tanh tanhOf(String fieldReference, AngularDimension unit) {
public static Tanh tanhOf(String fieldReference, AngularUnit unit) {
return tanh(Fields.field(fieldReference), unit);
}
/**
* Creates a new {@link AggregationExpression} that calculates the hyperbolic tangent of a value that is measured in
* {@link AngularDimension#RADIANS}.
* {@link AngularUnit#RADIANS}.
* <p />
* Use {@code sinhOf("angle", DEGREES)} as shortcut for eg.
* {@code sinhOf(ConvertOperators.valueOf("angle").degreesToRadians())}.
@ -2606,45 +2622,45 @@ public class ArithmeticOperators { @@ -2606,45 +2622,45 @@ public class ArithmeticOperators {
* @return new instance of {@link Tanh}.
*/
public static Tanh tanhOf(AggregationExpression expression) {
return tanhOf(expression, AngularDimension.RADIANS);
return tanhOf(expression, AngularUnit.RADIANS);
}
/**
* Creates a new {@link AggregationExpression} that calculates the hyperbolic tangent of a value that is measured in
* the given {@link AngularDimension unit}.
* the given {@link AngularUnit unit}.
*
* @param expression the {@link AggregationExpression expression} that resolves to a numeric value.
* @param unit the unit of measure used by the value of the given field.
* @return new instance of {@link Tanh}.
*/
public static Tanh tanhOf(AggregationExpression expression, AngularDimension unit) {
public static Tanh tanhOf(AggregationExpression expression, AngularUnit unit) {
return tanh(expression, unit);
}
/**
* Creates a new {@link AggregationExpression} that calculates the hyperbolic tangent of a value that is measured in
* {@link AngularDimension#RADIANS}.
* {@link AngularUnit#RADIANS}.
*
* @param value anything ({@link Field field}, {@link AggregationExpression expression}, ...) that resolves to a
* numeric value.
* @return new instance of {@link Tanh}.
*/
public static Tanh tanh(Object value) {
return tanh(value, AngularDimension.RADIANS);
return tanh(value, AngularUnit.RADIANS);
}
/**
* Creates a new {@link AggregationExpression} that calculates the hyperbolic tangent of a value that is measured in
* the given {@link AngularDimension unit}.
* the given {@link AngularUnit unit}.
*
* @param value anything ({@link Field field}, {@link AggregationExpression expression}, ...) that resolves to a
* numeric value
* @param unit the unit of measure used by the value of the given field.
* @return new instance of {@link Tanh}.
*/
public static Tanh tanh(Object value, AngularDimension unit) {
public static Tanh tanh(Object value, AngularUnit unit) {
if (ObjectUtils.nullSafeEquals(AngularDimension.DEGREES, unit)) {
if (ObjectUtils.nullSafeEquals(AngularUnit.DEGREES, unit)) {
return new Tanh(ConvertOperators.DegreesToRadians.degreesToRadians(value));
}
return new Tanh(value);

3
spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/aggregation/ConvertOperators.java
Unescape View File

@ -232,7 +232,8 @@ public class ConvertOperators { @@ -232,7 +232,8 @@ public class ConvertOperators {
}
/**
* {@link AggregationExpression} for {@code $degreesToRadians} that converts an input value measured in degrees to radians.\
* {@link AggregationExpression} for {@code $degreesToRadians} that converts an input value measured in degrees to
* radians.
*
* @return new instance of {@link DegreesToRadians}.
* @since 3.3

36
spring-data-mongodb/src/test/java/org/springframework/data/mongodb/core/aggregation/ArithmeticOperatorsUnitTests.java
Unescape View File

@ -86,84 +86,84 @@ class ArithmeticOperatorsUnitTests { @@ -86,84 +86,84 @@ class ArithmeticOperatorsUnitTests {
void rendersSin() {
assertThat(valueOf("angle").sin().toDocument(Aggregation.DEFAULT_CONTEXT))
.isEqualTo(Document.parse("{ $sin : \"$angle\" }"));
.isEqualTo("{ $sin : \"$angle\" }");
}
@Test // GH-3728
void rendersSinWithValueInDegrees() {
assertThat(valueOf("angle").sin(AngularDimension.DEGREES).toDocument(Aggregation.DEFAULT_CONTEXT))
.isEqualTo(Document.parse("{ $sin : { $degreesToRadians : \"$angle\" } }"));
assertThat(valueOf("angle").sin(AngularUnit.DEGREES).toDocument(Aggregation.DEFAULT_CONTEXT))
.isEqualTo("{ $sin : { $degreesToRadians : \"$angle\" } }");
}
@Test // GH-3728
void rendersSinh() {
assertThat(valueOf("angle").sinh().toDocument(Aggregation.DEFAULT_CONTEXT))
.isEqualTo(Document.parse("{ $sinh : \"$angle\" }"));
.isEqualTo("{ $sinh : \"$angle\" }");
}
@Test // GH-3728
void rendersSinhWithValueInDegrees() {
assertThat(valueOf("angle").sinh(AngularDimension.DEGREES).toDocument(Aggregation.DEFAULT_CONTEXT))
.isEqualTo(Document.parse("{ $sinh : { $degreesToRadians : \"$angle\" } }"));
assertThat(valueOf("angle").sinh(AngularUnit.DEGREES).toDocument(Aggregation.DEFAULT_CONTEXT))
.isEqualTo("{ $sinh : { $degreesToRadians : \"$angle\" } }");
}
@Test // GH-3710
void rendersCos() {
assertThat(valueOf("angle").cos().toDocument(Aggregation.DEFAULT_CONTEXT))
.isEqualTo(Document.parse("{ $cos : \"$angle\" }"));
.isEqualTo("{ $cos : \"$angle\" }");
}
@Test // GH-3710
void rendersCosWithValueInDegrees() {
assertThat(valueOf("angle").cos(AngularDimension.DEGREES).toDocument(Aggregation.DEFAULT_CONTEXT))
.isEqualTo(Document.parse("{ $cos : { $degreesToRadians : \"$angle\" } }"));
assertThat(valueOf("angle").cos(AngularUnit.DEGREES).toDocument(Aggregation.DEFAULT_CONTEXT))
.isEqualTo("{ $cos : { $degreesToRadians : \"$angle\" } }");
}
@Test // GH-3710
void rendersCosh() {
assertThat(valueOf("angle").cosh().toDocument(Aggregation.DEFAULT_CONTEXT))
.isEqualTo(Document.parse("{ $cosh : \"$angle\" }"));
.isEqualTo("{ $cosh : \"$angle\" }");
}
@Test // GH-3710
void rendersCoshWithValueInDegrees() {
assertThat(valueOf("angle").cosh(AngularDimension.DEGREES).toDocument(Aggregation.DEFAULT_CONTEXT))
.isEqualTo(Document.parse("{ $cosh : { $degreesToRadians : \"$angle\" } }"));
assertThat(valueOf("angle").cosh(AngularUnit.DEGREES).toDocument(Aggregation.DEFAULT_CONTEXT))
.isEqualTo("{ $cosh : { $degreesToRadians : \"$angle\" } }");
}
@Test // GH-3730
void rendersTan() {
assertThat(valueOf("angle").tan().toDocument(Aggregation.DEFAULT_CONTEXT))
.isEqualTo(Document.parse("{ $tan : \"$angle\" }"));
.isEqualTo("{ $tan : \"$angle\" }");
}
@Test // GH-3730
void rendersTanWithValueInDegrees() {
assertThat(valueOf("angle").tan(AngularDimension.DEGREES).toDocument(Aggregation.DEFAULT_CONTEXT))
.isEqualTo(Document.parse("{ $tan : { $degreesToRadians : \"$angle\" } }"));
assertThat(valueOf("angle").tan(AngularUnit.DEGREES).toDocument(Aggregation.DEFAULT_CONTEXT))
.isEqualTo("{ $tan : { $degreesToRadians : \"$angle\" } }");
}
@Test // GH-3730
void rendersTanh() {
assertThat(valueOf("angle").tanh().toDocument(Aggregation.DEFAULT_CONTEXT))
.isEqualTo(Document.parse("{ $tanh : \"$angle\" }"));
.isEqualTo("{ $tanh : \"$angle\" }");
}
@Test // GH-3730
void rendersTanhWithValueInDegrees() {
assertThat(valueOf("angle").tanh(AngularDimension.DEGREES).toDocument(Aggregation.DEFAULT_CONTEXT))
.isEqualTo(Document.parse("{ $tanh : { $degreesToRadians : \"$angle\" } }"));
assertThat(valueOf("angle").tanh(AngularUnit.DEGREES).toDocument(Aggregation.DEFAULT_CONTEXT))
.isEqualTo("{ $tanh : { $degreesToRadians : \"$angle\" } }");
}
}

402
spring-data-mongodb/src/test/java/org/springframework/data/mongodb/core/aggregation/SpelExpressionTransformerUnitTests.java
View File

File diff suppressed because it is too large Load Diff

4
src/main/asciidoc/reference/aggregation-framework.adoc
Unescape View File

@ -85,7 +85,7 @@ At the time of this writing, we provide support for the following Aggregation Op @@ -85,7 +85,7 @@ At the time of this writing, we provide support for the following Aggregation Op
| `addToSet`, `covariancePop`, `covarianceSamp`, `expMovingAvg`, `first`, `last`, `max`, `min`, `avg`, `push`, `sum`, `count` (+++*+++), `stdDevPop`, `stdDevSamp`
| Arithmetic Aggregation Operators
| `abs`, `add` (+++*+++ via `plus`), `ceil`, `derivative`, `divide`, `exp`, `floor`, `integral`, `ln`, `log`, `log10`, `mod`, `multiply`, `pow`, `round`, `sqrt`, `subtract` (+++*+++ via `minus`), `trunc`
| `abs`, `add` (+++*+++ via `plus`), `ceil`, `cos`, `cosh`, `derivative`, `divide`, `exp`, `floor`, `integral`, `ln`, `log`, `log10`, `mod`, `multiply`, `pow`, `round`, `sqrt`, `subtract` (+++*+++ via `minus`), `sin`, `sinh`, `tan`, `tanh`, `trunc`
| String Aggregation Operators
| `concat`, `substr`, `toLower`, `toUpper`, `stcasecmp`, `indexOfBytes`, `indexOfCP`, `split`, `strLenBytes`, `strLenCP`, `substrCP`, `trim`, `ltrim`, `rtim`
@ -112,7 +112,7 @@ At the time of this writing, we provide support for the following Aggregation Op @@ -112,7 +112,7 @@ At the time of this writing, we provide support for the following Aggregation Op
| `type`
| Convert Aggregation Operators
| `convert`, `toBool`, `toDate`, `toDecimal`, `toDouble`, `toInt`, `toLong`, `toObjectId`, `toString`
| `convert`, `degreesToRadians`, `toBool`, `toDate`, `toDecimal`, `toDouble`, `toInt`, `toLong`, `toObjectId`, `toString`
| Object Aggregation Operators
| `objectToArray`, `mergeObjects`

Write Preview
Loading…
Cancel
Save