Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
SAP NetWeaver '04
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD

com.sapportals.wcm.service.crawler
Interface ICrawlerStatistics

[contained in: com.sap.km.cm.service.base.par - km.shared.service.crawler_api.jar]
Deprecated. as of NW04. The crawler service was replaced by the xcrawler service com.sapportals.wcm.service.xcrawler

public interface ICrawlerStatistics

Crawler statistics interface.

Copyright 2004 SAP AG

Method Summary
 ICrawlerVisitedEntryList getActiveEntries()
          Deprecated. Get the list of visited entries for resources currently being processed by the crawler.
 long getActiveThreadCount()
          Deprecated. Get the number of active threads for this crawl.
 long getAverageSpeed()
          Deprecated. Get the average time per document.
 long getChangedDocumentCount()
          Deprecated. Get the number of changed documents for the last/current delta crawl.
 long getCrawlTime()
          Deprecated. Get the duration of the last/current crawl.
 long getDeletedDocumentCount()
          Deprecated. Get the number of deleted documents for the last/current delta crawl.
 long getDocumentCount()
          Deprecated. Get the number of crawled documents for the last/current crawl.
 long getExceptionCount()
          Deprecated. Get the number of exceptions which happend during the crawl.
 long getFileCount()
          Deprecated. Get the number of crawled files for the last/current crawl.
 long getFolderCount()
          Deprecated. Get the number of crawled folders for the last/current crawl.
 long getFoundCount()
          Deprecated. Get the number of documents in the found list for the current crawl.
 java.util.Date getLastDate()
          Deprecated. Get the date when the last counted document.
 java.lang.Thread getMainThread()
          Deprecated. Get the crawler's main thread if running.
 long getNewDocumentCount()
          Deprecated. Get the number of new documents for the last/current delta crawl.
 long getRepositoryRatio()
          Deprecated. Get the ratio of the time spent for getting the resource (in the repository) vs. processing the found resources (by the result receiver). 100 percent means that all the time was consumed for retrieving the resources, 0 percent means that all time was consumed by the result receiver.
 java.util.Date getStartDate()
          Deprecated. Get the start date of the last/current crawl.
 java.util.Date getStopDate()
          Deprecated. Get the stop date of the last crawl.
 java.util.Collection getThreads()
          Deprecated. Get the crawler's threads if running.
 long getToDoCount()
          Deprecated. Get the number of documents in the todo list for the current crawl.
 boolean isDelta()
          Deprecated. Test, if the crawler performs a delta crawl.
 boolean wasAbnormalEnd()
          Deprecated. Get the "abnormal end" flag.
 boolean wasStopped()
          Deprecated. Get the "stopped" flag.
 

Method Detail

isDelta

public boolean isDelta()
Deprecated. 
Test, if the crawler performs a delta crawl.
Returns:
true if and only if the crawler performs a delta crawl.

getMainThread

public java.lang.Thread getMainThread()
Deprecated. 
Get the crawler's main thread if running.
Returns:
a Thread with the crawler's main thread or null if the crawler's not running.

getThreads

public java.util.Collection getThreads()
Deprecated. 
Get the crawler's threads if running.
Returns:
a Collection of threads with the crawler's threads or null if the crawler's not running.

getStartDate

public java.util.Date getStartDate()
Deprecated. 
Get the start date of the last/current crawl.
Returns:
a Date with the start of the last crawl.

getStopDate

public java.util.Date getStopDate()
Deprecated. 
Get the stop date of the last crawl.
Returns:
a Date with the stop of the last crawl or null if the crawler is still running.

getLastDate

public java.util.Date getLastDate()
Deprecated. 
Get the date when the last counted document.
Returns:
a Date with the time, when the last document was counted or null if the crawler is not running.

getCrawlTime

public long getCrawlTime()
Deprecated. 
Get the duration of the last/current crawl.
Returns:
a long with the elapsed time (if the crawler is currently running) or with the delta of stop-start (for the last crawl). The time is given in milli-seconds.

getToDoCount

public long getToDoCount()
Deprecated. 
Get the number of documents in the todo list for the current crawl.
Returns:
a long with the number of todo entries.

getFoundCount

public long getFoundCount()
Deprecated. 
Get the number of documents in the found list for the current crawl.
Returns:
a long with the number of found entries.

getDocumentCount

public long getDocumentCount()
Deprecated. 
Get the number of crawled documents for the last/current crawl.
Returns:
a long with the number of crawled documents.

getFolderCount

public long getFolderCount()
Deprecated. 
Get the number of crawled folders for the last/current crawl. For a finished crawler the number of folders plus the number of files equals the number of documents.
Returns:
a long with the number of crawled folders.

getFileCount

public long getFileCount()
Deprecated. 
Get the number of crawled files for the last/current crawl. For a finished crawler the number of folders plus the number of files equals the number of documents.
Returns:
a long with the number of crawled files.

getNewDocumentCount

public long getNewDocumentCount()
Deprecated. 
Get the number of new documents for the last/current delta crawl.
Returns:
a long with the number of new documents.

getChangedDocumentCount

public long getChangedDocumentCount()
Deprecated. 
Get the number of changed documents for the last/current delta crawl.
Returns:
a long with the number of changed documents.

getDeletedDocumentCount

public long getDeletedDocumentCount()
Deprecated. 
Get the number of deleted documents for the last/current delta crawl.
Returns:
a long with the number of deleted documents.

getExceptionCount

public long getExceptionCount()
Deprecated. 
Get the number of exceptions which happend during the crawl.
Returns:
a long with the number of exceptions.

getAverageSpeed

public long getAverageSpeed()
Deprecated. 
Get the average time per document.
Returns:
a long with the average time per document in milli-seconds.

getRepositoryRatio

public long getRepositoryRatio()
Deprecated. 
Get the ratio of the time spent for getting the resource (in the repository) vs. processing the found resources (by the result receiver). 100 percent means that all the time was consumed for retrieving the resources, 0 percent means that all time was consumed by the result receiver.
Returns:
a long with the ratio in percent times 100 (percent * 100).

getActiveThreadCount

public long getActiveThreadCount()
Deprecated. 
Get the number of active threads for this crawl.
Returns:
a long with the # of active threads.

wasStopped

public boolean wasStopped()
Deprecated. 
Get the "stopped" flag.
Returns:
a boolean trueif the crawler was stopped by an administrator, false if not.

wasAbnormalEnd

public boolean wasAbnormalEnd()
Deprecated. 
Get the "abnormal end" flag.
Returns:
a boolean trueif the crawler terminated abnormally, false if not.

getActiveEntries

public ICrawlerVisitedEntryList getActiveEntries()
Deprecated. 
Get the list of visited entries for resources currently being processed by the crawler. Those isFound() == false are processed by the retrievers, those with isFound() == true are processed by the providers.
Returns:
a ICrawlerVisitedList with the list of visited entries.
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
SAP NetWeaver '04
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD
Copyright © 2004 by SAP AG. All Rights Reserved.
SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary.

These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.