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 2021/06/06 16:25:11 UTC
[isis] 01/08: ISIS-2483: regen refguide-index docs : updated from
recent other tickets.
This is an automated email from the ASF dual-hosted git repository.
danhaywood pushed a commit to branch ISIS-2717
in repository https://gitbox.apache.org/repos/asf/isis.git
commit 0cfecc94d055cb202535e577313a64726f905ced
Author: danhaywood <da...@haywood-associates.co.uk>
AuthorDate: Sun Jun 6 15:56:46 2021 +0100
ISIS-2483: regen refguide-index docs : updated from recent other tickets.
---
.../pages/index/annotation/DomainObject.adoc | 12 ++---
.../pages/index/graph/tree/LazyTreeNode.adoc | 20 ---------
.../applib/pages/index/graph/tree/TreeNode.adoc | 6 ++-
.../services/appfeat/ApplicationFeatureId.adoc | 1 +
.../pages/index/services/metamodel/Config.adoc | 13 +++---
.../index/services/metamodel/DomainMember.adoc | 2 +
.../index/services/metamodel/MetaModelService.adoc | 2 +-
.../services/metamodel/MetaModelServiceMenu.adoc | 2 +-
.../index/services/repository/EntityState.adoc | 28 ++++++++----
.../services/repository/RepositoryService.adoc | 52 ----------------------
.../index/secman/applib/SecmanConfiguration.adoc | 9 +++-
...PermissionsEvaluationServiceAllowBeatsVeto.adoc | 7 +++
...PermissionsEvaluationServiceVetoBeatsAllow.adoc | 7 +++
.../seed/IsisExtH2ConsoleRoleAndPermissions.adoc | 1 +
.../viewer/IsisModuleViewerWicketViewer.adoc | 1 +
15 files changed, 64 insertions(+), 99 deletions(-)
diff --git a/antora/components/refguide-index/modules/applib/pages/index/annotation/DomainObject.adoc b/antora/components/refguide-index/modules/applib/pages/index/annotation/DomainObject.adoc
index 35c7ec3..b868ae4 100644
--- a/antora/components/refguide-index/modules/applib/pages/index/annotation/DomainObject.adoc
+++ b/antora/components/refguide-index/modules/applib/pages/index/annotation/DomainObject.adoc
@@ -10,7 +10,7 @@ Domain semantics for domain objects (entities and view models; for services see
----
@interface DomainObject {
Class<?> autoCompleteRepository() default Object.class; // <.>
- String autoCompleteAction() default "autoComplete"; // <.>
+ String autoCompleteMethod() default "autoComplete"; // <.>
Bounding bounding() default Bounding.NOT_SPECIFIED; // <.>
Editing editing() default Editing.NOT_SPECIFIED; // <.>
String editingDisabledReason() default "Disabled"; // <.>
@@ -37,10 +37,10 @@ Domain semantics for domain objects (entities and view models; for services see
--
The class of the domain service that provides an `autoComplete(String)` method.
--
-<.> xref:#autoCompleteAction[autoCompleteAction]
+<.> xref:#autoCompleteMethod[autoCompleteMethod]
+
--
-The method (despite its name, not necessarily an action) to use in order to perform the auto-complete search (defaults to "autoComplete").
+The method to use in order to perform the auto-complete search (defaults to "autoComplete").
--
<.> xref:#bounding[bounding]
+
@@ -149,10 +149,10 @@ The class of the domain service that provides an `autoComplete(String)` method.
It is sufficient to specify an interface rather than a concrete type.
-[#autoCompleteAction]
-=== autoCompleteAction
+[#autoCompleteMethod]
+=== autoCompleteMethod
-The method (despite its name, not necessarily an action) to use in order to perform the auto-complete search (defaults to "autoComplete").
+The method to use in order to perform the auto-complete search (defaults to "autoComplete").
The method is required to accept a single string parameter, and must return a list of the domain type.
diff --git a/antora/components/refguide-index/modules/applib/pages/index/graph/tree/LazyTreeNode.adoc b/antora/components/refguide-index/modules/applib/pages/index/graph/tree/LazyTreeNode.adoc
deleted file mode 100644
index fbb634f..0000000
--- a/antora/components/refguide-index/modules/applib/pages/index/graph/tree/LazyTreeNode.adoc
+++ /dev/null
@@ -1,20 +0,0 @@
-= LazyTreeNode
-: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 [...]
-
-== API
-
-[source,java]
-.LazyTreeNode.java
-----
-class LazyTreeNode<T> {
- TreeNode<T> of(T value, Class<? extends TreeAdapter<T>> treeAdapterClass, TreeState sharedState)
- T getValue()
- TreeNode<T> getParentIfAny()
- int getChildCount()
- Stream<TreeNode<T>> streamChildren()
- Class<? extends TreeAdapter<T>> getTreeAdapterClass()
- TreePath getPositionAsPath()
- TreeState getTreeState()
-}
-----
-
diff --git a/antora/components/refguide-index/modules/applib/pages/index/graph/tree/TreeNode.adoc b/antora/components/refguide-index/modules/applib/pages/index/graph/tree/TreeNode.adoc
index d66a3f9..d750979 100644
--- a/antora/components/refguide-index/modules/applib/pages/index/graph/tree/TreeNode.adoc
+++ b/antora/components/refguide-index/modules/applib/pages/index/graph/tree/TreeNode.adoc
@@ -1,4 +1,4 @@
-= TreeNode _(interface)_
+= TreeNode
: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 [...]
Fundamental building block of Tree structures.
@@ -8,7 +8,9 @@ Fundamental building block of Tree structures.
[source,java]
.TreeNode.java
----
-interface TreeNode<T> {
+class TreeNode<T> {
+ TreeNode<T> of(T value, Class<? extends TreeAdapter<T>> treeAdapterClass, TreeState sharedState)
+ T getValue()
int getIncomingCount()
int getOutgoingCount()
Stream<Edge<T>> streamIncoming()
diff --git a/antora/components/refguide-index/modules/applib/pages/index/services/appfeat/ApplicationFeatureId.adoc b/antora/components/refguide-index/modules/applib/pages/index/services/appfeat/ApplicationFeatureId.adoc
index 088fec3..ee17c35 100644
--- a/antora/components/refguide-index/modules/applib/pages/index/services/appfeat/ApplicationFeatureId.adoc
+++ b/antora/components/refguide-index/modules/applib/pages/index/services/appfeat/ApplicationFeatureId.adoc
@@ -34,6 +34,7 @@ class ApplicationFeatureId {
ApplicationFeatureId parseEncoded(final String encodedString) // <.>
Can<ApplicationFeatureId> getPathIds()
Can<ApplicationFeatureId> getParentFeatureIds()
+ boolean contains(final ApplicationFeatureId otherFeatureId)
int compareTo(final ApplicationFeatureId other)
boolean equals(final Object o)
int hashCode()
diff --git a/antora/components/refguide-index/modules/applib/pages/index/services/metamodel/Config.adoc b/antora/components/refguide-index/modules/applib/pages/index/services/metamodel/Config.adoc
index b796020..cdc475c 100644
--- a/antora/components/refguide-index/modules/applib/pages/index/services/metamodel/Config.adoc
+++ b/antora/components/refguide-index/modules/applib/pages/index/services/metamodel/Config.adoc
@@ -10,15 +10,14 @@ Describes what to include in the export from _MetaModelService#exportMetaModel(C
----
class Config {
Config()
- Set<String> getPackagePrefixes()
+ Set<String> getNamespacePrefixes()
Config withIgnoreNoop()
Config withIgnoreInterfaces()
Config withIgnoreAbstractClasses()
Config withIgnoreBuiltInValueTypes()
Config withIgnoreMixins()
- Config withPackagePrefixAny()
- boolean isPackagePrefixAny()
- Config withPackagePrefix(final String packagePrefix) // <.>
+ boolean isNamespacePrefixAny()
+ Config withNamespacePrefix(final String namespacePrefix) // <.>
boolean isIgnoreNoop()
boolean isIgnoreInterfaces()
boolean isIgnoreAbstractClasses()
@@ -27,7 +26,7 @@ class Config {
}
----
-<.> xref:#withPackagePrefix__String[withPackagePrefix(String)]
+<.> xref:#withNamespacePrefix__String[withNamespacePrefix(String)]
+
--
Returns a new _Config_ with given _packagePrefix_ added to the set of this _Config_ 's packagePrefixes.
@@ -35,7 +34,7 @@ Returns a new _Config_ with given _packagePrefix_ added to the set of this _Conf
== Members
-[#withPackagePrefix__String]
-=== withPackagePrefix(String)
+[#withNamespacePrefix__String]
+=== withNamespacePrefix(String)
Returns a new _Config_ with given _packagePrefix_ added to the set of this _Config_ 's packagePrefixes.
diff --git a/antora/components/refguide-index/modules/applib/pages/index/services/metamodel/DomainMember.adoc b/antora/components/refguide-index/modules/applib/pages/index/services/metamodel/DomainMember.adoc
index 486f15b..e996c32 100644
--- a/antora/components/refguide-index/modules/applib/pages/index/services/metamodel/DomainMember.adoc
+++ b/antora/components/refguide-index/modules/applib/pages/index/services/metamodel/DomainMember.adoc
@@ -8,6 +8,8 @@
----
interface DomainMember {
String getClassType()
+ String getLogicalTypeName()
+ String getNamespace()
String getClassName()
String getPackageName()
String getType()
diff --git a/antora/components/refguide-index/modules/applib/pages/index/services/metamodel/MetaModelService.adoc b/antora/components/refguide-index/modules/applib/pages/index/services/metamodel/MetaModelService.adoc
index 4809a92..8bbbac9 100644
--- a/antora/components/refguide-index/modules/applib/pages/index/services/metamodel/MetaModelService.adoc
+++ b/antora/components/refguide-index/modules/applib/pages/index/services/metamodel/MetaModelService.adoc
@@ -109,7 +109,7 @@ This is used by framework-provided implementations of _org.apache.isis.applib.se
Exports the entire metamodel as a DTO, serializable into XML using JAXB.
-The xref:refguide:applib:index/services/metamodel/Config.adoc[Config] parameter can be used to restrict/filter the export to some subset of the metamodel; in particular to specific _Config#getPackagePrefixes() package prefixes_ .
+The xref:refguide:applib:index/services/metamodel/Config.adoc[Config] parameter can be used to restrict/filter the export to some subset of the metamodel; in particular to specific _Config#getNamespacePrefixes() namespace prefixes_ .
include::hooks/MetaModelService_010-implementation.adoc[]
diff --git a/antora/components/refguide-index/modules/applib/pages/index/services/metamodel/MetaModelServiceMenu.adoc b/antora/components/refguide-index/modules/applib/pages/index/services/metamodel/MetaModelServiceMenu.adoc
index 5e46d24..e098d88 100644
--- a/antora/components/refguide-index/modules/applib/pages/index/services/metamodel/MetaModelServiceMenu.adoc
+++ b/antora/components/refguide-index/modules/applib/pages/index/services/metamodel/MetaModelServiceMenu.adoc
@@ -13,7 +13,7 @@ class MetaModelServiceMenu {
MetaModelServiceMenu()
Clob downloadMetaModelCsv(final String csvFileName)
String default0DownloadMetaModelCsv()
- Clob downloadMetaModelXml(final String fileName, final List<String> packages, final boolean ignoreInterfaces)
+ Clob downloadMetaModelXml(final String fileName, final List<String> namespaces, final boolean ignoreInterfaces)
String validateDownloadMetaModelXml(final String fileName, final List<String> packagePrefixes, final boolean ignoreInterfaces)
String default0DownloadMetaModelXml()
List<String> choices1DownloadMetaModelXml()
diff --git a/antora/components/refguide-index/modules/applib/pages/index/services/repository/EntityState.adoc b/antora/components/refguide-index/modules/applib/pages/index/services/repository/EntityState.adoc
index 6c17ae4..e125d2c 100644
--- a/antora/components/refguide-index/modules/applib/pages/index/services/repository/EntityState.adoc
+++ b/antora/components/refguide-index/modules/applib/pages/index/services/repository/EntityState.adoc
@@ -12,11 +12,13 @@ enum EntityState {
NOT_PERSISTABLE // <.>
PERSISTABLE_ATTACHED // <.>
PERSISTABLE_DETACHED // <.>
- PERSISTABLE_DESTROYED // <.>
+ PERSISTABLE_REMOVED // <.>
boolean isPersistable() // <.>
boolean isAttached() // <.>
boolean isDetached() // <.>
- boolean isDestroyed() // <.>
+ boolean isRemoved() // <.>
+ boolean isDetachedOrRemoved() // <.>
+ boolean isAttachedOrRemoved() // <.>
}
----
@@ -35,7 +37,7 @@ Object with this state is an entity that is attached to a persistence session, i
--
Object with this state is an entity but that is detached from a persistence session, in other words changes to the entity will _not_ be flushed back to the database.
--
-<.> xref:#PERSISTABLE_DESTROYED[PERSISTABLE_DESTROYED]
+<.> xref:#PERSISTABLE_REMOVED[PERSISTABLE_REMOVED]
+
--
Object with this state is an entity that has been removed from the database. Objects in this state may no longer be interacted with.
@@ -55,11 +57,13 @@ Object with this state is an entity that is attached to a persistence session, i
--
Object with this state is an entity but that is detached from a persistence session, in other words changes to the entity will _not_ be flushed back to the database.
--
-<.> xref:#isDestroyed__[isDestroyed()]
+<.> xref:#isRemoved__[isRemoved()]
+
--
Object with this state is an entity that has been removed from the database. Objects in this state may no longer be interacted with.
--
+<.> xref:#isDetachedOrRemoved__[isDetachedOrRemoved()]
+<.> xref:#isAttachedOrRemoved__[isAttachedOrRemoved()]
== Members
@@ -78,8 +82,8 @@ Object with this state is an entity that is attached to a persistence session, i
Object with this state is an entity but that is detached from a persistence session, in other words changes to the entity will _not_ be flushed back to the database.
-[#PERSISTABLE_DESTROYED]
-=== PERSISTABLE_DESTROYED
+[#PERSISTABLE_REMOVED]
+=== PERSISTABLE_REMOVED
Object with this state is an entity that has been removed from the database. Objects in this state may no longer be interacted with.
@@ -98,7 +102,15 @@ Object with this state is an entity that is attached to a persistence session, i
Object with this state is an entity but that is detached from a persistence session, in other words changes to the entity will _not_ be flushed back to the database.
-[#isDestroyed__]
-=== isDestroyed()
+[#isRemoved__]
+=== isRemoved()
Object with this state is an entity that has been removed from the database. Objects in this state may no longer be interacted with.
+
+Only supported by JDO. Will always return false with JPA.
+
+[#isDetachedOrRemoved__]
+=== isDetachedOrRemoved()
+
+[#isAttachedOrRemoved__]
+=== isAttachedOrRemoved()
diff --git a/antora/components/refguide-index/modules/applib/pages/index/services/repository/RepositoryService.adoc b/antora/components/refguide-index/modules/applib/pages/index/services/repository/RepositoryService.adoc
index a8ba6dc..3d6830e 100644
--- a/antora/components/refguide-index/modules/applib/pages/index/services/repository/RepositoryService.adoc
+++ b/antora/components/refguide-index/modules/applib/pages/index/services/repository/RepositoryService.adoc
@@ -31,8 +31,6 @@ interface RepositoryService {
T detach(T entity) // <.>
T detachedEntity(Class<T> ofType) // <.>
T instantiate(Class<T> ofType) // <.>
- boolean isPersistent(Object domainObject) // <.>
- boolean isDeleted(Object domainObject) // <.>
}
----
@@ -150,30 +148,6 @@ as it requires that the domain entity has a no-arg constructor. Use _#detachedEn
Equivalent to _#detachedEntity(Class)_ .
--
-<.> xref:#isPersistent__Object[isPersistent(Object)]
-+
---
-[WARNING]
-====
-[red]#_deprecated:_#
-
-due to ambiguous semantic, use _#getEntityState(Object)_ instead
-====
-
-Determines if the specified object is persistent (that it is stored permanently outside of the virtual machine in the object store).
---
-<.> xref:#isDeleted__Object[isDeleted(Object)]
-+
---
-[WARNING]
-====
-[red]#_deprecated:_#
-
-due to ambiguous semantic, use _#getEntityState(Object)_ instead
-====
-
-Determines if the specified object has been deleted from the object store.
---
== Members
@@ -341,32 +315,6 @@ as it requires that the domain entity has a no-arg constructor. Use _#detachedEn
Equivalent to _#detachedEntity(Class)_ .
-[#isPersistent__Object]
-=== isPersistent(Object)
-
-[WARNING]
-====
-[red]#_deprecated:_#
-
-due to ambiguous semantic, use _#getEntityState(Object)_ instead
-====
-
-Determines if the specified object is persistent (that it is stored permanently outside of the virtual machine in the object store).
-
-This method can also return `true` if the object has been _#isDeleted(Object) deleted_ from the object store.
-
-[#isDeleted__Object]
-=== isDeleted(Object)
-
-[WARNING]
-====
-[red]#_deprecated:_#
-
-due to ambiguous semantic, use _#getEntityState(Object)_ instead
-====
-
-Determines if the specified object has been deleted from the object store.
-
include::hooks/RepositoryService_010-implementation.adoc[]
include::hooks/RepositoryService_020-examples-and-usage.adoc[]
diff --git a/antora/components/refguide-index/modules/extensions/pages/index/secman/applib/SecmanConfiguration.adoc b/antora/components/refguide-index/modules/extensions/pages/index/secman/applib/SecmanConfiguration.adoc
index b25718a..989718f 100644
--- a/antora/components/refguide-index/modules/extensions/pages/index/secman/applib/SecmanConfiguration.adoc
+++ b/antora/components/refguide-index/modules/extensions/pages/index/secman/applib/SecmanConfiguration.adoc
@@ -1,6 +1,13 @@
= SecmanConfiguration
: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 [...]
+[WARNING]
+====
+[red]#_deprecated:_#
+
+- use `application.yml` config properties instead.
+====
+
Applications consuming secman must instantiate a _org.springframework.context.annotation.Bean_ of this type; secman then uses this bean to configure itself.
The typical place to create this bean is in the top-level `AppManifest` _org.springframework.context.annotation.Configuration_ class.
@@ -13,8 +20,6 @@ This class is implemented as a builder (courtesy of Lombok) but it provides reas
.SecmanConfiguration.java
----
class SecmanConfiguration {
- public static String ADMIN_ROLE_DEFAULT_NAME;
- public static String REGULAR_USER_ROLE_DEFAULT_NAME;
Stream<String> streamAdminNamespacePermissions()
boolean isStickyAdminNamespace(String featureFqn)
}
diff --git a/antora/components/refguide-index/modules/extensions/pages/index/secman/applib/permission/spi/PermissionsEvaluationServiceAllowBeatsVeto.adoc b/antora/components/refguide-index/modules/extensions/pages/index/secman/applib/permission/spi/PermissionsEvaluationServiceAllowBeatsVeto.adoc
index 036ccb3..0b5d87f 100644
--- a/antora/components/refguide-index/modules/extensions/pages/index/secman/applib/permission/spi/PermissionsEvaluationServiceAllowBeatsVeto.adoc
+++ b/antora/components/refguide-index/modules/extensions/pages/index/secman/applib/permission/spi/PermissionsEvaluationServiceAllowBeatsVeto.adoc
@@ -1,6 +1,13 @@
= PermissionsEvaluationServiceAllowBeatsVeto
: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 [...]
+[WARNING]
+====
+[red]#_deprecated:_#
+
+- use `application.yml` config properties instead.
+====
+
An implementation whereby a VETO permission for a feature overrides an ALLOW (for same scope).
== API
diff --git a/antora/components/refguide-index/modules/extensions/pages/index/secman/applib/permission/spi/PermissionsEvaluationServiceVetoBeatsAllow.adoc b/antora/components/refguide-index/modules/extensions/pages/index/secman/applib/permission/spi/PermissionsEvaluationServiceVetoBeatsAllow.adoc
index 468ee2d..a74e571 100644
--- a/antora/components/refguide-index/modules/extensions/pages/index/secman/applib/permission/spi/PermissionsEvaluationServiceVetoBeatsAllow.adoc
+++ b/antora/components/refguide-index/modules/extensions/pages/index/secman/applib/permission/spi/PermissionsEvaluationServiceVetoBeatsAllow.adoc
@@ -1,6 +1,13 @@
= PermissionsEvaluationServiceVetoBeatsAllow
: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 [...]
+[WARNING]
+====
+[red]#_deprecated:_#
+
+- use `application.yml` config properties instead.
+====
+
An implementation whereby a VETO permission for a feature overrides an ALLOW (for same scope).
== API
diff --git a/antora/components/refguide-index/modules/extensions/pages/index/secman/applib/role/seed/IsisExtH2ConsoleRoleAndPermissions.adoc b/antora/components/refguide-index/modules/extensions/pages/index/secman/applib/role/seed/IsisExtH2ConsoleRoleAndPermissions.adoc
index 146b8ae..b1be279 100644
--- a/antora/components/refguide-index/modules/extensions/pages/index/secman/applib/role/seed/IsisExtH2ConsoleRoleAndPermissions.adoc
+++ b/antora/components/refguide-index/modules/extensions/pages/index/secman/applib/role/seed/IsisExtH2ConsoleRoleAndPermissions.adoc
@@ -9,6 +9,7 @@ Access to the h2 console UI.
.IsisExtH2ConsoleRoleAndPermissions.java
----
class IsisExtH2ConsoleRoleAndPermissions {
+ public static final String NAMESPACE;
public static final String ROLE_NAME;
IsisExtH2ConsoleRoleAndPermissions()
}
diff --git a/antora/components/refguide-index/modules/viewer/pages/index/wicket/viewer/IsisModuleViewerWicketViewer.adoc b/antora/components/refguide-index/modules/viewer/pages/index/wicket/viewer/IsisModuleViewerWicketViewer.adoc
index 76be0ed..08310f8 100644
--- a/antora/components/refguide-index/modules/viewer/pages/index/wicket/viewer/IsisModuleViewerWicketViewer.adoc
+++ b/antora/components/refguide-index/modules/viewer/pages/index/wicket/viewer/IsisModuleViewerWicketViewer.adoc
@@ -7,6 +7,7 @@
.IsisModuleViewerWicketViewer.java
----
class IsisModuleViewerWicketViewer {
+ public static final String NAMESPACE;
}
----