You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@avalon.apache.org by do...@apache.org on 2002/11/13 04:19:31 UTC
cvs commit: jakarta-avalon-excalibur/info/src/java/org/apache/avalon/framework/tools/infobuilder package.html
donaldp 2002/11/12 19:19:31
Modified: info/src/java/org/apache/avalon/framework/tools/infobuilder
package.html
Log:
decruft description
Revision Changes Path
1.2 +3 -159 jakarta-avalon-excalibur/info/src/java/org/apache/avalon/framework/tools/infobuilder/package.html
Index: package.html
===================================================================
RCS file: /home/cvs/jakarta-avalon-excalibur/info/src/java/org/apache/avalon/framework/tools/infobuilder/package.html,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- package.html 31 Aug 2002 08:17:01 -0000 1.1
+++ package.html 13 Nov 2002 03:19:31 -0000 1.2
@@ -1,162 +1,6 @@
<html><body>
-<p>Component information builder that handels internalization of an component type description supplied as a configuration instance.</P>
-
-<h3>Package Structure (UML)</h3>
-<p><img src=doc-files/ComponentInfoBuilder.gif border=0></p>
-
-<a name="external"><h3>External Form (XML)</h3></a>
-<p>Configuration instances supplied to the builder shall correspond to the <a href="http://home.osm.net/componentinfo.dtd">component-info DTD</a>.
-The structure of a component-info XML document is is described below:</p>
-
-<pre>
-
-<font color="gray"><i><!--
-Example of a component meta info external XML form.
-The element contains the information required to construct an instance of
-org.apache.excalibur.containerkit.metainfo.ComponentInfo. It includes
-information about the component type, the service it provides, and the
-services it is dependent on.
---></i></font>
-
-<component-info>
-
-
- <font color="gray"><i><!--
- Defintion of a single component descriptor.
- --></i></font>
-
- <component>
-
- <font color="gray"><i><!-- the name of the component (character restriction appply) --></i></font>
-
- <name><font color="darkred">my-component</font></name>
-
- <font color="gray"><i><!-- the implementation version --></i></font>
-
- <version></strong><font color="darkred">1.2.1</font></version>
-
- <font color="gray"><i><!-- the set of attribibutes associated with the type
- (attribute names and values are examples only) --></i></font>
-
- <attributes>
-
- <attribute key="<font color="darkred">avalon:display-name-i18n</font>" value="<font color="darkred">display-name</font>"/>
- <attribute key="<font color="darkred">avalon:lifestyle</font>" value="<font color="darkred">THREAD_SAFE</font>"/>
-
- </attributes>
-
- </component>
-
- <font color="gray"><i><!--
- Declaration of the context constraints for the component type.
- The "type" attribute is the name of an interface derived from the default
- contenxt interface org.apache.avalon.framework.context.Context
- --></i></font>
-
- <context type="<font color="darkred">MyContextInterface</font>">
-
- <font color="gray"><i><!--
- Declaration of an entry in a context object, the "key" is
- the key used by a component to locate the context entry,
- the "type" is the classname of value (typically an interface)
- or primative type. The default value is java.lang.String.
- The "optional" attribute is a boolean value derived from the
- TRUE or FALSE that indicates if the context value must be
- provided or not (default is FALSE).
- --></i></font>
-
- <entry key="<font color="darkred">base</font>" type="<font color="darkred">java.io.File</font>"/>
- <entry key="<font color="darkred">mode</font>" optional="<font color="darkred">TRUE</font>"/>
-
- </context>
-
- <font color="gray"><i><!--
- Declaration of the set of services that this component is capable
- of supplying. Each service declarared under the services element
- may be referenced by other component info descriptions as a
- dependecy. A container is responsible for the assemably of
- components based on the connection of supply components to
- consumer components via a common service description.
- --></i></font>
-
- <services>
-
- <font color="gray"><i><!--
- The service type is the classname of an interface and the
- version identifier qualifes the interface version. The
- default version value is 1.0.
- --></i></font>
-
- <service>
-
- <service-ref type="<font color="darkred">SimpleService</font>" version="<font color="darkred">3.2</font>">
-
- <attributes>
-
- <font color="gray"><i><!--
- Service type attributes go here.
- Need some relevant examples.
- --></i></font>
-
- </attributes>
-
- </service>
-
- </services>
-
-
- <font color="gray"><i><!--
- Declaration of the set of dependecies that this component type has on
- component suppliers. Dependency declarations define the role name
- that the component will use to access a service via a service
- or component manager. The service element identifies a service
- descriptor that is publised by a potential supplier component.
- A dependecy may be declared as optional by setting the optional
- attribute value to TRUE. The default value for optional is FALSE.
- --></i></font>
-
- <dependencies>
-
- <font color="gray"><i><!--
- A dependecy declaration. In the following example the optional
- attribute is redundant as it is equivalent to the default value
- but is included here for completness.
- --></i></font>
-
- <dependency optional="<font color="darkred">FALSE</font>">
-
- <font color="gray"><i><!--
- The role name that the component will use as the argument to
- lookup. The default value is the value of the service type
- attribute listed below.
- --></i></font>
-
- <role><font color="darkred">my-transformer</font></role>
-
- <font color="gray"><i><!--
- service reference containing the classname of the service interface
- and the version value where version defaults to 1.0
- --></i></font>
-
- <service-ref type="<font color="darkred">org.apache.cocoon.api.Transformer</font>" version="<font color="darkred">1.1</font>"/>
-
- <font color="gray"><i><!-- the set of attributes associated with the dependecy --></i></font>
-
- <attributes>
-
- <font color="gray"><i><!--
- Service type constraints go here.
- Need some relevant examples.
- --></i></font>
-
- </attributes>
-
- </dependency>
-
- </dependencies>
-
-</component-info>
-
-</pre>
+<p>A set of classes that supports the reading and writing of Info meta
+data objects in various formats (currently supports xml and serialized
+objects).</P>
</body></html>
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>