incubator-isis-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From danhayw...@apache.org
Subject svn commit: r1050155 - in /incubator/isis/trunk/core: commons/src/site/apt/ metamodel/src/site/apt/ progmodel/src/site/apt/ runtime/src/site/apt/ src/site/apt/ testsupport/src/site/apt/ webapp/src/site/apt/ webserver/src/site/apt/
Date Thu, 16 Dec 2010 20:53:33 GMT
Author: danhaywood
Date: Thu Dec 16 20:53:32 2010
New Revision: 1050155

URL: http://svn.apache.org/viewvc?rev=1050155&view=rev
Log:
APT docs for core module (ISIS-22)

Modified:
    incubator/isis/trunk/core/commons/src/site/apt/index.apt
    incubator/isis/trunk/core/metamodel/src/site/apt/index.apt
    incubator/isis/trunk/core/progmodel/src/site/apt/index.apt
    incubator/isis/trunk/core/runtime/src/site/apt/index.apt
    incubator/isis/trunk/core/src/site/apt/index.apt
    incubator/isis/trunk/core/testsupport/src/site/apt/index.apt
    incubator/isis/trunk/core/webapp/src/site/apt/index.apt
    incubator/isis/trunk/core/webserver/src/site/apt/index.apt

Modified: incubator/isis/trunk/core/commons/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/incubator/isis/trunk/core/commons/src/site/apt/index.apt?rev=1050155&r1=1050154&r2=1050155&view=diff
==============================================================================
--- incubator/isis/trunk/core/commons/src/site/apt/index.apt (original)
+++ incubator/isis/trunk/core/commons/src/site/apt/index.apt Thu Dec 16 20:53:32 2010
@@ -19,5 +19,24 @@
 
 Commons
 
