| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| <HTML> |
| <HEAD> |
| <meta name="copyright" content="Copyright (c) IBM Corporation and others 2000, 2005. This page is made available under license. For full details see the LEGAL in the documentation book that contains this page." > |
| <!-- default platform documentation stylesheets --> |
| <style>@import url("book.css");</style> |
| <!-- default schema documentation stylesheets --> |
| <style>@import url("schema.css");</style> |
| <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=ISO-8859-1"> |
| </HEAD> |
| <BODY> |
| <H1><CENTER>Sample Parsers</CENTER></H1> |
| <p></p> |
| <h6 class=CaptionFigColumn id=header>Identifier: </h6>com.example.xyz.parsers<p></p> |
| <h6 class=CaptionFigColumn id=header>Since: </h6>3.0 |
| <p></p> |
| |
| <p> |
| <h6 class=CaptionFigColumn id=header>Description: </h6>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> |
| <p><h6 class=CaptionFigColumn id=header>Configuration Markup:</h6></p> |
| <p class=code id=dtd><!ELEMENT <a name="e.extension">extension</a> EMPTY></p> |
| <p class=code id=dtd><!ATTLIST extension</p> |
| <p class=code id=dtdAttlist>point CDATA #REQUIRED</p><p class=code id=dtdAttlist>id CDATA #IMPLIED</p><p class=code id=dtdAttlist>name CDATA #IMPLIED></p> |
| <p></p> |
| <ul class=ConfigMarkup id=attlistDesc> |
| </ul> |
| <br><p class=code id=dtd><!ELEMENT <a name="e.parser">parser</a> (<a href="#e.parser">parser</a>+)></p> |
| <p class=code id=dtd><!ATTLIST parser</p> |
| <p class=code id=dtdAttlist>id CDATA #REQUIRED</p><p class=code id=dtdAttlist>name CDATA #REQUIRED</p><p class=code id=dtdAttlist>class CDATA #REQUIRED</p><p class=code id=dtdAttlist>mode (manual|always|never) ></p> |
| <p></p> |
| <ul class=ConfigMarkup id=attlistDesc> |
| <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> |
| <br><h6 class=CaptionFigColumn id=header>Examples: </h6>The following is an example of the extension point usage: |
| <p></p> |
| <pre> |
| <p class=code id=tag><extension point=</p><p class=code id=cstring>"com.example.xyz.parsers"</p><p class=code id=tag>></p> |
| <p class=code id=tag><parser |
| id=</p><p class=code id=cstring>"com.example.xyz.parser1"</p><p class=code id=tag> |
| name=</p>s<p class=code id=cstring>"Sample Parser 1"</p><p class=code id=tag> |
| class=</p><p class=code id=cstring>"com.example.xyz.SampleParser1"</p><p class=code id=tag>></p> |
| <p class=code id=tag></parser></p> |
| <p class=code id=tag></extension></p> |
| </pre> |
| <p></p> |
| <p></p> |
| |
| <h6 class=CaptionFigColumn id=header>API Information: </h6>Plug-ins that want to extend this extension point must implement com.example.xyz.IParser interface. |
| <p></p> |
| |
| <h6 class=CaptionFigColumn id=header>Supplied Implementation: </h6>XYZ Plug-in provides default implementation of the parser. |
| <p></p> |
| |
| </BODY> |
| </HTML> |
