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 2014/02/14 09:20:09 UTC
svn commit: r1568215 - in /isis/site/trunk/content: documentation.md
more-advanced-topics/deployment-type.md reference/deployment-type.md
reference/services/developer-utilities-service.md
reference/services/memento-service.md
Author: danhaywood
Date: Fri Feb 14 08:20:08 2014
New Revision: 1568215
URL: http://svn.apache.org/r1568215
Log:
updating docs for developer utilities, moved deployment-type to reference
Added:
isis/site/trunk/content/reference/deployment-type.md
- copied unchanged from r1566886, isis/site/trunk/content/more-advanced-topics/deployment-type.md
Removed:
isis/site/trunk/content/more-advanced-topics/deployment-type.md
Modified:
isis/site/trunk/content/documentation.md
isis/site/trunk/content/reference/services/developer-utilities-service.md
isis/site/trunk/content/reference/services/memento-service.md
Modified: isis/site/trunk/content/documentation.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/documentation.md?rev=1568215&r1=1568214&r2=1568215&view=diff
==============================================================================
--- isis/site/trunk/content/documentation.md (original)
+++ isis/site/trunk/content/documentation.md Fri Feb 14 08:20:08 2014
@@ -160,7 +160,6 @@ For both:
#### Prototyping tips
-* [Deployment Types](more-advanced-topics/deployment-type.html)
* [Fixtures](./more-advanced-topics/03-Fixtures-and-SwitchUser.html)
* [Generic repository](./more-advanced-topics/how-to-09-030-How-to-use-a-generic-repository.html)
@@ -329,6 +328,7 @@ For both:
#### Reference
+* [Deployment Types](./reference/deployment-type.html)
* [Recognized Methods](./reference/Recognized-Methods-and-Prefixes.html)
* [Annotations](./reference/recognized-annotations/about.html)
* [Lifecycle callbacks](./reference/object-lifecycle-callbacks.html)
Modified: isis/site/trunk/content/reference/services/developer-utilities-service.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/reference/services/developer-utilities-service.md?rev=1568215&r1=1568214&r2=1568215&view=diff
==============================================================================
--- isis/site/trunk/content/reference/services/developer-utilities-service.md (original)
+++ isis/site/trunk/content/reference/services/developer-utilities-service.md Fri Feb 14 08:20:08 2014
@@ -1,31 +1,61 @@
Title: Developer Utilities Service
-The `DeveloperUtilitiesService` service is intended to make the developer's job easier in a number of aspects:
+The `DeveloperUtilitiesService` service provides a number of development-time utilities, mostly related to accessing/interacting with the Isis metamodel. These are visible in the UI, either as menu actions or as contributed actions. All actions are annotated with [@Prototype](../recognized-annotations/Prototype.html), so are suppressed in [production mode](../deployment-type.html).
-* using the `downloadMetaModel()` action, the developer can download a CSV spreadsheet of the Isis metamodel.
+
+###API
+
+The API defined by `DeveloperUtilitiesService` (some annotations omitted) is:
+
+ public interface DeveloperUtilitiesService {
+
+ public Clob downloadMetaModel();
+
+ public Blob downloadLayouts();
+
+ // new in 1.4.0-SNAPSHOT
+ public void refreshServices();
+
+ @NotInServiceMenu
+ public Clob downloadLayout(Object domainObject);
+
+ @Deprecated // in 1.4.0-SNAPSHOT
+ @Hidden // in 1.4.0-SNAPSHOT
+ @NotInServiceMenu
+ public Object refreshLayout(Object domainObject);
+ }
+
+where:
+
+* `downloadMetaModel()` allows the developer to download a CSV spreadsheet of the Isis metamodel.
- This allows the developer to review the metadata that has Isis has captured about each domain type: for example whether a business rule (hide/disable/validate) has been implemented for each member (also indicating the implementation)
+ The developer can then review the metadata that has Isis has captured about each domain type: for example whether a business rule (hide/disable/validate) has been implemented for each member (also indicating the implementation)
-* using the `downloadLayouts()` action, the developer can download a ZIP file of `Xxx.layout.json` files for each domain type in the Isis metamodel.
+* `downloadLayouts()` allows the developer can download a ZIP file of `Xxx.layout.json` files for each domain type in the Isis metamodel.
This is useful if converting a domain model to use [dynamic layouts](../../more-advanced-topics/dynamic-layouts.html).
-* using the `downloadLayout()` contributed action, the developer can download the `Xxx.layout.json` for an individual object
+* `downloadLayout()` (contributed action) allows the developer can download the `Xxx.layout.json` for an individual object
+
+* `refreshServices()` allows the developer to rebuild the Isis metamodel of all domain services. This is particularly useful for picking up changes to [contributed actions](../more-advanced-topics/how-to-01-062-How-to-decouple-dependencies-using-contributions.html)
-* using the `refreshLayout()` contributed action, the developer can reload the current object. The metamodel will be rebuilt and the object's layout may change accordingly.
-
- > (If using the [Wicket viewer](../../components/viewers/wicket/about.html)) it is necessary to invoke `refreshLayout()` *twice*. This is to do with the relationship between the point at which the metamodel being invalidated, and the point the Wicket viewer builds up its UI.
-
-All of the above actions are annotated as `@Prototype`; they will therefore not appear in a running production application.
+* `refreshLayout()` (contributed action) allows the developer to rebuild the Isis metamodel of the current object. The object's layout may change accordingly.
+
+ In 1.4.0-SNAPSHOT this action has been deprecated because the [Wicket viewer](../../components/viewers/wicket/about.html)), when running in protoype mode, automatically does this.
+
+
+###Implementations
+
+The core framework provides a default implementation of this API:
+* `org.apache.isis.core.metamodel.services.devutils.DeveloperUtilitiesServiceDefault`
+
### Register the Service
The service is registered, like any other, in `isis.properties`:
-<pre>
-isis.services=<i>...other services...</i>,\
- org.apache.isis.core.metamodel.services.devutils.DeveloperUtilitiesServiceDefault,\
- ...
-</pre>
+ isis.services=...,\
+ org.apache.isis.core.metamodel.services.devutils.DeveloperUtilitiesServiceDefault,\
+ ...
Modified: isis/site/trunk/content/reference/services/memento-service.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/reference/services/memento-service.md?rev=1568215&r1=1568214&r2=1568215&view=diff
==============================================================================
--- isis/site/trunk/content/reference/services/memento-service.md (original)
+++ isis/site/trunk/content/reference/services/memento-service.md Fri Feb 14 08:20:08 2014
@@ -72,7 +72,7 @@ However, you are of course free to write
### Register the Service
-Register this service like any other service, in `isis.properties`, eg:
+The service is registered, like any other, in `isis.properties`:
isis.services=...,\
org.apache.isis.core.runtime.services.memento.MementoServiceDefault,\