com.sapportals.wcm.service.xcrawler

Interface IXCrawlerTaskSummary

public interface IXCrawlerTaskSummary

State summary of a crawler task.
Changes between major releases 7.0 and 7.X:
Added methods:

'public boolean getActive()'

'public IXCrawlerTaskSummary$IOperation getCurrentOperation()'

'public long getVariantsCount()'

Added classes:

'IOperation'

'OperationType'

Copyright (c) SAP AG 2003

Nested Class Summary

static interface	IXCrawlerTaskSummary.IOperation Operations carried out in crawler states Added in 7.X
static class	IXCrawlerTaskSummary.OperationType Types of operations within crawler states Added in 7.X
static class	IXCrawlerTaskSummary.TaskState States of a crawler task.
static class	IXCrawlerTaskSummary.ThreadState States of a crawler thread.

Method Summary

boolean	getActive() Check, if the crawler task is still active running.
long	getBadLinkCount() Get the number of links to unavailable resources.
long	getChangedCount() Get the number of changed resources which already have been provided during an incremental update.
Date	getCrawlEnd() Get the date when the crawler task was finished.
Date	getCrawlStart() Get the date when the crawler task was started with the run() method.
IXCrawlerTaskSummary.IOperation	getCurrentOperation() Get the current operation of the crawler.
String[]	getCurrentPostprocessorDocuments()
String[]	getCurrentProviderDocuments()
String[]	getCurrentRetrieverDocuments() Get the documents the threads are currently retrieving from the repository framework.
long	getDeletedCount() Get the number of deleted resources which already have been provided during an incremental update.
boolean	getDelta() Check, if the crawler task is doing an incremental update.
long	getErrorCount() Get the number of CrawlerResources in the error-set.
RID	getErrorLogFileRID()
long	getFilteredCount() Get the number of filtered resources.
long	getFinishedCount() Get the number of CrawlerResources in the finished-set.
RID	getFirstStartResource() Get the displayname of the first start resource.
long	getFoundCount() Get the number of CrawlerResources in the found-set.
RID	getInfoLogFileRID() Get the RIDs of the current crawler task log files (for the first set of start resources).
Date	getLastUpdated() Get the date when the summary was last updated by the crawler task in the database.
long	getNewCount() Get the number of new resources which already have been provided during an incremental update.
long	getOldCount() Get the number of CrawlerResources in the old-set.
long	getPostprocessedCount() Get the number of CrawlerResources in the postprocessed-set.
long	getPostprocessingCount() Get the number of CrawlerResources in the postprocessing-set.
IXCrawlerTaskSummary.ThreadState[]	getPostprocessorStates() Get the state of the postprocessor threads.
long	getProcessedCount() Get the number of processed documents.
long	getProcessErrorCount() Get the number of errors which occurred while the crawler was processing resources.
long	getProvideErrorCount() Get the number of errors which occurred in the result receiver while the crawler was providing resources.
IXCrawlerTaskSummary.ThreadState[]	getProviderStates() Get the state of the provider threads.
long	getProvidingAverage() Get the average time which has been spent for providing the last 50 resources to the result receiver in milliseconds.
long	getProvidingCount() Get the number of CrawlerResources in the providing-set.
long	getProvidingTime() Get the amount of time which has been spent for providing resources to the result receiver in milliseconds.
long	getReceivedCount() Get the number of resources which already have been provided during a normal crawl.
long	getRejectedCount() Get the number of CrawlerResources in the rejected-set.
long	getResourceErrorCount() Get the number of errors which occurred in the repository while the crawler was retrieving resources.
IXCrawlerTaskSummary.ThreadState[]	getRetrieverStates() Get the state of the retriever threads.
long	getRetrievingAverage() Get the average time which has been spent for retrieving the last 50 resources from repositories in milliseconds.
long	getRetrievingCount() Get the number of CrawlerResources in the retrieving-set.
long	getRetrievingTime() Get the amount of time which has been spent for retrieving resources from repositories in milliseconds.
IXCrawlerTaskSummary.TaskState	getState() Get the state of the crawler task.
String	getSystemID() Get the ID of the CM system the crawler tasks runs on.
String	getTaskDisplayName() Get the display name of the crawler task this summary is for.
String	getTaskID() Get the ID of the crawler task this summary is for.
boolean	getTest() Check, if the crawler task runs in test mode.
long	getTodoCount() Get the number of CrawlerResources in the todo-set.
long	getUnvisitedChangedCount() Get the number of unvisited changed resources which already have been provided during an incremental update.
long	getUnvisitedCount() Get the number of unvisited unchanged resources which already have been provided during an incremental update.
long	getUnvisitedDeletedCount() Get the number of unvisited deleted resources which already have been provided during an incremental update.
long	getUnvisitedResourceErrorCount() Get the number of errors which occurred in the repository while the crawler was retrieving unvisited resources.
long	getVariantsCount() Get the number of provided variants.
long	getVersionsCount() Get the number of provided versions.
long	getWaitingTime() Get the amount of time which has been spent while waiting during request delays in milliseconds.

