You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by da...@apache.org on 2019/06/02 16:48:51 UTC
[isis] 37/47: ISIS-2062: fixes xrefs for ugfun
This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a commit to branch ISIS-2062-antora
in repository https://gitbox.apache.org/repos/asf/isis.git
commit 4f42bd73924e824ef92e52ef66b9e2f7c130ae41
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Sun Jun 2 13:00:17 2019 +0100
ISIS-2062: fixes xrefs for ugfun
---
.../building-blocks/types-of-domain-objects/view-models.adoc | 2 +-
.../ug/modules/fun/pages/getting-started/simpleapp-archetype.adoc | 2 +-
.../ug/modules/fun/pages/programming-model/actions.adoc | 8 ++++----
.../ug/modules/fun/pages/programming-model/collections.adoc | 2 +-
.../programming-model/domain-services/organizing-services.adoc | 2 +-
.../ug/modules/fun/pages/programming-model/properties.adoc | 8 ++++----
6 files changed, 12 insertions(+), 12 deletions(-)
diff --git a/antora/components/ug/modules/fun/pages/building-blocks/types-of-domain-objects/view-models.adoc b/antora/components/ug/modules/fun/pages/building-blocks/types-of-domain-objects/view-models.adoc
index 48e5617..2a6cf2b 100644
--- a/antora/components/ug/modules/fun/pages/building-blocks/types-of-domain-objects/view-models.adoc
+++ b/antora/components/ug/modules/fun/pages/building-blocks/types-of-domain-objects/view-models.adoc
@@ -92,7 +92,7 @@ You certainly _shouldn't_ try to build out a domain layer that could support eve
Instead, you should iterate.
Identify the use case/story/end-user objective that will deliver value to the business.
-Then build out the minimum domain entities to support that use case (refining the xref:ug:fun:ugfun.adoc#__ugfun_core-concepts_philosophy_domain-driven-design_ubiquitous-language[ubiquitous language] as you go).
+Then build out the minimum domain entities to support that use case (refining the xref:ug:fun:core-concepts/philosophy/domain-driven-design/ubiquitous-language.adoc[ubiquitous language] as you go).
Then, identify if there any view models that could be introduced which would simplify the end-user interactions with the system (perhaps automating several related use cases together).
****
diff --git a/antora/components/ug/modules/fun/pages/getting-started/simpleapp-archetype.adoc b/antora/components/ug/modules/fun/pages/getting-started/simpleapp-archetype.adoc
index 0a053f0..43336aa 100644
--- a/antora/components/ug/modules/fun/pages/getting-started/simpleapp-archetype.adoc
+++ b/antora/components/ug/modules/fun/pages/getting-started/simpleapp-archetype.adoc
@@ -7,7 +7,7 @@ Like the xref:ug:fun:getting-started/helloworld-archetype.adoc[helloworld archet
However, the generated application also provides more structure to assist you as your application grows.
-We'll talk more about the structure of the generated app xref:ugfun.adoc#__ugfun_getting-started_simpleapp-archetype_structure-of-the-app[below], but for now let's see how to generate the application.
+We'll talk more about the structure of the generated app xref:ug:fun:getting-started/simpleapp-archetype/structure-of-the-app.adoc[below], but for now let's see how to generate the application.
[TIP]
diff --git a/antora/components/ug/modules/fun/pages/programming-model/actions.adoc b/antora/components/ug/modules/fun/pages/programming-model/actions.adoc
index 2a6db1d..aa6a050 100644
--- a/antora/components/ug/modules/fun/pages/programming-model/actions.adoc
+++ b/antora/components/ug/modules/fun/pages/programming-model/actions.adoc
@@ -154,12 +154,12 @@ public List<Product> autoComplete0AddToBasket(@MinLength(3) String searchTerm) {
}
----
-As the example suggests, any collection parameter type must provide a way to select items, either by way of a "choices" or "autoComplete" supporting method or alternatively defined globally using xref:rg:ant:DomainObject.adoc[`@DomainObject`] on the referenced type (described xref:ug:fun:ugfun.adoc#__ugfun_programming-model_actions_reference-parameter-types_removing-boilerplate[above]).
+As the example suggests, any collection parameter type must provide a way to select items, either by way of a "choices" or "autoComplete" supporting method or alternatively defined globally using xref:rg:ant:DomainObject.adoc[`@DomainObject`] on the referenced type (described xref:ug:fun:programming-model/actions/reference-parameter-types/removing-boilerplate.adoc[above]).
== Optional Parameters
-Whereas the xref:ug:fun:ugfun.adoc#__ugfun_programming-model_properties_optional-properties[optionality of properties] is defined using xref:rg:ant:Column/allowsNull.adoc[`@javax.jdo.annotations.Column#allowsNull()`], that JDO annotation cannot be applied to parameter types.
+Whereas the xref:ug:fun:programming-model/properties/optional-properties.adoc[optionality of properties] is defined using xref:rg:ant:Column/allowsNull.adoc[`@javax.jdo.annotations.Column#allowsNull()`], that JDO annotation cannot be applied to parameter types.
Instead, either the xref:rg:ant:Nullable.adoc[`@Nullable`] annotation or the xref:rg:ant:Parameter/optionality.adoc[`@Parameter#optionality()`] annotation/attribute is used.
For example:
@@ -187,7 +187,7 @@ See also xref:ug:fun:programming-model/properties-vs-parameters.adoc[properties
== ``String`` Parameters (Length)
-Whereas the xref:ug:fun:ugfun.adoc#__ugfun_programming-model_properties_datatypes_strings[length of string properties] is defined using xref:rg:ant:Column/length.adoc[`@javax.jdo.annotations.Column#length()`], that JDO annotation cannot be applied to parameter types.
+Whereas the xref:ug:fun:programming-model/properties/datatypes/strings.adoc[length of string properties] is defined using xref:rg:ant:Column/length.adoc[`@javax.jdo.annotations.Column#length()`], that JDO annotation cannot be applied to parameter types.
Instead, the xref:rg:ant:Parameter/maxLength.adoc[`@Parameter#maxLength()`] annotation/attribute is used.
For example:
@@ -227,7 +227,7 @@ See also xref:ug:fun:programming-model/properties-vs-parameters.adoc[properties
== ``BigDecimal``s (Precision)
-Whereas the xref:ug:fun:ugfun.adoc#__ugfun_programming-model_properties_datatypes_bigdecimals[precision of BigDecimal properties] is defined using xref:rg:ant:Column/scale.adoc[`@javax.jdo.annotations.Column#scale()`], that JDO annotation cannot be applied to parameter types.
+Whereas the xref:ug:fun:programming-model/properties/datatypes/bigdecimals.adoc[precision of BigDecimal properties] is defined using xref:rg:ant:Column/scale.adoc[`@javax.jdo.annotations.Column#scale()`], that JDO annotation cannot be applied to parameter types.
Instead, the xref:rg:ant:Digits.adoc[`@javax.validation.constraints.Digits#fraction()`] annotation/attribute is used.
For example:
diff --git a/antora/components/ug/modules/fun/pages/programming-model/collections.adoc b/antora/components/ug/modules/fun/pages/programming-model/collections.adoc
index 896a89c..7c7a606 100644
--- a/antora/components/ug/modules/fun/pages/programming-model/collections.adoc
+++ b/antora/components/ug/modules/fun/pages/programming-model/collections.adoc
@@ -6,7 +6,7 @@ include::_attributes.adoc[]
A collection is an instance variable of a domain object, of a collection type that holds references to other domain objects.
For example, a `Customer` may have a collection of ``Order``s).
-It's ok for a xref:ug:fun:ugfun.adoc#__ugfun_programming-model_class-definition_entities[domain entity] to reference another domain entity, and for a xref:ug:fun:ugfun.adoc#__ugfun_programming-model_class-definition_view-models[view model] to reference both view model and domain entities.
+It's ok for a xref:ug:fun:programming-model/class-definition/entities.adoc[domain entity] to reference another domain entity, and for a xref:ug:fun:programming-model/class-definition/view-models.adoc[view model] to reference both view model and domain entities.
However, it isn't valid for a domain entity to hold a persisted reference to view model (DataNucleus will not know how to persist that view model).
Formally speaking, a collection is simply a regular JavaBean getter, returning a collection type (subtype of `java.util.Collection`).
diff --git a/antora/components/ug/modules/fun/pages/programming-model/domain-services/organizing-services.adoc b/antora/components/ug/modules/fun/pages/programming-model/domain-services/organizing-services.adoc
index 83a1620..8a89021 100644
--- a/antora/components/ug/modules/fun/pages/programming-model/domain-services/organizing-services.adoc
+++ b/antora/components/ug/modules/fun/pages/programming-model/domain-services/organizing-services.adoc
@@ -24,7 +24,7 @@ This feature is deprecated because xref:ug:fun:building-blocks/types-of-domain-o
If the domain service nature is not specified (or is left to its default, `VIEW`), then the service's actions will appear in the UI.
-While for long-term maintainability we do recommend the naming conventions described xref:ug:fun:ugfun.adoc#__ugfun_building-blocks_domain-services_organizing-services[above], you can get away with far fewer services when just prototyping a domain.
+While for long-term maintainability we do recommend the naming conventions described xref:ug:fun:building-blocks/domain-services/organizing-services.adoc[above], you can get away with far fewer services when just prototyping a domain.
Later on it is easy enough to refactor the code to tease apart the different responsibilities.
Pulling all the above together, here are our suggestions as to how you should organize your domain services.
diff --git a/antora/components/ug/modules/fun/pages/programming-model/properties.adoc b/antora/components/ug/modules/fun/pages/programming-model/properties.adoc
index 35bbd04..89e59b1 100644
--- a/antora/components/ug/modules/fun/pages/programming-model/properties.adoc
+++ b/antora/components/ug/modules/fun/pages/programming-model/properties.adoc
@@ -3,7 +3,7 @@
include::_attributes.adoc[]
-A property is an instance variable of a domain object, of a scalar type, that holds some state about either a xref:ug:fun:ugfun.adoc#__ugfun_programming-model_class-definition_entities[domain entity] or a xref:ug:fun:ugfun.adoc#__ugfun_programming-model_class-definition_view-models[view model].
+A property is an instance variable of a domain object, of a scalar type, that holds some state about either a xref:ug:fun:programming-model/class-definition/entities.adoc[domain entity] or a xref:ug:fun:programming-model/class-definition/view-models.adoc[view model].
For example, a ``Customer``'s `firstName` would be a property, as would their `accountCreationDate` that they created their account.
All properties have at least a "getter" method, and most properties have also a "setter" method (meaning that they are mutable).
@@ -60,7 +60,7 @@ Or to map a reference type:
private Customer customer;
----
-It's ok for a xref:ug:fun:ugfun.adoc#__ugfun_programming-model_class-definition_entities[domain entity] to reference another domain entity, and for a xref:ug:fun:ugfun.adoc#__ugfun_programming-model_class-definition_view-models[view model] to reference both view model and domain entities.
+It's ok for a xref:ug:fun:programming-model/class-definition/entities.adoc[domain entity] to reference another domain entity, and for a xref:ug:fun:programming-model/class-definition/view-models.adoc[view model] to reference both view model and domain entities.
However, it isn't valid for a domain entity to hold a persisted reference to view model (DataNucleus will not know how to persist that view model).
[NOTE]
@@ -253,7 +253,7 @@ More information can be found http://www.opentaps.org/docs/index.php/How_to_Use_
Apache Isis configures JDO/DataNucleus so that the properties of type `org.apache.isis.applib.value.Blob` and `org.apache.isis.applib.value.Clob` can also be persisted.
-As for xref:ug:fun:ugfun.adoc#__ugfun_programming-model_properties_datatypes_joda-dates[Joda dates], this requires the `@javax.jdo.annotations.Persistent` annotation.
+As for xref:ug:fun:programming-model/properties/datatypes/joda-dates.adoc[Joda dates], this requires the `@javax.jdo.annotations.Persistent` annotation.
However, whereas for dates one would always expect this value to be retrieved eagerly, for blobs and clobs it is not so clear cut.
For example, in the `ToDoItem` class (of the https://github.com/isisaddons/isis-app-todoapp/blob/0333852ddd18ad67e3356fccf805aa442246790d/dom/src/main/java/todoapp/dom/todoitem/ToDoItem.java#L442[todoapp example app] (non-ASF) the `attachment` property is as follows:
@@ -302,7 +302,7 @@ There can be differences in behaviour between JDBC drivers.
=== ``Clob``s
-Mapping `Clob`s works in a very similar way to xref:ug:fun:ugfun.adoc#__ugfun_programming-model_properties_datatypes_blobs[``Blob``]s, but the `jdbcType` and `sqlType` attributes will, respectively, be `CLOB` and `LONGVARCHAR`:
+Mapping `Clob`s works in a very similar way to xref:ug:fun:programming-model/properties/datatypes/blobs.adoc[``Blob``]s, but the `jdbcType` and `sqlType` attributes will, respectively, be `CLOB` and `LONGVARCHAR`:
[source,java]
----