| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> | |
| <HTML> | |
| <HEAD> | |
| <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=ISO-8859-1"> | |
| <STYLE type="text/css"> | |
| div.dtd-fragment { | |
| width: 100%; | |
| border: none; | |
| background-color: #eee; | |
| } | |
| </STYLE> | |
| </HEAD> | |
| <BODY> | |
| <H1><CENTER>Sample Parsers</CENTER></H1> | |
| <b><i>Identifier: </i></b>com.example.xyz.parsers<p> | |
| <b><i>Since: </i></b>2.1<p> | |
| <b><i>Description: </i></b>This extension point is used to plug in additional parsers. The parsers actually do not work - we have just used them as an example of extension point schema. <p><b><i>Configuration Markup:</i></b><p> | |
| <p><samp><font color="#800000"> <!ELEMENT <a name="e.extension">extension</a> (<a href="#e.parser">parser</a>*)></font></samp> | |
| <br><br><samp><font color="#800000"> <!ATTLIST extension</samp> | |
| <br><samp> point CDATA #REQUIRED</samp> | |
| <br><samp> id CDATA #IMPLIED</samp> | |
| <br><samp> name CDATA #IMPLIED</samp> | |
| <br><samp> ></font></samp> | |
| <ul> | |
| </ul> | |
| <p><samp><font color="#800000"> <!ELEMENT <a name="e.parser">parser</a> EMPTY></font></samp> | |
| <br><br><samp><font color="#800000"> <!ATTLIST parser</samp> | |
| <br><samp> id CDATA #REQUIRED</samp> | |
| <br><samp> name CDATA #REQUIRED</samp> | |
| <br><samp> class CDATA #REQUIRED</samp> | |
| <br><samp> mode (never|always|manual) "always"</samp> | |
| <br><samp> ></font></samp> | |
| <ul> | |
| <li><b>id</b> - a unique name that will be used to reference this parser. | |
| </li> | |
| <li><b>name</b> - a translatable name that will be used for presenting this parser in the UI. | |
| </li> | |
| <li><b>class</b> - a fully qualified name of the Java class that implements <samp>com.example.xyz.IParser</samp> interface.</li> | |
| <li><b>mode</b> - an optional flag that indicates how often this parser instance will run (default is <samp>always</samp>). | |
| </li> | |
| </ul> | |
| <b><i>Examples: </i></b>The following is an example of the extension point usage: | |
| <pre> | |
| <font color="#000080"><extension point=<font color="#008000">"com.example.xyz.parsers"</font>></font> | |
| <font color="#000080"><parser | |
| id=<font color="#008000">"com.example.xyz.parser1"</font> | |
| name=<font color="#008000">"Sample Parser 1"</font> | |
| class=<font color="#008000">"com.example.xyz.SampleParser1"</font>></font> | |
| <font color="#000080"></parser></font> | |
| <font color="#000080"></extension></font> | |
| </pre><p> | |
| <b><i>API Information: </i></b>Plug-ins that want to extend this extension point must implement <samp>com.example.xyz.IParser</samp> interface. <p> | |
| <b><i>Supplied Implementation: </i></b>XYZ Plug-in provides default implementation of the parser. <p> | |
| <font size="-1" color="#336699"> | |
| Copyright XYZ 2003. All rights reserved.<p> | |
| </font> | |
| </BODY> | |
| </HTML> |