You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@isis.apache.org by ah...@apache.org on 2022/02/03 11:54:45 UTC

[isis] branch master updated: ISIS-2877: docs: re-create index

This is an automated email from the ASF dual-hosted git repository.

ahuber pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/isis.git


The following commit(s) were added to refs/heads/master by this push:
     new d6d8f04  ISIS-2877: docs: re-create index
d6d8f04 is described below

commit d6d8f04529e0bc9ded325ca59f8a0872f1ef21ab
Author: Andi Huber <ah...@apache.org>
AuthorDate: Thu Feb 3 12:53:38 2022 +0100

    ISIS-2877: docs: re-create index
---
 .../pages/index/util/schema/CommonDtoUtils.adoc    | 12 ++++++
 .../index/value/semantics/EncoderDecoder.adoc      | 48 ----------------------
 .../index/value/semantics/EncodingException.adoc   | 18 --------
 .../pages/index/value/semantics/ValueComposer.adoc | 15 -------
 .../value/semantics/ValueSemanticsAbstract.adoc    |  1 -
 .../value/semantics/ValueSemanticsProvider.adoc    | 34 ++++++++++-----
 core/adoc/modules/_overview/pages/about.adoc       |  6 +--
 7 files changed, 38 insertions(+), 96 deletions(-)

diff --git a/antora/components/refguide-index/modules/applib/pages/index/util/schema/CommonDtoUtils.adoc b/antora/components/refguide-index/modules/applib/pages/index/util/schema/CommonDtoUtils.adoc
index 9d35f89..8bf4f11 100644
--- a/antora/components/refguide-index/modules/applib/pages/index/util/schema/CommonDtoUtils.adoc
+++ b/antora/components/refguide-index/modules/applib/pages/index/util/schema/CommonDtoUtils.adoc
@@ -7,12 +7,24 @@
 .CommonDtoUtils.java
 ----
 class CommonDtoUtils {
+  ValueWithTypeDto getFundamentalValueFromJson(ValueType valueType, String json)
+  String getFundamentalValueAsJson(ValueWithTypeDto valueDto)
+  String getFundamentalValueAsJson(ValueType valueType, ValueDto valueDto)
+  String enumDtoToJson(EnumDto dto)
+  String blobDtoToJson(BlobDto dto)
+  String clobDtoToJson(ClobDto dto)
   D recordFundamentalValue(ValueType valueType, D valueDto, Object pojo)
   Object getValueAsObject(ValueWithTypeDto valueDto)
   Object getValueAsObject(ValueType valueType, ValueDto valueDto)
   ValueWithTypeDto toValueWithTypeDto(ValueType valueType, ValueDto valueDto)
   String getMapValue(MapDto mapDto, String key)
   void putMapKeyValue(MapDto mapDto, String key, String value)
+  ValueWithTypeDto fundamentalType(ValueType vType, T value)
+  ValueDecomposition fundamentalTypeAsDecomposition(ValueType vType, T value)
+  TypedTupleBuilder<T> typedTupleBuilder(T value)
+  Map<String, Object> typedTupleAsMap(TypedTupleDto dto)
+  ParamDto paramDto(String paramName)
+  void copy(ValueWithTypeDto src, ValueWithTypeDto dst)
 }
 ----
 
