com.sapportals.wcm.service.crawler
Interface ICrawlerVisitedList

[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 ICrawlerVisitedList

A crawler's list of visited resources, handled as ICrawlerVisitedListEntrys.

Copyright 2004 SAP AG

Method Summary

ICrawlerVisitedEntry	addEntry(RID resourceID) Deprecated. Create a new 'found' entry for a given resource ID, overwrite if alread exists.
void	clearAllEntries() Deprecated. Clear the list (treat as uncrawled).
ICrawlerVisitedEntry	createEntry(RID resourceID) Deprecated. Create a new 'found' entry for a given resource ID.
ICrawlerVisitedEntry	deleteEntry(RID resourceID) Deprecated. Delete an entry from the database for a given resource ID.
java.lang.String	getCrawlID() Deprecated. Get the id of the crawl, this visited list is for.
ICrawlerVisitedEntry	getEntry(RID resourceID) Deprecated. Search an entry for a given resource ID.
ICrawlerVisitedEntryIterator	getIterator(boolean includeFound, boolean includeVisited, boolean includeError, boolean includeExcluded, RID startRID) Deprecated. Get an iterator for a list of entries, which matches the given criterias.
java.util.Date	getLastCrawlStart() Deprecated. Get the timestamp of the last crawl start.
IRidList	getLastCrawlStartRIDList() Deprecated. Get the list with IDs of the start resources which where used for the last crawl.
boolean	isPersistent() Deprecated. Check if this list is persistent and supports the set... methods.
void	setCrawlStart(IResourceList resources) Deprecated. (Re-)Set the list of resources to start crawling with.
ICrawlerVisitedEntry	setExcluded(ICrawlerVisitedEntry entry) Deprecated. Mark an entry as excluded.
ICrawlerVisitedEntry	setUnvisited(ICrawlerVisitedEntry entry) Deprecated. Mark an entry as unvisited.
ICrawlerVisitedEntry	setVisited(ICrawlerVisitedEntry entry) Deprecated. Mark an entry as visited.

Method Detail

isPersistent

public boolean isPersistent()

Deprecated.

Check if this list is persistent and supports the set... methods.

Returns:

a boolean true if the list is persistent, false if not.

getCrawlID

public java.lang.String getCrawlID()

Deprecated.

Get the id of the crawl, this visited list is for.

Returns:

a String with the ID that was used to identify the crawl.

getLastCrawlStart

public java.util.Date getLastCrawlStart()
                                 throws WcmException

Deprecated.

Get the timestamp of the last crawl start.

Returns:

a Date with the timestamp of the last crawl or null if the the last date is not known (either no crawl for the crawl ID or it's a non-persistent list and no crawl for this ID since the last system restart).

Throws:

WcmException - if an error occured.

getLastCrawlStartRIDList

public IRidList getLastCrawlStartRIDList()
                                  throws WcmException

Deprecated.

Get the list with IDs of the start resources which where used for the last crawl.

Returns:

a IRidList with the ID of resources for the last crawl or null if getLastCrawlStart() is null.

Throws:

WcmException - if an error occured.

getEntry

public ICrawlerVisitedEntry getEntry(RID resourceID)
                              throws WcmException

Deprecated.

Search an entry for a given resource ID.

Parameters:

resourceID - a RID with the ID of the resource to get the entry for.

Returns:

a ICrawlerVisitedEntry with the found entry or null if no entry found for the given resource ID.

Throws:

WcmException - if an error occured.

setCrawlStart

public void setCrawlStart(IResourceList resources)
                   throws WcmException

Deprecated.

(Re-)Set the list of resources to start crawling with.

Parameters:

resources - a IResourceList with the resources to start the crawl at.

Throws:

WcmException - if an error occured.

createEntry

public ICrawlerVisitedEntry createEntry(RID resourceID)
                                 throws WcmException

Deprecated.

Create a new 'found' entry for a given resource ID.

Parameters:

resourceID - a RID with the ID of the resource to create a new 'found' entry for.

Returns:

a ICrawlerVisitedEntry with the created entry or null if the entry already exists.

Throws:

WcmException - if an error occured.

addEntry

public ICrawlerVisitedEntry addEntry(RID resourceID)
                              throws WcmException

Deprecated.

Create a new 'found' entry for a given resource ID, overwrite if alread exists.

Parameters:

resourceID - a RID with the ID of the resource to create a new 'found' entry for.

Returns:

a ICrawlerVisitedEntry with the added entry or the entry found, if it already exists.

Throws:

WcmException - if an error occured.

deleteEntry

public ICrawlerVisitedEntry deleteEntry(RID resourceID)
                                 throws WcmException

Deprecated.

Delete an entry from the database for a given resource ID.

Parameters:

resourceID - a RID with the ID of the resource to delete the entry for.

Returns:

a ICrawlerVisitedEntry with the deleted entry or null if the entry was not found.

Throws:

WcmException - if an error occured.

clearAllEntries

public void clearAllEntries()
                     throws WcmException

Deprecated.

Clear the list (treat as uncrawled).

Throws:

WcmException - if an error occured.

setUnvisited

public ICrawlerVisitedEntry setUnvisited(ICrawlerVisitedEntry entry)
                                  throws WcmException

Deprecated.

Mark an entry as unvisited.

Parameters:

entry - a ICrawlerVisitedEntry with the entry to mark as unvisited.

Returns:

the ICrawlerVisitedEntry marked as unvisited or null if the entry does not exist.

Throws:

WcmException - if an error occured.

setVisited

public ICrawlerVisitedEntry setVisited(ICrawlerVisitedEntry entry)
                                throws WcmException

Deprecated.

Mark an entry as visited.

Parameters:

entry - a ICrawlerVisitedEntry with the entry to mark as visited.

Returns:

the ICrawlerVisitedEntry marked as visited or null if the entry does not exist.

Throws:

WcmException - if an error occured.

setExcluded

public ICrawlerVisitedEntry setExcluded(ICrawlerVisitedEntry entry)
                                 throws WcmException

Deprecated.

Mark an entry as excluded.

Parameters:

entry - a ICrawlerVisitedEntry with the entry to mark as excluded.

Returns:

the ICrawlerVisitedEntry marked as excluded or null if the entry does not exist.

Throws:

WcmException - if an error occured.

getIterator

public ICrawlerVisitedEntryIterator getIterator(boolean includeFound,
                                                boolean includeVisited,
                                                boolean includeError,
                                                boolean includeExcluded,
                                                RID startRID)
                                         throws WcmException

Deprecated.

Get an iterator for a list of entries, which matches the given criterias.

Parameters:

includeFound - a boolean true, if entries marked as 'found' should be included in the search.

includeVisited - a boolean true, if entries marked as 'visited' should be included in the search.

includeError - a boolean true, if entries marked as 'error' should be included in the search.

includeExcluede - a boolean true, if entries marked as 'excluded' should be included in the search.

startRID - a RID with the id of the resource to start the search at, or null to start from beginning.

Returns:

a ICrawlerVisitedEntry with the first entry that matches the given parameters or null if no such entry exists.

Throws:

WcmException - if an error occured.