Java Doc for CrawlerSettings.java in  » Web-Crawler » heritrix » org » archive » crawler » settings » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » Web Crawler » heritrix » org.archive.crawler.settings 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


java.lang.Object
   org.archive.crawler.settings.CrawlerSettings

CrawlerSettings
public class CrawlerSettings (Code)
Class representing a settings file. More precisely it represents a collection of settings valid in a particular scope. The scope is either the global settings, or the settings to be used for a particular domain or host. For scopes other than global, the instance will only contain those settings that are different from the global. In the default implementation this is a one to one mapping from a file to an instance of this class, but in other implementations the information in an instance of this class might be stored in a different way (for example in a RDBMS).
author:
   John Erik Halse



Constructor Summary
public  CrawlerSettings(SettingsHandler handler, String scope)
     Constructs a new CrawlerSettings object. Application code should not call the constructor directly, but use the methods in SettingsHandler instead.
Parameters:
  handler - The SettingsHandler this object belongs to.
Parameters:
  scope - The scope of this settings object (ie.
public  CrawlerSettings(SettingsHandler handler, String scope, String refinement)
     Constructs a new CrawlerSettings object which is a refinement of another settings object. Application code should not call the constructor directly, but use the methods in SettingsHandler instead.
Parameters:
  handler - The SettingsHandler this object belongs to.
Parameters:
  scope - The scope of this settings object (ie.

Method Summary
protected  DataContaineraddComplexType(ComplexType type)
    
public  voidaddRefinement(Refinement refinement)
     Add a refinement to this settings object.
protected  voidaddTopLevelModule(ModuleType module)
    
public  StringgetAudience()
     Get the audience/customer/recipient of the crawl job product from this CrawlerSettings object.
protected  DataContainergetData(ComplexType complex)
    
protected  DataContainergetData(String absoluteName)
    
public  StringgetDescription()
     Get the description of this CrawlerSettings object.
public  DategetLastSavedTime()
     Get the time when this CrawlerSettings was last saved to persistent storage. the time when this CrawlerSettings was last saved to persistentstorage.
public  ModuleTypegetModule(String name)
    
public  StringgetName()
     Get the name of this CrawlerSettings object.
public  StringgetOperator()
     Get the name of operator of this crawl from this CrawlerSettings object.
public  StringgetOrganization()
     Get the name of the organization running this crawl from this CrawlerSettings object.
public  CrawlerSettingsgetParent()
     Get the parent of this CrawlerSettings object.
public  CrawlerSettingsgetParent(UURI uri)
     Get the parent of this CrawlerSettings object. This method passes around a URI so that refinements could be checked.
Parameters:
  uri - The uri for which parents of this object shoul be found.
public  RefinementgetRefinement(String reference)
     Get a refinement with a given reference.
Parameters:
  reference - the reference (name) to the refinement to get.
public  StringgetScope()
     Get the scope of this CrawlerSettings object.
public  SettingsHandlergetSettingsHandler()
     Get the SettingHandler this CrawlerSettings object belongs to.
protected  ModuleTypegetTopLevelModule(String name)
    
public  booleanhasRefinements()
     Returns true if this settings object has refinements attached to it.
public  booleanisRefinement()
     Returns true if this settings object is a refinement.
public  ListIteratorrefinementsIterator()
     Get an ListIterator over the refinements for this settings object.
public  booleanremoveRefinement(String reference)
     Remove a refinement from this settings object.
Parameters:
  reference - the reference (name) to the refinement to be removed.
public  voidsetAudience(String name)
     Set the recipient/customer for the crawl job product.
public  voidsetDescription(String string)
     Set the description of this CrawlerSettings object.
protected  voidsetLastSavedTime(Date lastSaved)
     Set the time when this CrawlerSettings was last saved to persistent storage.
public  voidsetName(String string)
     Set the name of this CrawlerSettings object.
public  voidsetOperator(String name)
     Set the operator of this crawl job.
public  voidsetOrganization(String name)
     Set the name of the organization who is running this crawl.
public  voidsetRefinement(boolean isRefinement)
     Mark this settings object as an refinement.
protected  IteratortopLevelModules()
    


Constructor Detail
CrawlerSettings
public CrawlerSettings(SettingsHandler handler, String scope)(Code)
Constructs a new CrawlerSettings object. Application code should not call the constructor directly, but use the methods in SettingsHandler instead.
Parameters:
  handler - The SettingsHandler this object belongs to.
Parameters:
  scope - The scope of this settings object (ie. host or domain).
See Also:   SettingsHandler.getSettings(String)
See Also:   SettingsHandler.getSettingsObject(String)



CrawlerSettings
public CrawlerSettings(SettingsHandler handler, String scope, String refinement)(Code)
Constructs a new CrawlerSettings object which is a refinement of another settings object. Application code should not call the constructor directly, but use the methods in SettingsHandler instead.
Parameters:
  handler - The SettingsHandler this object belongs to.
Parameters:
  scope - The scope of this settings object (ie. host or domain).
Parameters:
  refinement - the name or reference to the refinement.
See Also:   SettingsHandler.getSettings(String)
See Also:   SettingsHandler.getSettingsObject(String)




Method Detail
addComplexType
protected DataContainer addComplexType(ComplexType type)(Code)



addRefinement
public void addRefinement(Refinement refinement)(Code)
Add a refinement to this settings object.
Parameters:
  refinement - The refinements to set.



addTopLevelModule
protected void addTopLevelModule(ModuleType module)(Code)



getAudience
public String getAudience()(Code)
Get the audience/customer/recipient of the crawl job product from this CrawlerSettings object. the audience/customer/recipient of the crawl job product.



getData
protected DataContainer getData(ComplexType complex)(Code)



getData
protected DataContainer getData(String absoluteName)(Code)



getDescription
public String getDescription()(Code)
Get the description of this CrawlerSettings object. the description of this CrawlerSettings object.



getLastSavedTime
public Date getLastSavedTime()(Code)
Get the time when this CrawlerSettings was last saved to persistent storage. the time when this CrawlerSettings was last saved to persistentstorage. Null if it has not been saved.



getModule
public ModuleType getModule(String name)(Code)



getName
public String getName()(Code)
Get the name of this CrawlerSettings object. the name of this CrawlerSettings object.



getOperator
public String getOperator()(Code)
Get the name of operator of this crawl from this CrawlerSettings object. the name of this CrawlerSettings object.



getOrganization
public String getOrganization()(Code)
Get the name of the organization running this crawl from this CrawlerSettings object. the name of the organization running this crawl.



getParent
public CrawlerSettings getParent()(Code)
Get the parent of this CrawlerSettings object. the parent of this CrawlerSettings object.



getParent
public CrawlerSettings getParent(UURI uri)(Code)
Get the parent of this CrawlerSettings object. This method passes around a URI so that refinements could be checked.
Parameters:
  uri - The uri for which parents of this object shoul be found. the parent of this CrawlerSettings object.



getRefinement
public Refinement getRefinement(String reference)(Code)
Get a refinement with a given reference.
Parameters:
  reference - the reference (name) to the refinement to get. the refinement having the specified reference or null if norefinement matches it.



getScope
public String getScope()(Code)
Get the scope of this CrawlerSettings object. the scope of this CrawlerSettings object.



getSettingsHandler
public SettingsHandler getSettingsHandler()(Code)
Get the SettingHandler this CrawlerSettings object belongs to. the SettingHandler this CrawlerSettings object belongs to.



getTopLevelModule
protected ModuleType getTopLevelModule(String name)(Code)



hasRefinements
public boolean hasRefinements()(Code)
Returns true if this settings object has refinements attached to it. true if this settings object has refinements attached to it.



isRefinement
public boolean isRefinement()(Code)
Returns true if this settings object is a refinement. true if this settings object is a refinement.



refinementsIterator
public ListIterator refinementsIterator()(Code)
Get an ListIterator over the refinements for this settings object. Returns an iterator over the refinements.



removeRefinement
public boolean removeRefinement(String reference)(Code)
Remove a refinement from this settings object.
Parameters:
  reference - the reference (name) to the refinement to be removed. true if something was removed, false if the refinement was notfound.



setAudience
public void setAudience(String name)(Code)
Set the recipient/customer for the crawl job product.
Parameters:
  name - Recipient of crawl job product.



setDescription
public void setDescription(String string)(Code)
Set the description of this CrawlerSettings object.
Parameters:
  string - the description to be set for this CrawlerSettings object.



setLastSavedTime
protected void setLastSavedTime(Date lastSaved)(Code)
Set the time when this CrawlerSettings was last saved to persistent storage.
Parameters:
  lastSaved - the time when this CrawlerSettings was last saved topersistent storage.



setName
public void setName(String string)(Code)
Set the name of this CrawlerSettings object.
Parameters:
  string - the name to be set for this CrawlerSettings object.



setOperator
public void setOperator(String name)(Code)
Set the operator of this crawl job.
Parameters:
  name - Operator running this crawl.



setOrganization
public void setOrganization(String name)(Code)
Set the name of the organization who is running this crawl.
Parameters:
  name - Name of organization running this crawl.



setRefinement
public void setRefinement(boolean isRefinement)(Code)
Mark this settings object as an refinement.
Parameters:
  isRefinement - Set this to true if this settings object is arefinement.



topLevelModules
protected Iterator topLevelModules()(Code)



Methods inherited from java.lang.Object
native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.