settingshandler.html

一个开源的网页爬虫一个开源的网页爬虫一个开源的网页爬虫一个开源的网页爬虫一个开源的网页爬虫一个开源的网页爬虫

<A NAME="getOrCreateSettingsObject(java.lang.String)"><!-- --></A><H3>
getOrCreateSettingsObject</H3>
<PRE>
public <A HREF="../../../../org/archive/crawler/settings/CrawlerSettings.html" title="class in org.archive.crawler.settings">CrawlerSettings</A> <B>getOrCreateSettingsObject</B>(java.lang.String&nbsp;scope)</PRE>
<DL>
<DD>Get or create CrawlerSettings object for a host or domain.

 This method is similar to <A HREF="../../../../org/archive/crawler/settings/SettingsHandler.html#getSettingsObject(java.lang.String)"><CODE>getSettingsObject(String)</CODE></A> except that
 if there is no settings for this particular host or domain a new settings
 object will be returned.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>scope</CODE> - the host or domain to get or create the settings for.
<DT><B>Returns:</B><DD>settings object for the host/domain.<DT><B>See Also:</B><DD><A HREF="../../../../org/archive/crawler/settings/SettingsHandler.html#getSettings(java.lang.String)"><CODE>getSettings(String)</CODE></A>, 
<A HREF="../../../../org/archive/crawler/settings/SettingsHandler.html#getSettingsObject(java.lang.String)"><CODE>getSettingsObject(String)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="getOrCreateSettingsObject(java.lang.String, java.lang.String)"><!-- --></A><H3>
getOrCreateSettingsObject</H3>
<PRE>
public <A HREF="../../../../org/archive/crawler/settings/CrawlerSettings.html" title="class in org.archive.crawler.settings">CrawlerSettings</A> <B>getOrCreateSettingsObject</B>(java.lang.String&nbsp;scope,
                                                 java.lang.String&nbsp;refinement)</PRE>
<DL>
<DD><DL>
</DL>
</DD>
</DL>
<HR>

<A NAME="writeSettingsObject(org.archive.crawler.settings.CrawlerSettings)"><!-- --></A><H3>
writeSettingsObject</H3>
<PRE>
public abstract void <B>writeSettingsObject</B>(<A HREF="../../../../org/archive/crawler/settings/CrawlerSettings.html" title="class in org.archive.crawler.settings">CrawlerSettings</A>&nbsp;settings)</PRE>
<DL>
<DD>Write the CrawlerSettings object to persistent storage.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>settings</CODE> - the settings object to write.</DL>
</DD>
</DL>
<HR>

<A NAME="readSettingsObject(org.archive.crawler.settings.CrawlerSettings)"><!-- --></A><H3>
readSettingsObject</H3>
<PRE>
protected abstract <A HREF="../../../../org/archive/crawler/settings/CrawlerSettings.html" title="class in org.archive.crawler.settings">CrawlerSettings</A> <B>readSettingsObject</B>(<A HREF="../../../../org/archive/crawler/settings/CrawlerSettings.html" title="class in org.archive.crawler.settings">CrawlerSettings</A>&nbsp;settings)</PRE>
<DL>
<DD>Read the CrawlerSettings object from persistent storage.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>settings</CODE> - the settings object to be updated with data from the
                 persistent storage.
<DT><B>Returns:</B><DD>the updated settings object or null if there was no data for this
         in the persistent storage.</DL>
</DD>
</DL>
<HR>

<A NAME="deleteSettingsObject(org.archive.crawler.settings.CrawlerSettings)"><!-- --></A><H3>
deleteSettingsObject</H3>
<PRE>
public void <B>deleteSettingsObject</B>(<A HREF="../../../../org/archive/crawler/settings/CrawlerSettings.html" title="class in org.archive.crawler.settings">CrawlerSettings</A>&nbsp;settings)</PRE>
<DL>
<DD>Delete a settings object from persistent storage.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>settings</CODE> - the settings object to delete.</DL>
</DD>
</DL>
<HR>

<A NAME="getOrder()"><!-- --></A><H3>
getOrder</H3>
<PRE>
public <A HREF="../../../../org/archive/crawler/datamodel/CrawlOrder.html" title="class in org.archive.crawler.datamodel">CrawlOrder</A> <B>getOrder</B>()</PRE>
<DL>
<DD>Get the CrawlOrder.
<P>
<DD><DL>

<DT><B>Returns:</B><DD>the CrawlOrder</DL>
</DD>
</DL>
<HR>

