| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <!--NewPage--> |
| <HTML> |
| <HEAD> |
| <!-- Generated by javadoc (build 1.5.0_06) on Fri Jun 15 15:59:07 PDT 2007 --> |
| <TITLE> |
| CMAnnotationHelper |
| </TITLE> |
| |
| <META NAME="keywords" CONTENT="org.eclipse.jst.jsf.contentmodel.annotation.CMAnnotationHelper class"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| parent.document.title="CMAnnotationHelper"; |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| |
| |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <A NAME="navbar_top"><!-- --></A> |
| <A HREF="#skip-navbar_top" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_top_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/CMAnnotationHelper.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| PREV CLASS |
| <A HREF="../../../../../../org/eclipse/jst/jsf/contentmodel/annotation/CMAnnotationPropertyValue.html" title="class in org.eclipse.jst.jsf.contentmodel.annotation"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../index.html?org/eclipse/jst/jsf/contentmodel/annotation/CMAnnotationHelper.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="CMAnnotationHelper.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_top"></A> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| |
| <HR> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <H2> |
| <FONT SIZE="-1"> |
| org.eclipse.jst.jsf.contentmodel.annotation</FONT> |
| <BR> |
| Class CMAnnotationHelper</H2> |
| <PRE> |
| java.lang.Object |
| <IMG SRC="../../../../../../resources/inherit.gif" ALT="extended by "><B>org.eclipse.jst.jsf.contentmodel.annotation.CMAnnotationHelper</B> |
| </PRE> |
| <HR> |
| <B>Deprecated.</B> <I>see <code>org.eclipse.jst.jsf.common.metadata</code> package</I> |
| <P> |
| <DL> |
| <DT><PRE>public class <B>CMAnnotationHelper</B><DT>extends java.lang.Object</DL> |
| </PRE> |
| |
| <P> |
| Class meant for all public access to the design-time meta-data (CMAnnotations) values. |
| |
| <li>Annotation files are registered against a uri (eg. http://java.sun.com/jsf/core) |
| using the extension-point <code>org.eclipse.jst.jsf.contentmodel.annotations.annotationFiles</code>.</li> |
| <li>Any number of annotation files can be associated with the uri and against any element or attribute.</li> |
| <li>It is recommended that a single plugin should avoid registering meta-data for the same attribute or element |
| from different annotationFiles.</li> |
| <li>A CMAnnotation allows for a collection of property values for a named property.</li> |
| <li>Querying the registry using this helper class can return lists of <code>CMAnnotationPropertyValue</code> |
| which allows the caller to make the determination of whether the property value is of interest or not.</li> |
| <li>The caller can also query the registry for specific plugin supplied annotation meta-data.</li> |
| |
| <li>-- include link to doc--</li> |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><CODE>CMElementAnnotation</CODE>, |
| <CODE>CMAttributeAnnotation</CODE>, |
| <A HREF="../../../../../../org/eclipse/jst/jsf/contentmodel/annotation/CMAnnotationPropertyValue.html" title="class in org.eclipse.jst.jsf.contentmodel.annotation"><CODE>also see org.eclipse.jst.jsf.contentmodel.annotations.annotationFiles extension-point</CODE></A></DL> |
| <HR> |
| |
| <P> |
| |
| <!-- ======== CONSTRUCTOR SUMMARY ======== --> |
| |
| <A NAME="constructor_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Constructor Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/jst/jsf/contentmodel/annotation/CMAnnotationHelper.html#CMAnnotationHelper()">CMAnnotationHelper</A></B>()</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> </TD> |
| </TR> |
| </TABLE> |
| |
| <!-- ========== METHOD SUMMARY =========== --> |
| |
| <A NAME="method_summary"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2"> |
| <B>Method Summary</B></FONT></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static java.util.List</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/jst/jsf/contentmodel/annotation/CMAnnotationHelper.html#getCMAttributeProperties(java.lang.String, java.lang.String, java.lang.String, java.lang.String)">getCMAttributeProperties</A></B>(java.lang.String uri, |
| java.lang.String cmElementName, |
| java.lang.String cmAttrName, |
| java.lang.String meta_prop_name)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Returns a list of CMAnnotationPropertyValue objects for a given property name and uri/tag/tag attribute combo.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static java.util.List</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/jst/jsf/contentmodel/annotation/CMAnnotationHelper.html#getCMAttributeProperties(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)">getCMAttributeProperties</A></B>(java.lang.String bundleId, |
| java.lang.String uri, |
| java.lang.String cmElementName, |
| java.lang.String cmAttrName, |
| java.lang.String meta_prop_name)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Returns a list of CMAnnotationPropertyValue objects for a given bundleId, property name and uri/tag/tag attribute combo.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/jst/jsf/contentmodel/annotation/CMAnnotationHelper.html#getCMAttributePropertyValue(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)">getCMAttributePropertyValue</A></B>(java.lang.String bundleId, |
| java.lang.String uri, |
| java.lang.String cmElementName, |
| java.lang.String cmAttrName, |
| java.lang.String meta_prop_name)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Convenience method to return the first string value for a given bundle, uri, element, attr, and meta_prop_name.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static java.util.List</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/jst/jsf/contentmodel/annotation/CMAnnotationHelper.html#getCMAttributePropertyValues(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)">getCMAttributePropertyValues</A></B>(java.lang.String bundleId, |
| java.lang.String uri, |
| java.lang.String cmElementName, |
| java.lang.String cmAttrName, |
| java.lang.String meta_prop_name)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Convenience method to return the list of property values for a given bundle, uri, element, attr, and meta_prop_name.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static java.util.List</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/jst/jsf/contentmodel/annotation/CMAnnotationHelper.html#getCMElementProperties(java.lang.String, java.lang.String, java.lang.String)">getCMElementProperties</A></B>(java.lang.String uri, |
| java.lang.String cmElementName, |
| java.lang.String meta_prop_name)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Returns a list of CMAnnotationPropertyValue objects for a given property name and uri/tag element combo.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static java.util.List</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/jst/jsf/contentmodel/annotation/CMAnnotationHelper.html#getCMElementProperties(java.lang.String, java.lang.String, java.lang.String, java.lang.String)">getCMElementProperties</A></B>(java.lang.String bundleId, |
| java.lang.String uri, |
| java.lang.String cmElementName, |
| java.lang.String meta_prop_name)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Returns a list of CMAnnotationPropertyValue objects for a given bundle, property name and uri/tag element combo.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static java.lang.String</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/jst/jsf/contentmodel/annotation/CMAnnotationHelper.html#getCMElementPropertyValue(java.lang.String, java.lang.String, java.lang.String, java.lang.String)">getCMElementPropertyValue</A></B>(java.lang.String bundleId, |
| java.lang.String uri, |
| java.lang.String cmElementName, |
| java.lang.String meta_prop_name)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Convenience method to return the first string value for a given bundle, uri, element, and meta_prop_name.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static java.util.List</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/jst/jsf/contentmodel/annotation/CMAnnotationHelper.html#getCMElementPropertyValues(java.lang.String, java.lang.String, java.lang.String, java.lang.String)">getCMElementPropertyValues</A></B>(java.lang.String bundleId, |
| java.lang.String uri, |
| java.lang.String cmElementName, |
| java.lang.String meta_prop_name)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Convenience method to return the list of property values for a given bundle, uri, element, and meta_prop_name.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/jst/jsf/contentmodel/annotation/CMAnnotationHelper.html#hasAnnotations(java.lang.String)">hasAnnotations</A></B>(java.lang.String uri)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Return whether or not there are annotation files for a given uri.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE>static boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../../../org/eclipse/jst/jsf/contentmodel/annotation/CMAnnotationHelper.html#hasAnnotations(java.lang.String, java.lang.String)">hasAnnotations</A></B>(java.lang.String bundleId, |
| java.lang.String uri)</CODE> |
| |
| <BR> |
| <B>Deprecated.</B> Return whether or not there are annotation files for a given uri and bundleId.</TD> |
| </TR> |
| </TABLE> |
| <A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor"> |
| <TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD><CODE>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</CODE></TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ========= CONSTRUCTOR DETAIL ======== --> |
| |
| <A NAME="constructor_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Constructor Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="CMAnnotationHelper()"><!-- --></A><H3> |
| CMAnnotationHelper</H3> |
| <PRE> |
| public <B>CMAnnotationHelper</B>()</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> </DL> |
| |
| <!-- ============ METHOD DETAIL ========== --> |
| |
| <A NAME="method_detail"><!-- --></A> |
| <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY=""> |
| <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor"> |
| <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2"> |
| <B>Method Detail</B></FONT></TH> |
| </TR> |
| </TABLE> |
| |
| <A NAME="getCMAttributeProperties(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3> |
| getCMAttributeProperties</H3> |
| <PRE> |
| public static java.util.List <B>getCMAttributeProperties</B>(java.lang.String uri, |
| java.lang.String cmElementName, |
| java.lang.String cmAttrName, |
| java.lang.String meta_prop_name)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Returns a list of CMAnnotationPropertyValue objects for a given property name and uri/tag/tag attribute combo. |
| A list is being returned because it is possible that there are multiple annotation files with the same |
| named property. Caller can decide what to do. |
| |
| Will return empty if annotation is not found or meta-data property name not present. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>uri</CODE> - <DD><CODE>cmElementName</CODE> - <DD><CODE>cmAttrName</CODE> - <DD><CODE>meta_prop_name</CODE> - |
| <DT><B>Returns:</B><DD>list of CMAnnotationPropertyValue objects</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getCMAttributeProperties(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3> |
| getCMAttributeProperties</H3> |
| <PRE> |
| public static java.util.List <B>getCMAttributeProperties</B>(java.lang.String bundleId, |
| java.lang.String uri, |
| java.lang.String cmElementName, |
| java.lang.String cmAttrName, |
| java.lang.String meta_prop_name)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Returns a list of CMAnnotationPropertyValue objects for a given bundleId, property name and uri/tag/tag attribute combo. |
| A list is being returned because it is possible that there are multiple annotation files with the same |
| named property. Caller can decide what to do. |
| |
| Use this method if you are not looking for a property value from a specific bundle. Usually the caller. |
| |
| Will return empty if annotation is not found or meta-data property name not present. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>bundleId</CODE> - <DD><CODE>uri</CODE> - <DD><CODE>cmElementName</CODE> - <DD><CODE>cmAttrName</CODE> - <DD><CODE>meta_prop_name</CODE> - |
| <DT><B>Returns:</B><DD>list of CMAnnotationPropertyValue objects</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getCMAttributePropertyValue(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3> |
| getCMAttributePropertyValue</H3> |
| <PRE> |
| public static java.lang.String <B>getCMAttributePropertyValue</B>(java.lang.String bundleId, |
| java.lang.String uri, |
| java.lang.String cmElementName, |
| java.lang.String cmAttrName, |
| java.lang.String meta_prop_name)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Convenience method to return the first string value for a given bundle, uri, element, attr, and meta_prop_name. |
| Caller needs to be aware that this could be a multi-value property. If so, <code>getCMAttributePropertyValues</code> |
| should probably be called. |
| |
| Caller must be sure that only one annotation meta-data file is associated with this uri from the specified bundle. |
| If there are multiple annotations, only the first bundle's values will be returned. |
| |
| Will return null if annotation is not found or meta-data property name not present. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>bundleId</CODE> - <DD><CODE>uri</CODE> - <DD><CODE>cmElementName</CODE> - <DD><CODE>cmAttrName</CODE> - <DD><CODE>meta_prop_name</CODE> - |
| <DT><B>Returns:</B><DD>property value as String</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getCMAttributePropertyValues(java.lang.String, java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3> |
| getCMAttributePropertyValues</H3> |
| <PRE> |
| public static java.util.List <B>getCMAttributePropertyValues</B>(java.lang.String bundleId, |
| java.lang.String uri, |
| java.lang.String cmElementName, |
| java.lang.String cmAttrName, |
| java.lang.String meta_prop_name)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Convenience method to return the list of property values for a given bundle, uri, element, attr, and meta_prop_name. |
| |
| Caller must be sure that only one annotation meta-data file is associated with this uri from the specified bundle. |
| If there are multiple annotations, only the first bundle's values will be returned. |
| |
| Will return empty list if annotation is not found or meta-data property name not present. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>bundleId</CODE> - <DD><CODE>uri</CODE> - <DD><CODE>cmElementName</CODE> - <DD><CODE>cmAttrName</CODE> - <DD><CODE>meta_prop_name</CODE> - |
| <DT><B>Returns:</B><DD>property values as List</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getCMElementProperties(java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3> |
| getCMElementProperties</H3> |
| <PRE> |
| public static java.util.List <B>getCMElementProperties</B>(java.lang.String uri, |
| java.lang.String cmElementName, |
| java.lang.String meta_prop_name)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Returns a list of CMAnnotationPropertyValue objects for a given property name and uri/tag element combo. |
| A list is being returned because it is possible that there are multiple annotation files with the same |
| named property. Caller can decide what to do. |
| |
| Will return empty list if annotation is not found or meta-data property name not present. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>uri</CODE> - <DD><CODE>cmElementName</CODE> - <DD><CODE>meta_prop_name</CODE> - |
| <DT><B>Returns:</B><DD>list of CMAnnotationPropertyValue objects</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getCMElementProperties(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3> |
| getCMElementProperties</H3> |
| <PRE> |
| public static java.util.List <B>getCMElementProperties</B>(java.lang.String bundleId, |
| java.lang.String uri, |
| java.lang.String cmElementName, |
| java.lang.String meta_prop_name)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Returns a list of CMAnnotationPropertyValue objects for a given bundle, property name and uri/tag element combo. |
| A list is being returned because it is possible that there are multiple annotation files with the same |
| named property. Caller can decide what to do. |
| |
| Use this method if you are not looking for a property value from a specific bundle. Usually the caller. |
| |
| Will return empty list if annotation is not found or meta-data property name not present. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>bundleId</CODE> - <DD><CODE>uri</CODE> - <DD><CODE>cmElementName</CODE> - <DD><CODE>meta_prop_name</CODE> - |
| <DT><B>Returns:</B><DD>list of CMAnnotationPropertyValue objects</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getCMElementPropertyValue(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3> |
| getCMElementPropertyValue</H3> |
| <PRE> |
| public static java.lang.String <B>getCMElementPropertyValue</B>(java.lang.String bundleId, |
| java.lang.String uri, |
| java.lang.String cmElementName, |
| java.lang.String meta_prop_name)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Convenience method to return the first string value for a given bundle, uri, element, and meta_prop_name. |
| Caller needs to be aware that this could be a multi-value property. If so, <code>getCMAttributePropertyValues</code> |
| should probably be called. |
| |
| Caller must be sure that only one annotation meta-data file is associated with this uri from the specified bundle. |
| If there are multiple annotations, only the first bundle's values will be returned. |
| |
| Will return null if annotation is not found or meta-data property name not present. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>bundleId</CODE> - <DD><CODE>uri</CODE> - <DD><CODE>cmElementName</CODE> - <DD><CODE>meta_prop_name</CODE> - |
| <DT><B>Returns:</B><DD>property value as String</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="getCMElementPropertyValues(java.lang.String, java.lang.String, java.lang.String, java.lang.String)"><!-- --></A><H3> |
| getCMElementPropertyValues</H3> |
| <PRE> |
| public static java.util.List <B>getCMElementPropertyValues</B>(java.lang.String bundleId, |
| java.lang.String uri, |
| java.lang.String cmElementName, |
| java.lang.String meta_prop_name)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Convenience method to return the list of property values for a given bundle, uri, element, and meta_prop_name. |
| |
| Caller must be sure that only one annotation meta-data file is associated with this uri from the specified bundle. |
| If there are multiple annotations, only the first bundle's values will be returned. |
| |
| Will return empty list if annotation is not found or meta-data property name not present. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>bundleId</CODE> - <DD><CODE>uri</CODE> - <DD><CODE>cmElementName</CODE> - <DD><CODE>meta_prop_name</CODE> - |
| <DT><B>Returns:</B><DD>List of property values as Strings</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="hasAnnotations(java.lang.String, java.lang.String)"><!-- --></A><H3> |
| hasAnnotations</H3> |
| <PRE> |
| public static boolean <B>hasAnnotations</B>(java.lang.String bundleId, |
| java.lang.String uri)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Return whether or not there are annotation files for a given uri and bundleId. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>bundleId</CODE> - <DD><CODE>uri</CODE> - |
| <DT><B>Returns:</B><DD>boolean</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="hasAnnotations(java.lang.String)"><!-- --></A><H3> |
| hasAnnotations</H3> |
| <PRE> |
| public static boolean <B>hasAnnotations</B>(java.lang.String uri)</PRE> |
| <DL> |
| <DD><B>Deprecated.</B> <DD>Return whether or not there are annotation files for a given uri. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>uri</CODE> - |
| <DT><B>Returns:</B><DD>boolean</DL> |
| </DD> |
| </DL> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <HR> |
| |
| |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <A NAME="navbar_bottom"><!-- --></A> |
| <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A> |
| <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY=""> |
| <TR> |
| <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> |
| <A NAME="navbar_bottom_firstrow"><!-- --></A> |
| <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY=""> |
| <TR ALIGN="center" VALIGN="top"> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A> </TD> |
| <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> <FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/CMAnnotationHelper.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../index-files/index-1.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A> </TD> |
| </TR> |
| </TABLE> |
| </TD> |
| <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM> |
| </EM> |
| </TD> |
| </TR> |
| |
| <TR> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| PREV CLASS |
| <A HREF="../../../../../../org/eclipse/jst/jsf/contentmodel/annotation/CMAnnotationPropertyValue.html" title="class in org.eclipse.jst.jsf.contentmodel.annotation"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../../../index.html?org/eclipse/jst/jsf/contentmodel/annotation/CMAnnotationHelper.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="CMAnnotationHelper.html" target="_top"><B>NO FRAMES</B></A> |
| <SCRIPT type="text/javascript"> |
| <!-- |
| if(window==top) { |
| document.writeln('<A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A>'); |
| } |
| //--> |
| </SCRIPT> |
| <NOSCRIPT> |
| <A HREF="../../../../../../allclasses-noframe.html"><B>All Classes</B></A> |
| </NOSCRIPT> |
| |
| |
| </FONT></TD> |
| </TR> |
| <TR> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| SUMMARY: NESTED | FIELD | <A HREF="#constructor_summary">CONSTR</A> | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | <A HREF="#constructor_detail">CONSTR</A> | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| |
| </BODY> |
| </HTML> |