Method Detail

getLastUpdated

Date getLastUpdated()

Get the date when the summary was last updated by the crawler task in the database.

Returns:

the date when the summary was last updated by the crawler task in the database

getTaskID

String getTaskID()

Get the ID of the crawler task this summary is for.

Returns:

the ID of the crawler task this summary is for

getTaskDisplayName

String getTaskDisplayName()

Get the display name of the crawler task this summary is for.

Returns:

the display name of the crawler task this summary is for

getSystemID

String getSystemID()

Get the ID of the CM system the crawler tasks runs on.

Returns:

the ID of the CM system the crawler tasks runs on

getCrawlStart

Date getCrawlStart()

Get the date when the crawler task was started with the run() method.

Returns:

the date when the crawler task was started with the run() method

getCrawlEnd

Date getCrawlEnd()

Get the date when the crawler task was finished.

Returns:

the date when the crawler task was finished (may be null)

getDelta

boolean getDelta()

Check, if the crawler task is doing an incremental update.

Returns:

true if the crawler task is doing an incremental update

getTest

boolean getTest()

Check, if the crawler task runs in test mode.

Returns:

true if the crawler task runs in test mode

getActive

boolean getActive()

Check, if the crawler task is still active running.
Added in 7.X

Returns:

true if the crawler task is active running.

getState

IXCrawlerTaskSummary.TaskState getState()

Get the state of the crawler task.

Returns:

the state of the crawler task

getCurrentOperation

IXCrawlerTaskSummary.IOperation getCurrentOperation()

Get the current operation of the crawler.
Added in 7.X

Returns:

the operation (may be null)

getTodoCount

long getTodoCount()

Get the number of CrawlerResources in the todo-set.

Returns:

the number of CrawlerResources in the todo-set

getRetrievingCount

long getRetrievingCount()

Get the number of CrawlerResources in the retrieving-set.

Returns:

the number of CrawlerResources in the retrieving-set

getFoundCount

long getFoundCount()

Get the number of CrawlerResources in the found-set.

Returns:

the number of CrawlerResources in the found-set

getProvidingCount

long getProvidingCount()

Get the number of CrawlerResources in the providing-set.

Returns:

the number of CrawlerResources in the providing-set

getFinishedCount

long getFinishedCount()

Get the number of CrawlerResources in the finished-set.

Returns:

the number of CrawlerResources in the finished-set

getOldCount

long getOldCount()

Get the number of CrawlerResources in the old-set.

Returns:

the number of CrawlerResources in the old-set

getPostprocessingCount

long getPostprocessingCount()

Get the number of CrawlerResources in the postprocessing-set.

Returns:

the number of CrawlerResources in the postprocessing-set

getPostprocessedCount

long getPostprocessedCount()

Get the number of CrawlerResources in the postprocessed-set.

Returns:

the number of CrawlerResources in the postprocessed-set

getErrorCount

long getErrorCount()

Get the number of CrawlerResources in the error-set.

Returns:

the number of CrawlerResources in the error-set

getRejectedCount

long getRejectedCount()

Get the number of CrawlerResources in the rejected-set.

Returns:

the number of CrawlerResources in the rejected-set

getReceivedCount

long getReceivedCount()

Get the number of resources which already have been provided during a normal crawl.

Returns:

the number of resources which already have been provided during a normal crawl

getNewCount

long getNewCount()

Get the number of new resources which already have been provided during an incremental update.

Returns:

the number of new resources which already have been provided during an incremental update

getChangedCount

long getChangedCount()

Get the number of changed resources which already have been provided during an incremental update.

Returns:

the number of changed resources which already have been provided during an incremental update

getDeletedCount

long getDeletedCount()

Get the number of deleted resources which already have been provided during an incremental update.

Returns:

the number of deleted resources which already have been provided during an incremental update

getUnvisitedCount

long getUnvisitedCount()

