Java Doc for CrawlScope.java in  » Web-Crawler » heritrix » org » archive » crawler » framework » 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.framework 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.archive.crawler.framework.Filter
   org.archive.crawler.framework.CrawlScope

All known Subclasses:   org.archive.crawler.scope.ClassicScope,  org.archive.crawler.deciderules.DecidingScope,
CrawlScope
public class CrawlScope extends Filter (Code)
A CrawlScope instance defines which URIs are "in" a particular crawl. It is essentially a Filter which determines, looking at the totality of information available about a CandidateURI/CrawlURI instamce, if that URI should be scheduled for crawling. Dynamic information inherent in the discovery of the URI -- such as the path by which it was discovered -- may be considered. Dynamic information which requires the consultation of external and potentially volatile information -- such as current robots.txt requests and the history of attempts to crawl the same URI -- should NOT be considered. Those potentially high-latency decisions should be made at another step.
author:
   gojomo


Field Summary
final public static  StringATTR_NAME
    
final public static  StringATTR_REREAD_SEEDS_ON_CONFIG
     Whether every configu change should trigger a rereading of the original seeds spec/file.
final public static  StringATTR_SEEDS
    
final public static  BooleanDEFAULT_REREAD_SEEDS_ON_CONFIG
    
protected  Set<SeedListener>seedListeners
    

Constructor Summary
public  CrawlScope(String name)
     Constructs a new CrawlScope.
public  CrawlScope()
     Default constructor.

Method Summary
public  booleanaddSeed(CandidateURI curi)
     Add a new seed to scope.
public  voidaddSeedListener(SeedListener sl)
    
protected  voidcheckClose(Iterator iter)
     Convenience method to close SeedFileIterator, if appropriate.
public  FilegetSeedfile()
    
public  voidinitialize(CrawlController controller)
     Initialize is called just before the crawler starts to run. The settings system is up and initialized so can be used.
protected  booleanisSameHost(UURI a, UURI b)
    
Parameters:
  a - First UURI of compare.
Parameters:
  b - Second UURI of compare.
protected  booleanisSeed(Object o)
     Check if a URI is in the seeds.
Parameters:
  o - the URI to check.
public  voidkickUpdate()
     Take note of a situation (such as settings edit) where involved reconfiguration (such as reading from external files) may be necessary.
public  voidlistUsedFiles(List<String> list)
    
public  voidrefreshSeeds()
     Refresh seeds.
public  Iterator<UURI>seedsIterator()
     Gets an iterator over all configured seeds.
public  Iterator<UURI>seedsIterator(Writer ignoredItemWriter)
     Gets an iterator over all configured seeds.
public  StringtoString()
    

Field Detail
ATTR_NAME
final public static String ATTR_NAME(Code)



ATTR_REREAD_SEEDS_ON_CONFIG
final public static String ATTR_REREAD_SEEDS_ON_CONFIG(Code)
Whether every configu change should trigger a rereading of the original seeds spec/file.



ATTR_SEEDS
final public static String ATTR_SEEDS(Code)



DEFAULT_REREAD_SEEDS_ON_CONFIG
final public static Boolean DEFAULT_REREAD_SEEDS_ON_CONFIG(Code)



seedListeners
protected Set<SeedListener> seedListeners(Code)




Constructor Detail
CrawlScope
public CrawlScope(String name)(Code)
Constructs a new CrawlScope.
Parameters:
  name - the name is ignored since it always have to be the value ofthe constant ATT_NAME.



CrawlScope
public CrawlScope()(Code)
Default constructor.




Method Detail
addSeed
public boolean addSeed(CandidateURI curi)(Code)
Add a new seed to scope. By default, simply appends to seeds file, though subclasses may handle differently.

This method is *not* sufficient to get the new seed scheduled in the Frontier for crawling -- it only affects the Scope's seed record (and decisions which flow from seeds).
Parameters:
  curi - CandidateUri to add true if successful, false if add failed for any reason




addSeedListener
public void addSeedListener(SeedListener sl)(Code)



checkClose
protected void checkClose(Iterator iter)(Code)
Convenience method to close SeedFileIterator, if appropriate.
Parameters:
  iter - Iterator to check if SeedFileIterator needing closing



getSeedfile
public File getSeedfile()(Code)
Seed list file or null if problem getting settings file.



initialize
public void initialize(CrawlController controller)(Code)
Initialize is called just before the crawler starts to run. The settings system is up and initialized so can be used. This initialize happens after CrawlScope.earlyInitialize(CrawlerSettings) .
Parameters:
  controller - Controller object.



isSameHost
protected boolean isSameHost(UURI a, UURI b)(Code)

Parameters:
  a - First UURI of compare.
Parameters:
  b - Second UURI of compare. True if UURIs are of same host.



isSeed
protected boolean isSeed(Object o)(Code)
Check if a URI is in the seeds.
Parameters:
  o - the URI to check. true if URI is a seed.



kickUpdate
public void kickUpdate()(Code)
Take note of a situation (such as settings edit) where involved reconfiguration (such as reading from external files) may be necessary.



listUsedFiles
public void listUsedFiles(List<String> list)(Code)



refreshSeeds
public void refreshSeeds()(Code)
Refresh seeds.



seedsIterator
public Iterator<UURI> seedsIterator()(Code)
Gets an iterator over all configured seeds. Subclasses which cache seeds in memory can override with more efficient implementation. Iterator, perhaps over a disk file, of seeds



seedsIterator
public Iterator<UURI> seedsIterator(Writer ignoredItemWriter)(Code)
Gets an iterator over all configured seeds. Subclasses which cache seeds in memory can override with more efficient implementation.
Parameters:
  ignoredItemWriter - optional writer to get ignored seed items report Iterator, perhaps over a disk file, of seeds



toString
public String toString()(Code)



Fields inherited from org.archive.crawler.framework.Filter
final public static String ATTR_ENABLED(Code)(Java Doc)

Methods inherited from org.archive.crawler.framework.Filter
public boolean accepts(Object o)(Code)(Java Doc)
protected boolean getFilterOffPosition(CrawlURI curi)(Code)(Java Doc)
protected boolean innerAccepts(Object o)(Code)(Java Doc)
public void kickUpdate()(Code)(Java Doc)
protected boolean returnTrueIfMatches(CrawlURI curi)(Code)(Java Doc)
public String toString()(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.