<A NAME="instantiateModuleTypeFromClassName(java.lang.String, java.lang.String)"><!-- --></A><H3>
instantiateModuleTypeFromClassName</H3>
<PRE>
public static <A HREF="../../../../org/archive/crawler/settings/ModuleType.html" title="class in org.archive.crawler.settings">ModuleType</A> <B>instantiateModuleTypeFromClassName</B>(java.lang.String&nbsp;name,
                                                            java.lang.String&nbsp;className)
                                                     throws java.lang.reflect.InvocationTargetException</PRE>
<DL>
<DD>Instatiate a new ModuleType given its name and className.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>name</CODE> - the name for the new ComplexType.<DD><CODE>className</CODE> - the class name of the new ComplexType.
<DT><B>Returns:</B><DD>an instance of the class identified by className.
<DT><B>Throws:</B>
<DD><CODE>java.lang.reflect.InvocationTargetException</CODE></DL>
</DD>
</DL>
<HR>

<A NAME="getPathRelativeToWorkingDirectory(java.lang.String)"><!-- --></A><H3>
getPathRelativeToWorkingDirectory</H3>
<PRE>
public abstract java.io.File <B>getPathRelativeToWorkingDirectory</B>(java.lang.String&nbsp;path)</PRE>
<DL>
<DD>Transforms a relative path so that it is relative to a location that is
 regarded as a working dir for these settings. If an absolute path is given,
 it will be returned unchanged.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>path</CODE> - A relative path to a file (or directory)
<DT><B>Returns:</B><DD>The same path modified so that it is relative to the file level
         location that is considered the working directory for these settings.</DL>
</DD>
</DL>
<HR>

<A NAME="getDomainOverrides(java.lang.String)"><!-- --></A><H3>
getDomainOverrides</H3>
<PRE>
public abstract java.util.Collection <B>getDomainOverrides</B>(java.lang.String&nbsp;rootDomain)</PRE>
<DL>
<DD>Will return a Collection of strings with domains that contain 'per'
 domain overrides (or their subdomains contain them). 
 
 The domains considered are
 limited to those that are subdomains of the supplied domain. If null or
 empty string is supplied the TLDs will be considered.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>rootDomain</CODE> - The domain to get domain overrides for. Examples:
                   'org', 'archive.org', 'crawler.archive.org' etc.
<DT><B>Returns:</B><DD>An array of domains that contain overrides. If rootDomain does not
         exist an empty array will be returned.</DL>
</DD>
</DL>
<HR>

<A NAME="unregisterValueErrorHandler(org.archive.crawler.settings.ValueErrorHandler)"><!-- --></A><H3>
unregisterValueErrorHandler</H3>
<PRE>
public void <B>unregisterValueErrorHandler</B>(<A HREF="../../../../org/archive/crawler/settings/ValueErrorHandler.html" title="interface in org.archive.crawler.settings">ValueErrorHandler</A>&nbsp;errorHandler)</PRE>
<DL>
<DD>Unregister an instance of <A HREF="../../../../org/archive/crawler/settings/ValueErrorHandler.html" title="interface in org.archive.crawler.settings"><CODE>ValueErrorHandler</CODE></A>.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>errorHandler</CODE> - the <code>CalueErrorHandler</code> to unregister.<DT><B>See Also:</B><DD><A HREF="../../../../org/archive/crawler/settings/ValueErrorHandler.html" title="interface in org.archive.crawler.settings"><CODE>ValueErrorHandler</CODE></A>, 
<A HREF="../../../../org/archive/crawler/settings/SettingsHandler.html#setErrorReportingLevel(java.util.logging.Level)"><CODE>setErrorReportingLevel(Level)</CODE></A>, 
<A HREF="../../../../org/archive/crawler/settings/SettingsHandler.html#registerValueErrorHandler(org.archive.crawler.settings.ValueErrorHandler)"><CODE>registerValueErrorHandler(ValueErrorHandler)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="registerValueErrorHandler(org.archive.crawler.settings.ValueErrorHandler)"><!-- --></A><H3>
registerValueErrorHandler</H3>
<PRE>
public void <B>registerValueErrorHandler</B>(<A HREF="../../../../org/archive/crawler/settings/ValueErrorHandler.html" title="interface in org.archive.crawler.settings">ValueErrorHandler</A>&nbsp;errorHandler)</PRE>
<DL>
<DD>Register an instance of <A HREF="../../../../org/archive/crawler/settings/ValueErrorHandler.html" title="interface in org.archive.crawler.settings"><CODE>ValueErrorHandler</CODE></A>.
 <p>
 If a ValueErrorHandler is registered, only constraints with level
 <CODE>Level.SEVERE</CODE>will throw an <CODE>InvalidAttributeValueException</CODE>.
 The ValueErrorHandler will recieve a notification for all failed checks
 with level equal or greater than the error reporting level.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>errorHandler</CODE> - the <code>CalueErrorHandler</code> to register.<DT><B>See Also:</B><DD><A HREF="../../../../org/archive/crawler/settings/ValueErrorHandler.html" title="interface in org.archive.crawler.settings"><CODE>ValueErrorHandler</CODE></A>, 
