blob: a67c874e705d334231bf933b10d40f1eb7f25cff [file] [log] [blame]
<!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 type="text/css">@import url("../../book.css");</style>
<style type="text/css">@import url("../../schema.css");</style>
</HEAD>
<BODY>
<H1 style="text-align:center">Annotation Files</H1>
<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Identifier: </h6>org.eclipse.jst.jsf.common.annotationFiles<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Since: </h6>1.5
<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Description: </h6>Adds annotation meta-data to a content model. An extending plugin may only create one annotation file for a given URI.
<p><b>This extension point is provisional and subject to change</b></p><p></p>
<h6 class="CaptionFigColumn SchemaHeader">Configuration Markup:</h6>
<p></p>
<p class="code SchemaDtd">&lt;!ELEMENT <a name="e.extension">extension</a> (<a href="#e.annotationFile">annotationFile</a>+)&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST extension</p>
<p class="code SchemaDtdAttlist">point&nbsp;CDATA #REQUIRED<p class="code SchemaDtdAttlist">id&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED<p class="code SchemaDtdAttlist">name&nbsp;&nbsp;CDATA #IMPLIED&gt;</p>
<p></p>
<ul class="ConfigMarkupAttlistDesc">
</ul>
<br><p class="code SchemaDtd">&lt;!ELEMENT <a name="e.annotationFile">annotationFile</a> EMPTY&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST annotationFile</p>
<p class="code SchemaDtdAttlist">uri&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED<p class="code SchemaDtdAttlist">location&nbsp;CDATA #REQUIRED<p class="code SchemaDtdAttlist">locator&nbsp;&nbsp;CDATA #IMPLIED<p class="code SchemaDtdAttlist">parser&nbsp;&nbsp;&nbsp;CDATA #IMPLIED&gt;</p>
<p></p>
<p class="ConfigMarkupElementDesc">
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="ConfigMarkupAttlistDesc">
<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><br>
<p class="note SchemaCopyright">
Copyright 2006 Oracle
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
</p>
</BODY>
</HTML>