| <!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.6.0) on Tue May 20 09:50:54 EDT 2008 --> |
| <TITLE> |
| IDependencyIndex |
| </TITLE> |
| |
| <META NAME="date" CONTENT="2008-05-20"> |
| |
| <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../stylesheet.css" TITLE="Style"> |
| |
| <SCRIPT type="text/javascript"> |
| function windowTitle() |
| { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="IDependencyIndex"; |
| } |
| } |
| </SCRIPT> |
| <NOSCRIPT> |
| </NOSCRIPT> |
| |
| </HEAD> |
| |
| <BODY BGCOLOR="white" onload="windowTitle();"> |
| <HR> |
| |
| |
| <!-- ========= 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/IDependencyIndex.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../serialized-form.html"><FONT CLASS="NavBarFont1"><B>Serialized</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="../../../../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"> |
| <A HREF="../../../../org/eclipse/wst/validation/Friend.html" title="class in org.eclipse.wst.validation"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/eclipse/wst/validation/IPerformanceMonitor.html" title="interface in org.eclipse.wst.validation"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/eclipse/wst/validation/IDependencyIndex.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="IDependencyIndex.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 | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <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.wst.validation</FONT> |
| <BR> |
| Interface IDependencyIndex</H2> |
| <HR> |
| <DL> |
| <DT><PRE>public interface <B>IDependencyIndex</B></DL> |
| </PRE> |
| |
| <P> |
| This service is used to specify the resources that a particular resource depends on. |
| <p> |
| This is an optional service, validators do not need to use this Interface and can simply supply |
| their dependency information through the ValidationResult return result. |
| </p> |
| <p> |
| <b>Provisional API:</b> This class/interface is part of an interim API that is still under development and expected to |
| change significantly before reaching stability. It is being made available at this early stage to solicit feedback |
| from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken |
| (repeatedly) as the API evolves. |
| </p> |
| <P> |
| |
| <P> |
| <DL> |
| <DT><B>See Also:</B><DD><A HREF="../../../../org/eclipse/wst/validation/ValidationResult.html" title="class in org.eclipse.wst.validation"><CODE>ValidationResult</CODE></A></DL> |
| <HR> |
| |
| <P> |
| |
| <!-- ========== 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> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/IDependencyIndex.html#add(java.lang.String, IResource, IResource)">add</A></B>(java.lang.String id, |
| IResource dependent, |
| IResource dependsOn)</CODE> |
| |
| <BR> |
| Assert that one resource depends on another resource as part of it's validity.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/IDependencyIndex.html#clear(IProject)">clear</A></B>(IProject project)</CODE> |
| |
| <BR> |
| Remove all the dependency assertions for this project.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> java.util.List<<A HREF="../../../../org/eclipse/wst/validation/DependentResource.html" title="class in org.eclipse.wst.validation">DependentResource</A>></CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/IDependencyIndex.html#get(IResource)">get</A></B>(IResource resource)</CODE> |
| |
| <BR> |
| Answer all the resources that depend on this resource.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> IResource[]</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/IDependencyIndex.html#get(java.lang.String, IResource)">get</A></B>(java.lang.String id, |
| IResource resource)</CODE> |
| |
| <BR> |
| Answer all the resources that depend on this resource.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> boolean</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/IDependencyIndex.html#isDependedOn(IResource)">isDependedOn</A></B>(IResource resource)</CODE> |
| |
| <BR> |
| Answer true if other resources depend on this resource.</TD> |
| </TR> |
| <TR BGCOLOR="white" CLASS="TableRowColor"> |
| <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1"> |
| <CODE> void</CODE></FONT></TD> |
| <TD><CODE><B><A HREF="../../../../org/eclipse/wst/validation/IDependencyIndex.html#set(java.lang.String, IResource, IResource[])">set</A></B>(java.lang.String id, |
| IResource dependent, |
| IResource[] dependsOn)</CODE> |
| |
| <BR> |
| Replace all the resources that the dependent depends on.</TD> |
| </TR> |
| </TABLE> |
| |
| <P> |
| |
| <!-- ============ 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="add(java.lang.String, IResource, IResource)"><!-- --></A><H3> |
| add</H3> |
| <PRE> |
| void <B>add</B>(java.lang.String id, |
| IResource dependent, |
| IResource dependsOn)</PRE> |
| <DL> |
| <DD>Assert that one resource depends on another resource as part of it's validity. |
| <p> |
| For example, if an XML file is dependent on an XSD file to be valid, the |
| resource that holds the XML file would be the dependent, and the resource |
| that holds the XSD would be the dependsOn. |
| </p> |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>id</CODE> - The validator id that is asserting that the dependency exists.<DD><CODE>dependent</CODE> - The resource that is dependent on the other resource. For example a XML file.<DD><CODE>dependsOn</CODE> - The resource that this being depended on. For example a XSD file.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="clear(IProject)"><!-- --></A><H3> |
| clear</H3> |
| <PRE> |
| void <B>clear</B>(IProject project)</PRE> |
| <DL> |
| <DD>Remove all the dependency assertions for this project. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>project</CODE> - The project that will have it's dependency assertions removed.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="get(IResource)"><!-- --></A><H3> |
| get</H3> |
| <PRE> |
| java.util.List<<A HREF="../../../../org/eclipse/wst/validation/DependentResource.html" title="class in org.eclipse.wst.validation">DependentResource</A>> <B>get</B>(IResource resource)</PRE> |
| <DL> |
| <DD>Answer all the resources that depend on this resource. For example, if |
| this resource was a XSD, this could answer all the XML files that |
| depended on it for their validity. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>resource</CODE> - A resource that other resources may depend on. |
| <DT><B>Returns:</B><DD>the dependent resources.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="get(java.lang.String, IResource)"><!-- --></A><H3> |
| get</H3> |
| <PRE> |
| IResource[] <B>get</B>(java.lang.String id, |
| IResource resource)</PRE> |
| <DL> |
| <DD>Answer all the resources that depend on this resource. For example, if |
| this resource was a XSD, this could answer all the XML files that |
| depended on it for their validity. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>id</CODE> - The validator id that asserted that the dependency exists.<DD><CODE>resource</CODE> - A resource that other resources may depend on. |
| <DT><B>Returns:</B><DD>the dependent resources. This method can return null or an empty array, if |
| there are no dependent resources.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="isDependedOn(IResource)"><!-- --></A><H3> |
| isDependedOn</H3> |
| <PRE> |
| boolean <B>isDependedOn</B>(IResource resource)</PRE> |
| <DL> |
| <DD>Answer true if other resources depend on this resource. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>resource</CODE> - The resource being tested. |
| <DT><B>Returns:</B><DD>true if any of the validators asserted a dependency on this resource.</DL> |
| </DD> |
| </DL> |
| <HR> |
| |
| <A NAME="set(java.lang.String, IResource, IResource[])"><!-- --></A><H3> |
| set</H3> |
| <PRE> |
| void <B>set</B>(java.lang.String id, |
| IResource dependent, |
| IResource[] dependsOn)</PRE> |
| <DL> |
| <DD>Replace all the resources that the dependent depends on. |
| <P> |
| <DD><DL> |
| <DT><B>Parameters:</B><DD><CODE>id</CODE> - The validator id that is asserting that the dependency exists.<DD><CODE>dependent</CODE> - The resource that is dependent on the other resource.<DD><CODE>dependsOn</CODE> - All the resources that are depended on. This can be null or a zero |
| length array. Null or a zero length array removes all the dependencies.</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/IDependencyIndex.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A> </TD> |
| <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../serialized-form.html"><FONT CLASS="NavBarFont1"><B>Serialized</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="../../../../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"> |
| <A HREF="../../../../org/eclipse/wst/validation/Friend.html" title="class in org.eclipse.wst.validation"><B>PREV CLASS</B></A> |
| <A HREF="../../../../org/eclipse/wst/validation/IPerformanceMonitor.html" title="interface in org.eclipse.wst.validation"><B>NEXT CLASS</B></A></FONT></TD> |
| <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2"> |
| <A HREF="../../../../index.html?org/eclipse/wst/validation/IDependencyIndex.html" target="_top"><B>FRAMES</B></A> |
| <A HREF="IDependencyIndex.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 | CONSTR | <A HREF="#method_summary">METHOD</A></FONT></TD> |
| <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2"> |
| DETAIL: FIELD | CONSTR | <A HREF="#method_detail">METHOD</A></FONT></TD> |
| </TR> |
| </TABLE> |
| <A NAME="skip-navbar_bottom"></A> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| |
| <HR> |
| |
| </BODY> |
| </HTML> |