<A HREF="../../../../org/archive/crawler/settings/SettingsHandler.html#setErrorReportingLevel(java.util.logging.Level)"><CODE>setErrorReportingLevel(Level)</CODE></A>, 
<A HREF="../../../../org/archive/crawler/settings/SettingsHandler.html#unregisterValueErrorHandler(org.archive.crawler.settings.ValueErrorHandler)"><CODE>unregisterValueErrorHandler(ValueErrorHandler)</CODE></A></DL>
</DD>
</DL>
<HR>

<A NAME="fireValueErrorHandlers(org.archive.crawler.settings.Constraint.FailedCheck)"><!-- --></A><H3>
fireValueErrorHandlers</H3>
<PRE>
boolean <B>fireValueErrorHandlers</B>(<A HREF="../../../../org/archive/crawler/settings/Constraint.FailedCheck.html" title="class in org.archive.crawler.settings">Constraint.FailedCheck</A>&nbsp;error)</PRE>
<DL>
<DD>Fire events on all registered <A HREF="../../../../org/archive/crawler/settings/ValueErrorHandler.html" title="interface in org.archive.crawler.settings"><CODE>ValueErrorHandler</CODE></A>.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>error</CODE> - the failed constraints return value.
<DT><B>Returns:</B><DD>true if there was any registered ValueErrorHandlers to notify.</DL>
</DD>
</DL>
<HR>

<A NAME="setErrorReportingLevel(java.util.logging.Level)"><!-- --></A><H3>
setErrorReportingLevel</H3>
<PRE>
public void <B>setErrorReportingLevel</B>(java.util.logging.Level&nbsp;level)</PRE>
<DL>
<DD>Set the level for which notification of failed constraints will be fired.
<P>
<DD><DL>
<DT><B>Parameters:</B><DD><CODE>level</CODE> - the error reporting level.</DL>
</DD>
</DL>
<HR>

<A NAME="getListOfAllFiles()"><!-- --></A><H3>
getListOfAllFiles</H3>
<PRE>
public abstract java.util.List <B>getListOfAllFiles</B>()</PRE>
<DL>
<DD>Creates and returns a <tt>List</tt> of all files comprising the current
 settings framework.

 <p>The List contains the absolute String path of each file.

 <p>The list should contain any configurable files, including such files
 as seed file and any other files use by the various settings modules.

 <p>Implementations of the SettingsHandler that do not use files for
 permanent storage should return an empty list.
<P>
<DD><DL>

<DT><B>Returns:</B><DD><code>List</code> of framework files.</DL>
</DD>
</DL>
<HR>

<A NAME="clearPerHostSettingsCache()"><!-- --></A><H3>
clearPerHostSettingsCache</H3>
<PRE>
public void <B>clearPerHostSettingsCache</B>()</PRE>
<DL>
<DD>Clear any per-host settings cached in memory; allows editting of 
 per-host settings files on disk, perhaps in bulk/automated fashion,
 to take effect in running crawl.
<P>
<DD><DL>
</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>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="class-use/SettingsHandler.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  </TR>
</TABLE>
</TD>
<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
</EM>
</TD>
</TR>

<TR>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
&nbsp;<A HREF="../../../../org/archive/crawler/settings/SettingsFrameworkTestCase.html" title="class in org.archive.crawler.settings"><B>PREV CLASS</B></A>&nbsp;
&nbsp;<A HREF="../../../../org/archive/crawler/settings/SimpleType.html" title="class in org.archive.crawler.settings"><B>NEXT CLASS</B></A></FONT></TD>
<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  <A HREF="../../../../index.html?org/archive/crawler/settings/SettingsHandler.html" target="_top"><B>FRAMES</B></A>  &nbsp;
&nbsp;<A HREF="SettingsHandler.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
&nbsp;<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:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
</TR>
</TABLE>
<A NAME="skip-navbar_bottom"></A>
<!-- ======== END OF BOTTOM NAVBAR ======= -->

<HR>
Copyright &copy; 2003-2006 Internet Archive. All Rights Reserved.
</BODY>
</HTML>