- Common utilities, language extensions, and defines a component architecture.
+ The <core commons> module provides a set of common utilities and language 
+ extensions for use across the rest of the framework.
+ 
+ It also defines a number of small APIs that are used throughout:
+ 
+ * a set of interfaces for defining <<<Component>>>s and their scope
+ 
+ * a debug framework
+ 
+ * an <<<Ensure>>> API
+ 
+ * a set of {{{http://code.google.com/p/hamcrest}Hamcrest}} <<<Matcher>>>s
+ 
+ * a <<<ResourceStream>>> API  
+ 
+ * a <<<Filter>>> API
+ 
+ * a <<<Future>>> API
+
+ []
  

Modified: incubator/isis/trunk/core/metamodel/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/incubator/isis/trunk/core/metamodel/src/site/apt/index.apt?rev=1050155&r1=1050154&r2=1050155&view=diff
==============================================================================
--- incubator/isis/trunk/core/metamodel/src/site/apt/index.apt (original)
+++ incubator/isis/trunk/core/metamodel/src/site/apt/index.apt Thu Dec 16 20:53:32 2010
@@ -19,5 +19,27 @@
 
 MetaModel
 
- Defines a metamodel API and an extensible and customizable implementation.
+ The <core metamodel> module defines the interfaces and classes that make 
+ up the <Apache Isis> metamodel.  
  
+ The metamodel is used in numerous ways, including:
+ 
+ * by {{{../../viewer/index.html}viewers}} to obtain information about the 
+   domain objects, so that they can be rendered in a generic object-oriented 
+   user interface;
+   
+ * by object stores (the {{{../../defaults/objectstore/index.html}default}} and
+   some of the {{{../../alternatives/objectstore/index.html}alternatives}})
+   to determine which data is to be persisted;
+   
+ * by {{{../../alternatives/remoting/index.html}remoting}}, to marshall
+   domain objects automatically between different tiers; 
+ 
+ * by the {{{../runtime/index.html}core runtime}}, to provide the ability to provide
+   XML Snapshots (through the <<<XmlSnapshot>>> utility class).
+ 
+ []
+ 
+ The <metamodel> module does not itself define the programming model 
+ conventions; that is the responsibility of the 
+ {{{../progmodel/index.html}core progmodel}}.

Modified: incubator/isis/trunk/core/progmodel/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/incubator/isis/trunk/core/progmodel/src/site/apt/index.apt?rev=1050155&r1=1050154&r2=1050155&view=diff
==============================================================================
--- incubator/isis/trunk/core/progmodel/src/site/apt/index.apt (original)
+++ incubator/isis/trunk/core/progmodel/src/site/apt/index.apt Thu Dec 16 20:53:32 2010
@@ -19,5 +19,14 @@
 
 ProgModel
 
- Defines facets of programming model, that can be reused across any programming model definition.
+ The <core progmodel> provides a set of reusable elements (implementations of
+ the <<<FacetFactory>>> API) that can be reused to make up a programming
model.
+ 
+ Most of those within <this> module are in fact used in the
+ default programming model, defined by the 
+ {{{../../defaults/progmodel/index.html}default progmodel}} module.  They are
+ defined within core, however, to allow custom programming models (perhaps
+ extending or trimming back the default programming model) to be defined.
+ 
+ 
  

Modified: incubator/isis/trunk/core/runtime/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/incubator/isis/trunk/core/runtime/src/site/apt/index.apt?rev=1050155&r1=1050154&r2=1050155&view=diff
==============================================================================
--- incubator/isis/trunk/core/runtime/src/site/apt/index.apt (original)
+++ incubator/isis/trunk/core/runtime/src/site/apt/index.apt Thu Dec 16 20:53:32 2010
@@ -15,13 +15,26 @@
 ~~  specific language governing permissions and limitations
 ~~  under the License.
 
-
-
 Runtime
  
- The <runtime> model has the code which is used to manage the domain objects at runtime.
- Each pojo is wrapped in an adapter (cf <<<java.lang.Object>>>) from which
the
- object specification (cf <<<java.lang.Class>>>) can be obtained.
+ The <runtime> module is the "engine-room" of the framework, taking 
+ responsibility to manage domain object (pojo) instances at runtime.
+
+ Each pojo is wrapped in an <<<ObjectAdapter>>> (cf <<<java.lang.Object>>>)

+ from which the <<<ObjectSpecification>>> (cf <<<java.lang.Class>>>)
can be 
+ obtained.  Associated with each <<<ObjectAdapter>>> is an <<<Oid>>>:
an
+ opaque serializable identifier to the object.  The <runtime> module maintains 
+ a 3-way {{{http://martinfowler.com/eaaCatalog/identityMap.html}identity map}} 
+ between these, allowing forward and reverse lookups. 
+ 
+ The <runtime> module defines a number of APIs the most important of which is 
+ the <<<ObjectStore>>> API.  The <runtime> module manages persistence

+ and transaction demarcation, with the actual storage of objects being 
+ delegated to an object store implementation.
+
+ The other major API defined by the <runtime> module security API, dealing with
+ authentication and authorization.  
  
- The <runtime> also manages persistence and transactions, with the actual
- persistence being delegated to an object store.
+ In addition to all the above, the <runtime> module defines a command-line 
+ bootstrapper, making it easy to bootstrap <Apache Isis> from a main() or a 
+ JUnit test case.

Modified: incubator/isis/trunk/core/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/incubator/isis/trunk/core/src/site/apt/index.apt?rev=1050155&r1=1050154&r2=1050155&view=diff
==============================================================================
--- incubator/isis/trunk/core/src/site/apt/index.apt (original)
+++ incubator/isis/trunk/core/src/site/apt/index.apt Thu Dec 16 20:53:32 2010
@@ -19,30 +19,39 @@
 
 Core Framework
  
-  The <core> module is the parent of a set of submodules that collectively form the
core of Apache Isis.
+  The <core> module is the parent of a set of submodules that collectively 
+  form the core of Apache Isis.
   Specifically, they provide:
+
+  * {{{./commons/index.html}common}} utilities
  
-  * metamodel
+  * a {{{./metamodel/index.html}metamodel}} for domain models
+
+  * reusable {{{./progmodel/index.html}programming model}} elements
 
-  * reusable programming model elements
+  * {{{./runtime/index.html}runtime}} instance management and persistence
 
-  * runtime instance management
+  * reusable components for {{{./webapp/index.html}webapp}}-based viewers
   
-  * bootstrapping/deployment support for commandline or webapp
+  * {{{./webserver/index.html}bootstrapping}} support for webapp-based viewers
   
-  * JUnit/JMock testing support
+  * JUnit/JMock {{{./testsupport/index.html}testing support}}
 
   []
   
-  Across these modules a number of APIs are defined, each of which have {{{../default/index.html}default}}

-  and {{{../alternatives.html}alternative}} implementations:  
+  Across these modules a number of APIs are defined, each of which have 
+  {{{../defaults/index.html}default}} and 
+  {{{../alternatives/index.html}alternative}} implementations:  
   
-  * persistence (object store API)
+  * persistence (object store API) ({{{../defaults/objectstore/index.html}default}} and {{{../alternatives/objectstore/index.html}alternatives}})
 
+
+  * user preferences (profile store API) ({{{../defaults/profilestore/index.html}default}}
and {{{../alternatives/profilestore/index.html}alternatives}})
   
-  * bytecode enhancement
+  * bytecode enhancement ({{{../defaults/bytecode/index.html}default}} and {{{../alternatives/bytecode/index.html}alternatives}})
    
-  * security (authentication and authorization)
+  * security (authentication and authorization) ({{{../defaults/security/index.html}default}}
and {{{../alternatives/security/index.html}alternatives}})
    
-  * programming model definition
+  * programming model definition ({{{../defaults/progmodel/index.html}default}} and {{{../alternatives/progmodel/index.html}alternatives}})
+
    
   []
\ No newline at end of file

Modified: incubator/isis/trunk/core/testsupport/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/incubator/isis/trunk/core/testsupport/src/site/apt/index.apt?rev=1050155&r1=1050154&r2=1050155&view=diff
==============================================================================
--- incubator/isis/trunk/core/testsupport/src/site/apt/index.apt (original)
+++ incubator/isis/trunk/core/testsupport/src/site/apt/index.apt Thu Dec 16 20:53:32 2010
@@ -21,4 +21,5 @@ Test Support
  
  The <testsupport> module holds helper classes to support writing unit
  tests in either {{{http://junit.org}JUnit}} or {{{http://jmock.org}JMock}}.
+ 
  It should only ever be added as a dependency with a <<<scope>>> of <test>.

Modified: incubator/isis/trunk/core/webapp/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/incubator/isis/trunk/core/webapp/src/site/apt/index.apt?rev=1050155&r1=1050154&r2=1050155&view=diff
==============================================================================
--- incubator/isis/trunk/core/webapp/src/site/apt/index.apt (original)
+++ incubator/isis/trunk/core/webapp/src/site/apt/index.apt Thu Dec 16 20:53:32 2010
@@ -19,7 +19,26 @@
 
 WebApp Support
  
- The <webapp> module provides servlet and filter implementations to allow the
- runtime to be hosted within a webapp.
+ The <webapp> module is a small module that provides reusable servlet context 
+ listeners and filters to webapp viewers.  They include:
+ 
+ * <<<IsisWebAppBootstrapper>>> which is a servlet context listener to
bootstrap
+   an Isis runtime and bind to the servlet context
+
+ * <<<IsisSessionFilter>>> which is a filter used to
+   creating an <<<IsisSession>>> for each request (the 
+   {{{http://community.jboss.org/wiki/OpenSessioninView}Open session in View}}
+    pattern)
 
- It generally isn't required until deployment time.
\ No newline at end of file
+ * <<<ResourceServlet>>> which serves up static content from the specified
+   resource
+   
+ * <<<StaticContentFilter>>> which decorates static content with headers
for
+   caching    
+ 
+ []
+ 
+ Not every webapp-based viewer is required to use these classes; refer to their
+ documentation for exact details of what should reside in the <<<web.xml>>>.
+ 
+ 
\ No newline at end of file

Modified: incubator/isis/trunk/core/webserver/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/incubator/isis/trunk/core/webserver/src/site/apt/index.apt?rev=1050155&r1=1050154&r2=1050155&view=diff
==============================================================================
--- incubator/isis/trunk/core/webserver/src/site/apt/index.apt (original)
+++ incubator/isis/trunk/core/webserver/src/site/apt/index.apt Thu Dec 16 20:53:32 2010
@@ -16,19 +16,18 @@
 ~~  under the License.
 
 
-
 WebServer (Jetty)
  
- The <webserver> module bundles up {{{http://jetty.codehaus.org/jetty/}Jetty}} to make
it easy to any application that's
- in webapp format.
+ The <webserver> module is intended to make it easy to run webapp-based viewers,
+ using the webapp as defined in <<<src/main/webapp/WEB-INF/web.xml>>>.
  
- There are a couple of use cases:
+ This is a useful facility to have during development, but is not (expected to 
+ be) needed for deployment.   
  
- * if using the {{{../webapp/index.html}webapp}} module to deploy your application
-   as a webapp, then you can check that your deployment runs ok an on webserver
-   
- * if using a viewer that does not use the <webapp> module but instead defines
-   has its own web app structure in <<<WEB-INF/web.xml>>> then again you
can use 
-   <webserver> to run your web application.  
+ In essence all the module does is to bundle up 
+ {{{http://jetty.codehaus.org/jetty/}Jetty}}.  An alternative would be to 
+ use <<<mvn jetty:run>>>; this module is for when you'd rather just run
a
+ standalone program (ie, with a <<<main()>>> in it) without the overhead
of
+ Maven.
    
  [] 



Mime
View raw message