framework/bundles/org.eclipse.ecf/schema/containerFactory.exsd - ecf/org.eclipse.ecf - Git at Google

 <?xml version='1.0' encoding='UTF-8'?>
 <!-- Schema file written by PDE -->
 <schema targetNamespace="org.eclipse.ecf">
 <annotation>
       <appInfo>
          <meta.schema plugin="org.eclipse.ecf" id="containerFactory" name="ECF Container Factory"/>
       </appInfo>
       <documentation>
          This extension allows plugins to register themselves as &apos;providers&apos; of ECF containers.  Once registered via this extension point, plugins can then provide there own implementations of  IContainer in response to client request of the ECF container factory (&lt;b&gt;org.eclipse.ecf.core.ContainerFactory&lt;/b&gt;).
 &lt;p&gt;Plugins using this extension point can define a new implementation of any desired communications protocol, and expose that protocol as an instance of an &lt;b&gt;IContainer&lt;/b&gt;.  When client requests are made to ECF ContainerFactory to create &lt;b&gt;IContainer&lt;/b&gt; instances, those requests will be re-directed to the given IContainer implementer.
       </documentation>
    </annotation>

    <element name="extension">
       <complexType>
          <sequence>
             <element ref="containerFactory" minOccurs="1" maxOccurs="unbounded"/>
          </sequence>
          <attribute name="point" type="string" use="required">
             <annotation>
                <documentation>

                </documentation>
             </annotation>
          </attribute>
          <attribute name="id" type="string">
             <annotation>
                <documentation>

                </documentation>
             </annotation>
          </attribute>
          <attribute name="name" type="string">
             <annotation>
                <documentation>

                </documentation>
             </annotation>
          </attribute>
       </complexType>
    </element>

    <element name="containerFactory">
       <annotation>
          <documentation>
             The container factory extension point.  Can optionally contain a list of &apos;defaultargument&apos; elements that describe the arguments (and provide default values) to be passed to provider implementation
          </documentation>
       </annotation>
       <complexType>
          <sequence>
             <element ref="defaultargument" minOccurs="0" maxOccurs="unbounded"/>
             <element ref="property" minOccurs="0" maxOccurs="unbounded"/>
          </sequence>
          <attribute name="class" type="string" use="required">
             <annotation>
                <documentation>
                   The class implementing the containerFactory extension point.  The given class must implement the &lt;b&gt;org.eclipse.ecf.core.provider.IContainerInstantiator&lt;/b&gt; interface
                </documentation>
                <appInfo>
                   <meta.attribute kind="java"/>
                </appInfo>
             </annotation>
          </attribute>
          <attribute name="name" type="string">
             <annotation>
                <documentation>
                   An optional name for the extension.  If no name is explicitly provided by the extension, the containerFactory class name is used as the name.  Note that this name must &lt;b&gt;not&lt;/b&gt; conflict with any other name in the ECF SharedFactory in order to be successfully registered.  Care should therefore be taken in selection of a name such that it does not conflict with other pre-existing names for this factory implementations
                </documentation>
             </annotation>
          </attribute>
          <attribute name="description" type="string">
             <annotation>
                <documentation>

                </documentation>
             </annotation>
          </attribute>
       </complexType>
    </element>

    <element name="defaultargument">
       <annotation>
          <documentation>
             Default argument to be passed to &lt;b&gt;org.eclipse.ecf.core.provider.IContainerInstantiator.createInstance()&lt;/b&gt; method.  Value of this element (if any) is used to indicate a default value for the given argument
          </documentation>
       </annotation>
       <complexType>
          <attribute name="value" type="string">
             <annotation>
                <documentation>
                   The value for the default argument
                </documentation>
             </annotation>
          </attribute>
       </complexType>
    </element>

    <element name="property">
       <annotation>
          <documentation>
             Property (name,value) associated with SharedDescription
          </documentation>
       </annotation>
       <complexType>
          <attribute name="name" type="string" use="required">
             <annotation>
                <documentation>
                   The name of the property
                </documentation>
             </annotation>
          </attribute>
          <attribute name="value" type="string" use="required">
             <annotation>
                <documentation>
                   The value of the property
                </documentation>
             </annotation>
          </attribute>
       </complexType>
    </element>

    <annotation>
       <appInfo>
          <meta.section type="since"/>
       </appInfo>
       <documentation>
          0.0.1
       </documentation>
    </annotation>

    <annotation>
       <appInfo>
          <meta.section type="examples"/>
       </appInfo>
       <documentation>
          Here&apos;s an extension that associates a class org.eclipse.ecf.test.FooContainerFactory with name &apos;foo&apos; in the ECF &lt;b&gt;ContainerFactory&lt;/b&gt;:

 &lt;pre&gt;
 &lt;extension point=&quot;org.eclipse.ecf.containerFactory&quot;&gt;
     &lt;containerFactory name=&quot;foo&quot; class=&quot;org.eclipse.ecf.test.FooInstantiator&quot; description=&quot;My container factory&quot;/&gt;
     &lt;defaultargument type=&quot;java.lang.String&quot; value=&quot;defaultvalue&quot; name=&quot;variablename&quot;/&gt;
 &lt;/extension&gt;
 &lt;/pre&gt;

 Here is some example code to implement this class:

 &lt;pre&gt;
 package org.eclipse.ecf.test;

 import org.eclipse.ecf.core.IContainer;
 import org.eclipse.ecf.core.ContainerInstantiationException;
 import org.eclipse.ecf.core.provider.IContainerInstantiator;

 public class FooInstantiator implements IContainerInstantiator {

     public FooInstantiator() {
         super();
     }
     public IContainer createInstance(ContainerTypeDescription description, Class[] argTypes, Object[] args)
             throws ContainerInstantiationException {
         // Create/return instance of FooContainer
         // Note that FooContainer class must
         // implement IContainer
         return new FooContainer();
     }
 }
 &lt;/pre&gt;

 In this example, the given class implements the &lt;b&gt;IContainerInstantiator&lt;/b&gt;.createInstance method by creating and returning a new instance of FooInstantiator, a class also defined in the extension plugin.  As noted in the code, this class must implement &lt;b&gt;IContainer&lt;/b&gt;, so that it can successfully be returned from createInstance.

 &lt;h3&gt;Example Usage of Container by Clients&lt;/h3&gt;

 Clients that wish to use the &apos;foo&apos; container implementation can do so simply by making the following call to create an &lt;b&gt;IContainer&lt;/b&gt;:

 &lt;pre&gt;
 IContainer newContainer = ContainerFactory.getDefault().createContainer(&apos;foo&apos;);
 // Further use of newContainer instance here

 &lt;/pre&gt;
       </documentation>
    </annotation>

    <annotation>
       <appInfo>
          <meta.section type="apiInfo"/>
       </appInfo>
       <documentation>
          The API for this extension point is provided by the &lt;b&gt;org.eclipse.ecf.core.ContainerFactory&lt;/b&gt; static methods.  Specifically, the &apos;createContainer&apos; methods are to be used by clients.  The functionality provided by the extension point mechanism can be used at runtime via the &lt;b&gt;ContainerFactory.getDefault().addDescription(ContainerTypeDescription)&lt;/b&gt; method.
       </documentation>
    </annotation>

    <annotation>
       <appInfo>
          <meta.section type="implementation"/>
       </appInfo>
       <documentation>
          The supplied implementations of this extension point are:

 org.eclipse.ecf.provider.generic.ContainerInstantiator
 &lt;b&gt;TEST&lt;/b&gt;:  ecf.test.provider
       </documentation>
    </annotation>

    <annotation>
       <appInfo>
          <meta.section type="copyright"/>
       </appInfo>
       <documentation>
          Copyright (c) 2004 Composent, Inc. and others.
 All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html.  Contributors:  Composent, Inc. - initial API and implementation
       </documentation>
    </annotation>

 </schema>
	<?xml version='1.0' encoding='UTF-8'?>
	<!-- Schema file written by PDE -->
	<schema targetNamespace="org.eclipse.ecf">
	<annotation>
	<appInfo>
	<meta.schema plugin="org.eclipse.ecf" id="containerFactory" name="ECF Container Factory"/>
	</appInfo>
	<documentation>
	This extension allows plugins to register themselves as 'providers' of ECF containers. Once registered via this extension point, plugins can then provide there own implementations of IContainer in response to client request of the ECF container factory (<b>org.eclipse.ecf.core.ContainerFactory</b>).
	<p>Plugins using this extension point can define a new implementation of any desired communications protocol, and expose that protocol as an instance of an <b>IContainer</b>. When client requests are made to ECF ContainerFactory to create <b>IContainer</b> instances, those requests will be re-directed to the given IContainer implementer.
	</documentation>
	</annotation>

	<element name="extension">
	<complexType>
	<sequence>
	<element ref="containerFactory" minOccurs="1" maxOccurs="unbounded"/>
	</sequence>
	<attribute name="point" type="string" use="required">
	<annotation>
	<documentation>

	</documentation>
	</annotation>
	</attribute>
	<attribute name="id" type="string">
	<annotation>
	<documentation>

	</documentation>
	</annotation>
	</attribute>
	<attribute name="name" type="string">
	<annotation>
	<documentation>

	</documentation>
	</annotation>
	</attribute>
	</complexType>
	</element>

	<element name="containerFactory">
	<annotation>
	<documentation>
	The container factory extension point. Can optionally contain a list of 'defaultargument' elements that describe the arguments (and provide default values) to be passed to provider implementation
	</documentation>
	</annotation>
	<complexType>
	<sequence>
	<element ref="defaultargument" minOccurs="0" maxOccurs="unbounded"/>
	<element ref="property" minOccurs="0" maxOccurs="unbounded"/>
	</sequence>
	<attribute name="class" type="string" use="required">
	<annotation>
	<documentation>
	The class implementing the containerFactory extension point. The given class must implement the <b>org.eclipse.ecf.core.provider.IContainerInstantiator</b> interface
	</documentation>
	<appInfo>
	<meta.attribute kind="java"/>
	</appInfo>
	</annotation>
	</attribute>
	<attribute name="name" type="string">
	<annotation>
	<documentation>
	An optional name for the extension. If no name is explicitly provided by the extension, the containerFactory class name is used as the name. Note that this name must <b>not</b> conflict with any other name in the ECF SharedFactory in order to be successfully registered. Care should therefore be taken in selection of a name such that it does not conflict with other pre-existing names for this factory implementations
	</documentation>
	</annotation>
	</attribute>
	<attribute name="description" type="string">
	<annotation>
	<documentation>

	</documentation>
	</annotation>
	</attribute>
	</complexType>
	</element>

	<element name="defaultargument">
	<annotation>
	<documentation>
	Default argument to be passed to <b>org.eclipse.ecf.core.provider.IContainerInstantiator.createInstance()</b> method. Value of this element (if any) is used to indicate a default value for the given argument
	</documentation>
	</annotation>
	<complexType>
	<attribute name="value" type="string">
	<annotation>
	<documentation>
	The value for the default argument
	</documentation>
	</annotation>
	</attribute>
	</complexType>
	</element>

	<element name="property">
	<annotation>
	<documentation>
	Property (name,value) associated with SharedDescription
	</documentation>
	</annotation>
	<complexType>
	<attribute name="name" type="string" use="required">
	<annotation>
	<documentation>
	The name of the property
	</documentation>
	</annotation>
	</attribute>
	<attribute name="value" type="string" use="required">
	<annotation>
	<documentation>
	The value of the property
	</documentation>
	</annotation>
	</attribute>
	</complexType>
	</element>

	<annotation>
	<appInfo>
	<meta.section type="since"/>
	</appInfo>
	<documentation>
	0.0.1
	</documentation>
	</annotation>

	<annotation>
	<appInfo>
	<meta.section type="examples"/>
	</appInfo>
	<documentation>
	Here's an extension that associates a class org.eclipse.ecf.test.FooContainerFactory with name 'foo' in the ECF <b>ContainerFactory</b>:

	<pre>
	<extension point="org.eclipse.ecf.containerFactory">
	<containerFactory name="foo" class="org.eclipse.ecf.test.FooInstantiator" description="My container factory"/>
	<defaultargument type="java.lang.String" value="defaultvalue" name="variablename"/>
	</extension>
	</pre>

	Here is some example code to implement this class:

	<pre>
	package org.eclipse.ecf.test;

	import org.eclipse.ecf.core.IContainer;
	import org.eclipse.ecf.core.ContainerInstantiationException;
	import org.eclipse.ecf.core.provider.IContainerInstantiator;

	public class FooInstantiator implements IContainerInstantiator {

	public FooInstantiator() {
	super();
	}
	public IContainer createInstance(ContainerTypeDescription description, Class[] argTypes, Object[] args)
	throws ContainerInstantiationException {
	// Create/return instance of FooContainer
	// Note that FooContainer class must
	// implement IContainer
	return new FooContainer();
	}
	}
	</pre>

	In this example, the given class implements the <b>IContainerInstantiator</b>.createInstance method by creating and returning a new instance of FooInstantiator, a class also defined in the extension plugin. As noted in the code, this class must implement <b>IContainer</b>, so that it can successfully be returned from createInstance.

	<h3>Example Usage of Container by Clients</h3>

	Clients that wish to use the 'foo' container implementation can do so simply by making the following call to create an <b>IContainer</b>:

	<pre>
	IContainer newContainer = ContainerFactory.getDefault().createContainer('foo');
	// Further use of newContainer instance here

	</pre>
	</documentation>
	</annotation>

	<annotation>
	<appInfo>
	<meta.section type="apiInfo"/>
	</appInfo>
	<documentation>
	The API for this extension point is provided by the <b>org.eclipse.ecf.core.ContainerFactory</b> static methods. Specifically, the 'createContainer' methods are to be used by clients. The functionality provided by the extension point mechanism can be used at runtime via the <b>ContainerFactory.getDefault().addDescription(ContainerTypeDescription)</b> method.
	</documentation>
	</annotation>

	<annotation>
	<appInfo>
	<meta.section type="implementation"/>
	</appInfo>
	<documentation>
	The supplied implementations of this extension point are:

	org.eclipse.ecf.provider.generic.ContainerInstantiator
	<b>TEST</b>: ecf.test.provider
	</documentation>
	</annotation>

	<annotation>
	<appInfo>
	<meta.section type="copyright"/>
	</appInfo>
	<documentation>
	Copyright (c) 2004 Composent, Inc. and others.
	All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at http://www.eclipse.org/legal/epl-v10.html. Contributors: Composent, Inc. - initial API and implementation
	</documentation>
	</annotation>

	</schema>