Adding JMCR-Stable version
[Benchmarks_CSolver.git] / JMCR-Stable / mcr-test / WWW / Doc / Programmer / api / org / w3c / tools / resources / indexer / ResourceIndexer.html
diff --git a/JMCR-Stable/mcr-test/WWW/Doc/Programmer/api/org/w3c/tools/resources/indexer/ResourceIndexer.html b/JMCR-Stable/mcr-test/WWW/Doc/Programmer/api/org/w3c/tools/resources/indexer/ResourceIndexer.html
new file mode 100644 (file)
index 0000000..41f7631
--- /dev/null
@@ -0,0 +1,279 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">\r
+<!--NewPage-->\r
+<HTML>\r
+<HEAD>\r
+<!-- Generated by javadoc (build 1.5.0_11) on Tue Apr 10 15:02:44 UTC 2007 -->\r
+<TITLE>\r
+ResourceIndexer\r
+</TITLE>\r
+\r
+<META NAME="keywords" CONTENT="org.w3c.tools.resources.indexer.ResourceIndexer interface">\r
+\r
+<LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">\r
+\r
+<SCRIPT type="text/javascript">\r
+function windowTitle()\r
+{\r
+    parent.document.title="ResourceIndexer";\r
+}\r
+</SCRIPT>\r
+<NOSCRIPT>\r
+</NOSCRIPT>\r
+\r
+</HEAD>\r
+\r
+<BODY BGCOLOR="white" onload="windowTitle();">\r
+\r
+\r
+<!-- ========= START OF TOP NAVBAR ======= -->\r
+<A NAME="navbar_top"><!-- --></A>\r
+<A HREF="#skip-navbar_top" title="Skip navigation links"></A>\r
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
+<TR>\r
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
+<A NAME="navbar_top_firstrow"><!-- --></A>\r
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
+  <TR ALIGN="center" VALIGN="top">\r
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
+  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
+  </TR>\r
+</TABLE>\r
+</TD>\r
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
+</EM>\r
+</TD>\r
+</TR>\r
+\r
+<TR>\r
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
+&nbsp;<A HREF="../../../../../org/w3c/tools/resources/indexer/IndexersCatalog.html" title="class in org.w3c.tools.resources.indexer"><B>PREV CLASS</B></A>&nbsp;\r
+&nbsp;<A HREF="../../../../../org/w3c/tools/resources/indexer/SampleResourceIndexer.html" title="class in org.w3c.tools.resources.indexer"><B>NEXT CLASS</B></A></FONT></TD>\r
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
+  <A HREF="../../../../../index.html?org/w3c/tools/resources/indexer/ResourceIndexer.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
+&nbsp;<A HREF="ResourceIndexer.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
+&nbsp;<SCRIPT type="text/javascript">\r
+  <!--\r
+  if(window==top) {\r
+    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
+  }\r
+  //-->\r
+</SCRIPT>\r
+<NOSCRIPT>\r
+  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>\r
+</NOSCRIPT>\r
+\r
+\r
+</FONT></TD>\r
+</TR>\r
+<TR>\r
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
+  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
+DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
+</TR>\r
+</TABLE>\r
+<A NAME="skip-navbar_top"></A>\r
+<!-- ========= END OF TOP NAVBAR ========= -->\r
+\r
+<HR>\r
+<!-- ======== START OF CLASS DATA ======== -->\r
+<H2>\r
+<FONT SIZE="-1">\r
+org.w3c.tools.resources.indexer</FONT>\r
+<BR>\r
+Interface ResourceIndexer</H2>\r
+<DL>\r
+<DT><B>All Known Implementing Classes:</B> <DD><A HREF="../../../../../org/w3c/jigsaw/indexer/ConfigResourceIndexer.html" title="class in org.w3c.jigsaw.indexer">ConfigResourceIndexer</A>, <A HREF="../../../../../org/w3c/jigsaw/indexer/ContentTypeIndexer.html" title="class in org.w3c.jigsaw.indexer">ContentTypeIndexer</A>, <A HREF="../../../../../org/w3c/tools/resources/indexer/GhostResourceIndexer.html" title="class in org.w3c.tools.resources.indexer">GhostResourceIndexer</A>, <A HREF="../../../../../org/w3c/tools/resources/indexer/SampleResourceIndexer.html" title="class in org.w3c.tools.resources.indexer">SampleResourceIndexer</A>, <A HREF="../../../../../org/w3c/jigsaw/servlet/ServletIndexer.html" title="class in org.w3c.jigsaw.servlet">ServletIndexer</A>, <A HREF="../../../../../org/w3c/jigsaw/zip/ZipIndexer.html" title="class in org.w3c.jigsaw.zip">ZipIndexer</A></DD>\r
+</DL>\r
+<HR>\r
+<DL>\r
+<DT><PRE>public interface <B>ResourceIndexer</B></DL>\r
+</PRE>\r
+\r
+<P>\r
+Jigsaw indexer.\r
+ The indexer is an object that given some global configuration informations, \r
+ tries to build default resources for files that the server doesn't know\r
+ about.\r
+ A ResourceIndexer <strong>must</strong> be a resource it is to be added\r
+ permanently to the IndexersCatalog.\r
+<P>\r
+\r
+<P>\r
+<DL>\r
+<DT><B>See Also:</B><DD><A HREF="../../../../../org/w3c/tools/resources/indexer/IndexersCatalog.html" title="class in org.w3c.tools.resources.indexer"><CODE>IndexersCatalog</CODE></A></DL>\r
+<HR>\r
+\r
+<P>\r
+\r
+<!-- ========== METHOD SUMMARY =========== -->\r
+\r
+<A NAME="method_summary"><!-- --></A>\r
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
+<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">\r
+<B>Method Summary</B></FONT></TH>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE>&nbsp;<A HREF="../../../../../org/w3c/tools/resources/Resource.html" title="class in org.w3c.tools.resources">Resource</A></CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../../../org/w3c/tools/resources/indexer/ResourceIndexer.html#createResource(org.w3c.tools.resources.ContainerResource, org.w3c.tools.resources.RequestInterface, java.io.File, java.lang.String, java.util.Hashtable)">createResource</A></B>(<A HREF="../../../../../org/w3c/tools/resources/ContainerResource.html" title="class in org.w3c.tools.resources">ContainerResource</A>&nbsp;container,\r
+               <A HREF="../../../../../org/w3c/tools/resources/RequestInterface.html" title="interface in org.w3c.tools.resources">RequestInterface</A>&nbsp;request,\r
+               java.io.File&nbsp;directory,\r
+               java.lang.String&nbsp;name,\r
+               java.util.Hashtable&nbsp;defs)</CODE>\r
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Try to create a resource for the given file.</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE>&nbsp;java.lang.String</CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../../../org/w3c/tools/resources/indexer/ResourceIndexer.html#getIndexedName(java.io.File, java.lang.String)">getIndexedName</A></B>(java.io.File&nbsp;directory,\r
+               java.lang.String&nbsp;name)</CODE>\r
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Get the name of the resource relative to the given filename.</TD>\r
+</TR>\r
+<TR BGCOLOR="white" CLASS="TableRowColor">\r
+<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">\r
+<CODE>&nbsp;long</CODE></FONT></TD>\r
+<TD><CODE><B><A HREF="../../../../../org/w3c/tools/resources/indexer/ResourceIndexer.html#lastModified()">lastModified</A></B>()</CODE>\r
+\r
+<BR>\r
+&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;When was this indexer configuration last modified.</TD>\r
+</TR>\r
+</TABLE>\r
+&nbsp;\r
+<P>\r
+\r
+<!-- ============ METHOD DETAIL ========== -->\r
+\r
+<A NAME="method_detail"><!-- --></A>\r
+<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">\r
+<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">\r
+<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">\r
+<B>Method Detail</B></FONT></TH>\r
+</TR>\r
+</TABLE>\r
+\r
+<A NAME="lastModified()"><!-- --></A><H3>\r
+lastModified</H3>\r
+<PRE>\r
+long <B>lastModified</B>()</PRE>\r
+<DL>\r
+<DD>When was this indexer configuration last modified.\r
+<P>\r
+<DD><DL>\r
+\r
+<DT><B>Returns:</B><DD>The date at which that indexer was last modified, as \r
+ a number of milliseconds since Java epoch.</DL>\r
+</DD>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="createResource(org.w3c.tools.resources.ContainerResource, org.w3c.tools.resources.RequestInterface, java.io.File, java.lang.String, java.util.Hashtable)"><!-- --></A><H3>\r
+createResource</H3>\r
+<PRE>\r
+<A HREF="../../../../../org/w3c/tools/resources/Resource.html" title="class in org.w3c.tools.resources">Resource</A> <B>createResource</B>(<A HREF="../../../../../org/w3c/tools/resources/ContainerResource.html" title="class in org.w3c.tools.resources">ContainerResource</A>&nbsp;container,\r
+                        <A HREF="../../../../../org/w3c/tools/resources/RequestInterface.html" title="interface in org.w3c.tools.resources">RequestInterface</A>&nbsp;request,\r
+                        java.io.File&nbsp;directory,\r
+                        java.lang.String&nbsp;name,\r
+                        java.util.Hashtable&nbsp;defs)</PRE>\r
+<DL>\r
+<DD>Try to create a resource for the given file.\r
+ This method makes its best efforts to try to build a default\r
+ resource out of a file.\r
+<P>\r
+<DD><DL>\r
+<DT><B>Parameters:</B><DD><CODE>container</CODE> - The container making the call.<DD><CODE>request</CODE> - The HTTP request that triggered the call to the indexer\r
+    (may be <strong>null</strong>).<DD><CODE>directory</CODE> - The directory the file is in.<DD><CODE>name</CODE> - The name of the file.<DD><CODE>defs</CODE> - Any default attribute values that should be provided\r
+    to the created resource at initialization time.\r
+<DT><B>Returns:</B><DD>A Resource instance, or <strong>null</strong> if the given\r
+    file can't be truned into a resource given our configuration\r
+    database.</DL>\r
+</DD>\r
+</DL>\r
+<HR>\r
+\r
+<A NAME="getIndexedName(java.io.File, java.lang.String)"><!-- --></A><H3>\r
+getIndexedName</H3>\r
+<PRE>\r
+java.lang.String <B>getIndexedName</B>(java.io.File&nbsp;directory,\r
+                                java.lang.String&nbsp;name)</PRE>\r
+<DL>\r
+<DD>Get the name of the resource relative to the given filename.\r
+<P>\r
+<DD><DL>\r
+<DT><B>Parameters:</B><DD><CODE>name</CODE> - The name of the file.\r
+<DT><B>Returns:</B><DD>a String, the resource name.</DL>\r
+</DD>\r
+</DL>\r
+<!-- ========= END OF CLASS DATA ========= -->\r
+<HR>\r
+\r
+\r
+<!-- ======= START OF BOTTOM NAVBAR ====== -->\r
+<A NAME="navbar_bottom"><!-- --></A>\r
+<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>\r
+<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">\r
+<TR>\r
+<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">\r
+<A NAME="navbar_bottom_firstrow"><!-- --></A>\r
+<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">\r
+  <TR ALIGN="center" VALIGN="top">\r
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>\r
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>\r
+  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>\r
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>\r
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>\r
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>\r
+  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>\r
+  </TR>\r
+</TABLE>\r
+</TD>\r
+<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>\r
+</EM>\r
+</TD>\r
+</TR>\r
+\r
+<TR>\r
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
+&nbsp;<A HREF="../../../../../org/w3c/tools/resources/indexer/IndexersCatalog.html" title="class in org.w3c.tools.resources.indexer"><B>PREV CLASS</B></A>&nbsp;\r
+&nbsp;<A HREF="../../../../../org/w3c/tools/resources/indexer/SampleResourceIndexer.html" title="class in org.w3c.tools.resources.indexer"><B>NEXT CLASS</B></A></FONT></TD>\r
+<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">\r
+  <A HREF="../../../../../index.html?org/w3c/tools/resources/indexer/ResourceIndexer.html" target="_top"><B>FRAMES</B></A>  &nbsp;\r
+&nbsp;<A HREF="ResourceIndexer.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;\r
+&nbsp;<SCRIPT type="text/javascript">\r
+  <!--\r
+  if(window==top) {\r
+    document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');\r
+  }\r
+  //-->\r
+</SCRIPT>\r
+<NOSCRIPT>\r
+  <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>\r
+</NOSCRIPT>\r
+\r
+\r
+</FONT></TD>\r
+</TR>\r
+<TR>\r
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
+  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>\r
+<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">\r
+DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>\r
+</TR>\r
+</TABLE>\r
+<A NAME="skip-navbar_bottom"></A>\r
+<!-- ======== END OF BOTTOM NAVBAR ======= -->\r
+\r
+<HR>\r
+\r
+</BODY>\r
+</HTML>\r