Get the number of unvisited unchanged resources which already have been provided during an incremental update.

Returns:

the number of unvisited unchanged resources which already have been provided during an incremental update

getUnvisitedChangedCount

long getUnvisitedChangedCount()

Get the number of unvisited changed resources which already have been provided during an incremental update.

Returns:

the number of unvisited changed resources which already have been provided during an incremental update

getUnvisitedDeletedCount

long getUnvisitedDeletedCount()

Get the number of unvisited deleted resources which already have been provided during an incremental update.

Returns:

the number of unvisited deleted resources which already have been provided during an incremental update

getProcessErrorCount

long getProcessErrorCount()

Get the number of errors which occurred while the crawler was processing resources.

Returns:

the number of errors which occurred while the crawler was processing resources

getProvideErrorCount

long getProvideErrorCount()

Get the number of errors which occurred in the result receiver while the crawler was providing resources.

Returns:

the number of errors which occurred in the result receiver while the crawler was providing resources

getResourceErrorCount

long getResourceErrorCount()

Get the number of errors which occurred in the repository while the crawler was retrieving resources.

Returns:

the number of errors which occurred in the repository while the crawler was retrieving resources

getUnvisitedResourceErrorCount

long getUnvisitedResourceErrorCount()

Get the number of errors which occurred in the repository while the crawler was retrieving unvisited resources.

Returns:

the number of errors which occurred in the repository while the crawler was retrieving unvisited resources

getBadLinkCount

long getBadLinkCount()

Get the number of links to unavailable resources.

Returns:

the number of links to unavailable resources

getFilteredCount

long getFilteredCount()

Get the number of filtered resources.

Returns:

the number of filtered resources

getVersionsCount

long getVersionsCount()

Get the number of provided versions.

Returns:

the number of provided versions

getVariantsCount

long getVariantsCount()

Get the number of provided variants.
Added in 7.X

Returns:

the number of provided variants

getProcessedCount

long getProcessedCount()

Get the number of processed documents.

Returns:

the number of processed documents

getRetrievingTime

long getRetrievingTime()

Get the amount of time which has been spent for retrieving resources from repositories in milliseconds.

Returns:

the amount of time which has been spent for retrieving resources from repositories in milliseconds

getProvidingTime

long getProvidingTime()

Get the amount of time which has been spent for providing resources to the result receiver in milliseconds.

Returns:

the amount of time which has been spent for providing resources to the result receiver in milliseconds

getWaitingTime

long getWaitingTime()

Get the amount of time which has been spent while waiting during request delays in milliseconds.

Returns:

the amount of time which has been spent while waiting during request delays in milliseconds

getRetrievingAverage

long getRetrievingAverage()

Get the average time which has been spent for retrieving the last 50 resources from repositories in milliseconds.

Returns:

the average time which has been spent for retrieving the last 50 resources from repositories in milliseconds

getProvidingAverage

long getProvidingAverage()

Get the average time which has been spent for providing the last 50 resources to the result receiver in milliseconds.

Returns:

the average time which has been spent for providing the last 50 resources to the result receiver in milliseconds

getRetrieverStates

IXCrawlerTaskSummary.ThreadState[] getRetrieverStates()

Get the state of the retriever threads.

Returns:

the state of the retriever threads (may be null)

getProviderStates

IXCrawlerTaskSummary.ThreadState[] getProviderStates()

Get the state of the provider threads.

Returns:

the state of the provider threads (may be null)

getPostprocessorStates

IXCrawlerTaskSummary.ThreadState[] getPostprocessorStates()

Get the state of the postprocessor threads.

Returns:

the state of the postprocessor threads (may be null)

getFirstStartResource

RID getFirstStartResource()

Get the displayname of the first start resource.

Returns:

the displayname of the first start resource

getCurrentRetrieverDocuments

String[] getCurrentRetrieverDocuments()

Get the documents the threads are currently retrieving from the repository framework.
The format of the returned Stings is
Time denotes the moment when the crawler started to retrieve the document.

Returns:

the documents the threads are currently retrieving from the repository framework

getCurrentProviderDocuments

String[] getCurrentProviderDocuments()

getCurrentPostprocessorDocuments

String[] getCurrentPostprocessorDocuments()

getInfoLogFileRID

RID getInfoLogFileRID()

Get the RIDs of the current crawler task log files (for the first set of start resources).

Returns:

the RIDs of the current crawler task log files (for the first set of start resources)

getErrorLogFileRID

RID getErrorLogFileRID()

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM