| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| <HTML> |
| <HEAD><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> |
| <title>Annotation Files</title> |
| <style>@import url("../../book.css");</style> |
| <style>@import url("../../schema.css");</style> |
| </HEAD> |
| <BODY> |
| <H1><CENTER>Annotation Files</CENTER></H1> |
| <p></p> |
| <h6 class=CaptionFigColumn id=header>Identifier: </h6>org.eclipse.jst.jsf.contentmodel.annotations.annotationFiles<p></p> |
| <h6 class=CaptionFigColumn id=header>Since: </h6>WTP 1.5 |
| <p></p> |
| |
| <p> |
| <h6 class=CaptionFigColumn id=header>Description: </h6>Adds annotation meta-data to a content model. An extending plugin may only create one annotation file for a given URI.</p> |
| <p><h6 class=CaptionFigColumn id=header>Configuration Markup:</h6></p> |
| <p class=code id=dtd><!ELEMENT <a name="e.extension">extension</a> (<a href="#e.annotationFile">annotationFile</a>+)></p> |
| <p class=code id=dtd><!ATTLIST extension</p> |
| <p class=code id=dtdAttlist>point CDATA #REQUIRED<p class=code id=dtdAttlist>id CDATA #IMPLIED<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.annotationFile">annotationFile</a> EMPTY></p> |
| <p class=code id=dtd><!ATTLIST annotationFile</p> |
| <p class=code id=dtdAttlist>uri CDATA #REQUIRED<p class=code id=dtdAttlist>location CDATA #REQUIRED<p class=code id=dtdAttlist>locator CDATA #IMPLIED<p class=code id=dtdAttlist>parser CDATA #IMPLIED></p> |
| <p></p> |
| <p class=ConfigMarkup id=elementDesc> |
| File used to map annotations to a tag library content model. The file assigns properties to a tag element or attribute.</p> |
| <br> |
| <ul class=ConfigMarkup id=attlistDesc> |
| <li><b>uri</b> - Content model URI being annotated. eg. "http://java.sun.com/jsf/core". This can, of course, be any string that the consumer wishes to use as a key.</li> |
| <li><b>location</b> - Location of the annotation file. If no locator is provided, it will use the default <code>CMPluginRelativeSourceFileLocator</code> which will find the file in a location relative to the plugin. |
| eg. /metadata/jsf_core.xml</li> |
| <li><b>locator</b> - Class implementing the abstract <code>CMAnnotationSourceFileLocator</code> class. Responsible for locating the annotation file and returning an InputStream to the parser and returning a <code>ResourceBundle</code> if there is one. If a locator is not supplied, the default implementation for a plugin relative file, <code>CMPluginRelativeSourceFileLocator</code> will be used.</li> |
| <li><b>parser</b> - The name of the parser class used to fill the internal model. If not specified the default, <code>CMAnnotationFileParser</code>, will be used which conforms to the default schema <code>http://org.eclipse.jst.jsf.contentmodel.annotations/grammarAnnotationSchema</code>. If parser is provided, it must implement <code>ICMAnnotationFileParser</code>.</li> |
| </ul> |
| <br><h6 class=CaptionFigColumn id=header>API Information: </h6>The parser, if specified, must implement <code>ICMAnnotationFileParser</code> to create <code>CMElementAnnotation</code> and <code>CMAttributeAnnotations</code> in the <code>CMAnnotationMap</code>. |
| <p></p> |
| |
| <br> |
| <p class=note id=copyright> |
| </p> |
| </BODY> |
| </HTML> |
