atom feed142 messages in org.apache.cocoon.devRe: Public/Private classification (wa...
FromSent OnAttachments
75 earlier messages
Daniel FagerstromOct 4, 2005 3:01 am 
Andrew SavoryOct 4, 2005 3:13 am 
UpayaviraOct 4, 2005 3:17 am 
Bertrand DelacretazOct 4, 2005 3:29 am 
Steven NoelsOct 4, 2005 3:39 am 
Torsten CurdtOct 4, 2005 3:47 am 
hepaboluOct 4, 2005 4:00 am 
Joerg HeinickeOct 4, 2005 4:39 am 
Sylvain WallezOct 4, 2005 4:57 am 
Daniel FagerstromOct 4, 2005 5:48 am 
Arje CahnOct 4, 2005 5:55 am 
Stefano MazzocchiOct 4, 2005 9:08 am 
Sylvain WallezOct 4, 2005 9:24 am 
Carsten ZiegelerOct 4, 2005 12:43 pm 
Steven NoelsOct 5, 2005 3:57 am 
Carsten ZiegelerOct 10, 2005 5:02 am 
Joerg HeinickeOct 11, 2005 2:03 pm 
Vadim GritsenkoOct 11, 2005 8:01 pm 
Stefano MazzocchiOct 11, 2005 8:16 pm 
Vadim GritsenkoOct 11, 2005 8:35 pm 
Bertrand DelacretazOct 11, 2005 11:20 pm 
Max PfingsthornOct 12, 2005 12:31 am 
Torsten CurdtOct 12, 2005 12:32 am 
Bertrand DelacretazOct 12, 2005 12:58 am 
Sylvain WallezOct 12, 2005 1:34 am 
Carsten ZiegelerOct 12, 2005 2:21 am 
Daniel FagerstromOct 12, 2005 4:52 am 
Stefano MazzocchiOct 12, 2005 8:58 am 
Stefano MazzocchiOct 12, 2005 9:01 am 
UpayaviraOct 12, 2005 9:20 am 
Vadim GritsenkoOct 12, 2005 9:38 am 
Stefano MazzocchiOct 12, 2005 9:47 am 
Niclas HedhmanOct 12, 2005 10:04 am 
UpayaviraOct 12, 2005 11:57 am 
hepaboluOct 12, 2005 12:43 pm 
Stefano MazzocchiOct 12, 2005 2:09 pm 
Stefano MazzocchiOct 12, 2005 2:18 pm 
Stefano MazzocchiOct 12, 2005 2:20 pm 
Sylvain WallezOct 12, 2005 2:35 pm 
Vadim GritsenkoOct 12, 2005 2:47 pm 
Daniel FagerstromOct 13, 2005 2:41 am 
Reinhard PoetzOct 13, 2005 3:25 am 
Vadim GritsenkoOct 13, 2005 8:07 am 
Ralph GoersOct 13, 2005 9:14 am 
Vadim GritsenkoOct 13, 2005 9:22 am 
Ralph GoersOct 13, 2005 9:44 am 
Daniel FagerstromOct 13, 2005 9:56 am 
Stefano MazzocchiOct 13, 2005 10:01 am 
Stefano MazzocchiOct 13, 2005 10:05 am 
Daniel FagerstromOct 13, 2005 1:59 pm 
Joerg HeinickeOct 13, 2005 2:03 pm 
Joerg HeinickeOct 13, 2005 2:05 pm 
Stefano MazzocchiOct 13, 2005 3:25 pm 
Reinhard PoetzOct 13, 2005 10:57 pm 
Daniel FagerstromOct 14, 2005 2:05 am 
Vadim GritsenkoOct 14, 2005 6:01 am 
Vadim GritsenkoOct 14, 2005 6:06 am 
Stefano MazzocchiOct 14, 2005 11:34 am 
Vadim GritsenkoOct 14, 2005 11:45 am 
Reinhard PoetzOct 15, 2005 1:38 am 
Joerg HeinickeOct 15, 2005 1:40 am 
Joerg HeinickeOct 15, 2005 1:45 am 
Stefano MazzocchiOct 15, 2005 8:53 am 
Stefano MazzocchiOct 15, 2005 9:08 am 
Peter HunsbergerOct 21, 2005 10:12 pm 
Stefano MazzocchiOct 23, 2005 10:39 am 
Peter HunsbergerOct 24, 2005 8:05 am 
Subject:Re: Public/Private classification (was Re: javadocs navigation)
From:Daniel Fagerstrom (dani@nada.kth.se)
Date:Oct 13, 2005 1:59:21 pm
List:org.apache.cocoon.dev

Daniel Fagerstrom wrote: ...

To illustrate what I meant I tried to follow the dependencies for the sitemap component interfaces.

Cocoon API ==========

...

So what is the Cocoon API? All interfaces used in cocoon-core-sitemap.xconf are part of the Cocoon API: Generator, Transformer, Serializer, Reader, Matcher, Selector, Action, ProcessingPipeline. Then the interfaces refered to in the Cocoon API must be part of the API as well by transitive closure. So here we get various exceptions, SitemapModelComponent, XMLPipe, XMLProducer and much more. The ObjectModelHelper with dependencies is also part of the API.

Starting with:

org.apache.cocoon.acting.Action org.apache.cocoon.generation.Generator org.apache.cocoon.matching.Matcher org.apache.cocoon.reading.Reader org.apache.cocoon.selection.Selector org.apache.cocoon.serialization.Serializer org.apache.cocoon.transformation.Transformer

(I removed the ProcessingPipeline as it dependencies seem to explode to all kinds of internal classes, we need to polish that interface if it should be considered public)

These interfaces depends on:

org.apache.avalon.framework.parameters.Parameters org.apache.cocoon.ProcessingException org.apache.cocoon.environment.Redirector org.apache.cocoon.environment.SourceResolver org.apache.cocoon.sitemap.SitemapModelComponent org.apache.cocoon.sitemap.SitemapOutputComponent org.apache.cocoon.sitemap.PatternException org.apache.cocoon.xml.XMLConsumer org.apache.cocoon.xml.XMLPipe org.apache.cocoon.xml.XMLProducer

which depends on (skipping the avalon dependencies)

org.apache.avalon.framework.CascadingException org.apache.cocoon.util.location.LocatedException (org.apache.cocoon.util.location.LocatedRuntimeException) org.apache.cocoon.util.location.Location org.apache.cocoon.util.location.MultiLocatable

and again

org.apache.cocoon.util.location.Locatable org.apache.cocoon.util.location.LocatableException org.apache.cocoon.util.location.LocationImpl org.apache.cocoon.util.location.LocationUtils org.apache.commons.lang.exception.NestableException org.apache.commons.lang.exception.ExceptionUtils

===

The object model helper must also be considered to be part of the Cocoon API, there we get the dependencies:

org.apache.cocoon.environment.ObjectModelHelper

-->

org.apache.cocoon.environment.Context org.apache.cocoon.environment.Request org.apache.cocoon.environment.Response

-->

org.apache.cocoon.environment.Cookie org.apache.cocoon.environment.Session

===

This should be a complete list of the public sitemap component API (I did the dependency analysis semi automatically with http://depfind.sourceforge.net/, so I could have done some mistakes).

===

A similar list for the public component API, starting from cocoon-core.xconf would also be a good idea. But I would need a better tool than depfind for that excercise, any suggestions?

===

I'm not suggesting that we can find out the Cocoon API automatically. But given that we want a particular set of interfaces in the public API and JavaDoc, I think it would be rather strange if we didn't made all the o.a.c interfaces and classes that these interfaces depends on also part of the public API.

/Daniel