Skip to content

Commit 9bf256c

Browse files
committed
Polishing.
Refine documentation links. See #5028
1 parent b5664de commit 9bf256c

File tree

5 files changed

+25
-20
lines changed

5 files changed

+25
-20
lines changed

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/MongoOperations.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1402,8 +1402,8 @@ default long exactCount(Query query, String collectionName) {
14021402
* Id from MongoDB. If your Id property is a String then MongoDB ObjectId will be used to populate that string.
14031403
* Otherwise, the conversion from ObjectId to your property type will be handled by Spring's BeanWrapper class that
14041404
* leverages Type Conversion API. See
1405-
* <a href="https://docs.spring.io/spring/docs/current/spring-framework-reference/core.html#validation" > Spring's
1406-
* Type Conversion"</a> for more details. <br />
1405+
* <a href="https://docs.spring.io/spring-framework/reference/core/validation/convert.html">Spring's Type
1406+
* Conversion</a> for more details. <br />
14071407
* Insert is used to initially store the object into the database. To update an existing object use the
14081408
* {@link #save(Object)} method.
14091409
* <p>
@@ -1490,8 +1490,8 @@ default long exactCount(Query query, String collectionName) {
14901490
* If your object has an "Id' property, it will be set with the generated Id from MongoDB. If your Id property is a
14911491
* String then MongoDB ObjectId will be used to populate that string. Otherwise, the conversion from ObjectId to your
14921492
* property type will be handled by Spring's BeanWrapper class that leverages Type Conversion API. See
1493-
* <a href="https://docs.spring.io/spring/docs/current/spring-framework-reference/core.html#validation" > Spring's
1494-
* Type Conversion"</a> for more details.
1493+
* <a href="https://docs.spring.io/spring-framework/reference/core/validation/convert.html">Spring's Type
1494+
* Conversion</a> for more details.
14951495
* <p>
14961496
* A potential {@link org.springframework.data.annotation.Version} the property will be auto incremented. The
14971497
* operation raises an error in case the document has been modified in between.
@@ -1516,7 +1516,7 @@ default long exactCount(Query query, String collectionName) {
15161516
* If your object has an "Id' property, it will be set with the generated Id from MongoDB. If your Id property is a
15171517
* String then MongoDB ObjectId will be used to populate that string. Otherwise, the conversion from ObjectId to your
15181518
* property type will be handled by Spring's BeanWrapper class that leverages Type Conversion API. See
1519-
* <a href="https://docs.spring.io/spring/docs/current/spring-framework-reference/core.html#validation">Spring's Type
1519+
* <a href="https://docs.spring.io/spring-framework/reference/core/validation/convert.html">Spring's Type
15201520
* Conversion</a> for more details.
15211521
* <p>
15221522
* A potential {@link org.springframework.data.annotation.Version} the property will be auto incremented. The

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/ReactiveMongoOperations.java

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1199,8 +1199,8 @@ default Mono<Long> exactCount(Query query, String collectionName) {
11991199
* Id from MongoDB. If your Id property is a String then MongoDB ObjectId will be used to populate that string.
12001200
* Otherwise, the conversion from ObjectId to your property type will be handled by Spring's BeanWrapper class that
12011201
* leverages Type Conversion API. See
1202-
* <a href="https://docs.spring.io/spring/docs/current/spring-framework-reference/core.html#validation" > Spring's
1203-
* Type Conversion"</a> for more details. <br />
1202+
* <a href="https://docs.spring.io/spring-framework/reference/core/validation/convert.html">Spring's Type
1203+
* Conversion</a> for more details. <br />
12041204
* Insert is used to initially store the object into the database. To update an existing object use the save method.
12051205
* <p>
12061206
* Inserting new objects will trigger {@link org.springframework.data.annotation.Version} property initialization.
@@ -1284,8 +1284,8 @@ default Mono<Long> exactCount(Query query, String collectionName) {
12841284
* If your object has an "Id' property, it will be set with the generated Id from MongoDB. If your Id property is a
12851285
* String then MongoDB ObjectId will be used to populate that string. Otherwise, the conversion from ObjectId to your
12861286
* property type will be handled by Spring's BeanWrapper class that leverages Type Conversion API. See
1287-
* <a href="https://docs.spring.io/spring/docs/current/spring-framework-reference/core.html#validation" > Spring's
1288-
* Type Conversion"</a> for more details. <br />
1287+
* <a href="https://docs.spring.io/spring-framework/reference/core/validation/convert.html">Spring's Type
1288+
* Conversion</a> for more details. <br />
12891289
* Insert is used to initially store the object into the database. To update an existing object use the save method.
12901290
* <p>
12911291
* A potential {@link org.springframework.data.annotation.Version} the property will be auto incremented. The
@@ -1348,8 +1348,8 @@ default Mono<Long> exactCount(Query query, String collectionName) {
13481348
* If your object has an "Id' property, it will be set with the generated Id from MongoDB. If your Id property is a
13491349
* String then MongoDB ObjectId will be used to populate that string. Otherwise, the conversion from ObjectId to your
13501350
* property type will be handled by Spring's BeanWrapper class that leverages Type Conversion API. See
1351-
* <a href="https://docs.spring.io/spring/docs/current/spring-framework-reference/core.html#validation" > Spring's
1352-
* Type Conversion"</a> for more details.
1351+
* <a href="https://docs.spring.io/spring-framework/reference/core/validation/convert.html">Spring's Type
1352+
* Conversion</a> for more details.
13531353
* <p>
13541354
* A potential {@link org.springframework.data.annotation.Version} the property will be auto incremented. The
13551355
* operation raises an error in case the document has been modified in between.
@@ -1374,7 +1374,7 @@ default Mono<Long> exactCount(Query query, String collectionName) {
13741374
* If your object has an "Id' property, it will be set with the generated Id from MongoDB. If your Id property is a
13751375
* String then MongoDB ObjectId will be used to populate that string. Otherwise, the conversion from ObjectId to your
13761376
* property type will be handled by Spring's BeanWrapper class that leverages Type Conversion API. See
1377-
* <a href="https://docs.spring.io/spring/docs/current/spring-framework-reference/core.html#validation">Spring's Type
1377+
* <a href="https://docs.spring.io/spring-framework/reference/core/validation/convert.html">Spring's Type
13781378
* Conversion</a> for more details.
13791379
* <p>
13801380
* A potential {@link org.springframework.data.annotation.Version} the property will be auto incremented. The
@@ -1397,7 +1397,7 @@ default Mono<Long> exactCount(Query query, String collectionName) {
13971397
* If your object has an "Id' property, it will be set with the generated Id from MongoDB. If your Id property is a
13981398
* String then MongoDB ObjectId will be used to populate that string. Otherwise, the conversion from ObjectId to your
13991399
* property type will be handled by Spring's BeanWrapper class that leverages Type Conversion API. See
1400-
* <a href="https://docs.spring.io/spring/docs/current/spring-framework-reference/core.html#validation"> Spring's Type
1400+
* <a href="https://docs.spring.io/spring-framework/reference/core/validation/convert.html">Spring's Type
14011401
* Conversion</a> for more details.
14021402
* <p>
14031403
* A potential {@link org.springframework.data.annotation.Version} the property will be auto incremented. The
@@ -1420,7 +1420,7 @@ default Mono<Long> exactCount(Query query, String collectionName) {
14201420
* If your object has an "Id' property, it will be set with the generated Id from MongoDB. If your Id property is a
14211421
* String then MongoDB ObjectId will be used to populate that string. Otherwise, the conversion from ObjectId to your
14221422
* property type will be handled by Spring's BeanWrapper class that leverages Type Conversion API. See
1423-
* <a href="https://docs.spring.io/spring/docs/current/spring-framework-reference/core.html#validation">Spring's Type
1423+
* <a href="https://docs.spring.io/spring-framework/reference/core/validation/convert.html">Spring's Type
14241424
* Conversion</a> for more details.
14251425
* <p>
14261426
* A potential {@link org.springframework.data.annotation.Version} the property will be auto incremented. The

src/main/antora/modules/ROOT/pages/mongodb/mongo-group.adoc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,11 @@
33

44
As an alternative to using Map-Reduce to perform data aggregation, you can use the https://www.mongodb.org/display/DOCS/Aggregation#Aggregation-Group[`group` operation] which feels similar to using SQL's group by query style, so it may feel more approachable vs. using Map-Reduce. Using the group operations does have some limitations, for example it is not supported in a shared environment and it returns the full result set in a single BSON object, so the result should be small, less than 10,000 keys.
55

6-
Spring provides integration with MongoDB's group operation by providing methods on MongoOperations to simplify the creation and running of group operations. It can convert the results of the group operation to a POJO and also integrates with Spring's https://docs.spring.io/spring-framework/docs/{springVersion}/reference/html/core.html#resources[Resource abstraction] abstraction. This will let you place your JavaScript files on the file system, classpath, http server or any other Spring Resource implementation and then reference the JavaScript resources via an easy URI style syntax, e.g. 'classpath:reduce.js;. Externalizing JavaScript code in files if often preferable to embedding them as Java strings in your code. Note that you can still pass JavaScript code as Java strings if you prefer.
6+
Spring provides integration with MongoDB's group operation by providing methods on MongoOperations to simplify the creation and running of group operations.
7+
It can convert the results of the group operation to a POJO and also integrates with Spring's {spring-framework-docs}/core/resources.html[Resource abstraction] abstraction.
8+
This will let you place your JavaScript files on the file system, classpath, http server or any other Spring Resource implementation and then reference the JavaScript resources via an easy URI style syntax, e.g. 'classpath:reduce.js;.
9+
Externalizing JavaScript code in files if often preferable to embedding them as Java strings in your code.
10+
Note that you can still pass JavaScript code as Java strings if you prefer.
711

812
[[mongo.group.example]]
913
== Example Usage

src/main/antora/modules/ROOT/pages/mongodb/template-gridfs.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ Alternatively, you can also provide a `Document`.
120120

121121
The MongoDB's driver uses `AsyncInputStream` and `AsyncOutputStream` interfaces to exchange binary streams.
122122
Spring Data MongoDB adapts these interfaces to `Publisher<DataBuffer>`.
123-
Read more about `DataBuffer` in https://docs.spring.io/spring-framework/docs/{springVersion}/reference/html/core.html#databuffers[Spring's reference documentation].
123+
Read more about `DataBuffer` in {spring-framework-docs}/core/databuffer-codec.html[Spring's reference documentation].
124124
====
125125
======
126126

src/main/antora/resources/antora-resources/antora.yml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,18 +3,19 @@ prerelease: ${antora-component.prerelease}
33

44
asciidoc:
55
attributes:
6+
attribute-missing: 'warn'
7+
chomp: 'all'
68
version: ${project.version}
79
copyright-year: ${current.year}
810
springversionshort: ${spring.short}
911
springversion: ${spring}
10-
attribute-missing: 'warn'
1112
commons: ${springdata.commons.docs}
1213
include-xml-namespaces: false
13-
spring-data-commons-docs-url: https://docs.spring.io/spring-data/commons/reference
14-
spring-data-commons-javadoc-base: https://docs.spring.io/spring-data/commons/docs/${springdata.commons}/api/
14+
spring-data-commons-docs-url: https://docs.spring.io/spring-data/commons/reference/{commons}
15+
spring-data-commons-javadoc-base: '{spring-data-commons-docs-url}/api/java'
1516
springdocsurl: https://docs.spring.io/spring-framework/reference/{springversionshort}
16-
springjavadocurl: https://docs.spring.io/spring-framework/docs/${spring}/javadoc-api
1717
spring-framework-docs: '{springdocsurl}'
18+
springjavadocurl: https://docs.spring.io/spring-framework/docs/${spring}/javadoc-api
1819
spring-framework-javadoc: '{springjavadocurl}'
1920
springhateoasversion: ${spring-hateoas}
2021
releasetrainversion: ${releasetrain}

0 commit comments

Comments
 (0)