diff --git a/antora/components/refguide-index/modules/applib/pages/index/value/semantics/EncoderDecoder.adoc b/antora/components/refguide-index/modules/applib/pages/index/value/semantics/EncoderDecoder.adoc
deleted file mode 100644
index 55ae5dd..0000000
--- a/antora/components/refguide-index/modules/applib/pages/index/value/semantics/EncoderDecoder.adoc
+++ /dev/null
@@ -1,48 +0,0 @@
-= EncoderDecoder _(interface)_
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-
-Provides a mechanism for encoding/decoding objects.
-
-This interface is used in two complementary ways:
-
-* As one option, it allows objects to take control of their own encoding/decoding, by implementing directly. However, the instance is used as a factory for itself. The framework will instantiate an instance, invoke the appropriate method method, and use the returned object. The instantiated instance itself will be discarded.
-
-Whatever the class that implements this interface, it must also expose either a `public` no-arg constructor, or (for implementations that also are `Facet` s) a `public` constructor that accepts a single `FacetHolder` . This constructor allows the framework to instantiate the object reflectively.
-
-== API
-
-[source,java]
-.EncoderDecoder.java
-----
-interface EncoderDecoder<T> {
-  String toEncodedString(T toEncode)     // <.>
-  T fromEncodedString(String encodedString)     // <.>
-}
-----
-
-<.> xref:#toEncodedString__T[toEncodedString(T)]
-+
---
-Returns the provided object as an encoded string.
---
-<.> xref:#fromEncodedString__String[fromEncodedString(String)]
-+
---
-Converts an encoded string to an instance of the object.
---
-
-== Members
-
-[#toEncodedString__T]
-=== toEncodedString(T)
-
-Returns the provided object as an encoded string.
-
-Even if the class is self-encodeable, note that this method is always called on a new instance of the object created via the no-arg constructor. That is, the object shouldn't encode itself, it should encode the object provided to it.
-
-[#fromEncodedString__String]
-=== fromEncodedString(String)
-
-Converts an encoded string to an instance of the object.
-
-Note that here the implementing class is acting as a factory for itself.
diff --git a/antora/components/refguide-index/modules/applib/pages/index/value/semantics/EncodingException.adoc b/antora/components/refguide-index/modules/applib/pages/index/value/semantics/EncodingException.adoc
deleted file mode 100644
index 2f1e67c..0000000
--- a/antora/components/refguide-index/modules/applib/pages/index/value/semantics/EncodingException.adoc
+++ /dev/null
@@ -1,18 +0,0 @@
-= EncodingException
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-
-Indicates that encoding or decoding has failed.
-
-== API
-
-[source,java]
-.EncodingException.java
-----
-class EncodingException {
-  EncodingException()
-  EncodingException(String msg)
-  EncodingException(String msg, Throwable cause)
-  EncodingException(Throwable cause)
-}
-----
-
diff --git a/antora/components/refguide-index/modules/applib/pages/index/value/semantics/ValueComposer.adoc b/antora/components/refguide-index/modules/applib/pages/index/value/semantics/ValueComposer.adoc
deleted file mode 100644
index 5c63aa3..0000000
--- a/antora/components/refguide-index/modules/applib/pages/index/value/semantics/ValueComposer.adoc
+++ /dev/null
@@ -1,15 +0,0 @@
-= ValueComposer _(interface)_
-:Notice: Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at. http://www.apache.org/licenses/LICENSE-2.0 . Unless required by applicable law or ag [...]
-
-Provides construction and extraction for a given value-type from and into its constituent parts.
-
-== API
-
-[source,java]
-.ValueComposer.java
-----
-interface ValueComposer<T> {
-  Object getValueMixin(T value)
-}
-----
-
diff --git a/antora/components/refguide-index/modules/applib/pages/index/value/semantics/ValueSemanticsAbstract.adoc b/antora/components/refguide-index/modules/applib/pages/index/value/semantics/ValueSemanticsAbstract.adoc
index 52315d4..9a8a681 100644
--- a/antora/components/refguide-index/modules/applib/pages/index/value/semantics/ValueSemanticsAbstract.adoc
+++ b/antora/components/refguide-index/modules/applib/pages/index/value/semantics/ValueSemanticsAbstract.adoc
@@ -11,7 +11,6 @@ class ValueSemanticsAbstract<T> {
   OrderRelation<T, ?> getOrderRelation()
   Converter<T, ?> getConverter()
   Renderer<T> getRenderer()
-  EncoderDecoder<T> getEncoderDecoder()
   Parser<T> getParser()
   DefaultsProvider<T> getDefaultsProvider()
   Can<T> getExamples()     // <.>
diff --git a/antora/components/refguide-index/modules/applib/pages/index/value/semantics/ValueSemanticsProvider.adoc b/antora/components/refguide-index/modules/applib/pages/index/value/semantics/ValueSemanticsProvider.adoc
index 9961eca..377ca38 100644
--- a/antora/components/refguide-index/modules/applib/pages/index/value/semantics/ValueSemanticsProvider.adoc
+++ b/antora/components/refguide-index/modules/applib/pages/index/value/semantics/ValueSemanticsProvider.adoc
@@ -15,11 +15,13 @@ Whatever the class that implements this interface, it must also expose either a
 interface ValueSemanticsProvider<T> {
   Class<T> getCorrespondingClass()
   ValueType getSchemaValueType()     // <.>
+  ValueDecomposition decompose(T value)     // <.>
+  T compose(ValueDecomposition decomposition)     // <.>
+  Object getValueMixin(T value)
   OrderRelation<T, ?> getOrderRelation()     // <.>
   Converter<T, ?> getConverter()     // <.>
   Renderer<T> getRenderer()     // <.>
   Parser<T> getParser()     // <.>
-  EncoderDecoder<T> getEncoderDecoder()     // <.>
   DefaultsProvider<T> getDefaultsProvider()     // <.>
   boolean isNumberType()
   boolean isTemporalType()
@@ -31,6 +33,16 @@ interface ValueSemanticsProvider<T> {
 --
 Values might appear within _CommandDto_ , _InteractionDto_ and _ChangesDto_ , where a mapping onto one of _ValueType_ (s) as provided by the XML schema is required.
 --
+<.> xref:#decompose__T[decompose(T)]
++
+--
+Converts a value object into either a _ValueWithTypeDto_ or _TypedTupleDto_ .
+--
+<.> xref:#compose__ValueDecomposition[compose(ValueDecomposition)]
++
+--
+Converts either a _ValueWithTypeDto_ or a _TypedTupleDto_ to an instance of the object.
+--
 <.> xref:#getOrderRelation__[getOrderRelation()]
 +
 --
@@ -51,11 +63,6 @@ The xref:refguide:applib:index/value/semantics/Renderer.adoc[Renderer] , if any.
 --
 The xref:refguide:applib:index/value/semantics/Parser.adoc[Parser] , if any.
 --
-<.> xref:#getEncoderDecoder__[getEncoderDecoder()]
-+
---
-The xref:refguide:applib:index/value/semantics/EncoderDecoder.adoc[EncoderDecoder] , if any.
---
 <.> xref:#getDefaultsProvider__[getDefaultsProvider()]
 +
 --
@@ -69,6 +76,16 @@ The xref:refguide:applib:index/value/semantics/DefaultsProvider.adoc[DefaultsPro
 
 Values might appear within _CommandDto_ , _InteractionDto_ and _ChangesDto_ , where a mapping onto one of _ValueType_ (s) as provided by the XML schema is required.
 
+[#decompose__T]
+=== decompose(T)
+
+Converts a value object into either a _ValueWithTypeDto_ or _TypedTupleDto_ .
+
+[#compose__ValueDecomposition]
+=== compose(ValueDecomposition)
+
+Converts either a _ValueWithTypeDto_ or a _TypedTupleDto_ to an instance of the object.
+
 [#getOrderRelation__]
 === getOrderRelation()
 
@@ -89,11 +106,6 @@ The xref:refguide:applib:index/value/semantics/Renderer.adoc[Renderer] , if any.
 
 The xref:refguide:applib:index/value/semantics/Parser.adoc[Parser] , if any.
 
-[#getEncoderDecoder__]
-=== getEncoderDecoder()
-
-The xref:refguide:applib:index/value/semantics/EncoderDecoder.adoc[EncoderDecoder] , if any.
-
 [#getDefaultsProvider__]
 === getDefaultsProvider()
 
diff --git a/core/adoc/modules/_overview/pages/about.adoc b/core/adoc/modules/_overview/pages/about.adoc
index 67c648c..b673a9a 100644
--- a/core/adoc/modules/_overview/pages/about.adoc
+++ b/core/adoc/modules/_overview/pages/about.adoc
@@ -1505,7 +1505,7 @@ org.jmock:jmock:jar:<managed> +
 
 .Document Index Entries
 ****
-xref:refguide:applib:index/AbstractViewModel.adoc[AbstractViewModel], xref:refguide:applib:index/Identifier.adoc[Identifier], xref:refguide:applib:index/IsisModuleApplib.adoc[IsisModuleApplib], xref:refguide:applib:index/RecreatableDomainObject.adoc[RecreatableDomainObject], xref:refguide:applib:index/ViewModel.adoc[ViewModel], xref:refguide:applib:index/annotation/Action.adoc[Action], xref:refguide:applib:index/annotation/ActionLayout.adoc[ActionLayout], xref:refguide:applib:index/annot [...]
+xref:refguide:applib:index/AbstractViewModel.adoc[AbstractViewModel], xref:refguide:applib:index/Identifier.adoc[Identifier], xref:refguide:applib:index/IsisModuleApplib.adoc[IsisModuleApplib], xref:refguide:applib:index/RecreatableDomainObject.adoc[RecreatableDomainObject], xref:refguide:applib:index/ViewModel.adoc[ViewModel], xref:refguide:applib:index/annotation/Action.adoc[Action], xref:refguide:applib:index/annotation/ActionLayout.adoc[ActionLayout], xref:refguide:applib:index/annot [...]
 ****
 
 |Apache Isis Core - Code Gen (ByteBuddy)
@@ -3472,7 +3472,7 @@ Directory: /valuetypes/asciidoc/ui
 |.Dependencies
 ****
 com.github.jnr:jnr-constants:jar:0.10.3 +
-com.github.jnr:jnr-enxio:jar:0.32.12 +
+com.github.jnr:jnr-enxio:jar:0.32.13 +
 com.github.jnr:jnr-posix:jar:3.1.15 +
 org.apache.isis.core:isis-core-metamodel:jar:<managed> +
 org.apache.isis.valuetypes:isis-valuetypes-asciidoc-applib:jar:<managed> +
@@ -4440,7 +4440,7 @@ Directory: /extensions/vw/fullcalendar/applib
 ----
 |.Components
 ****
-o.a.i.extensions.fullcalendar.applib.value.CalendarEventSemanticsProvider +
+o.a.i.extensions.fullcalendar.applib.value.CalendarEventSemantics +
 ****
 
 .Dependencies