com.plumtree.server
Interface IPTDataSourceCrawlProvider


public interface IPTDataSourceCrawlProvider


Method Summary
 void AttachToContainerNode(com.plumtree.openfoundation.util.IXPPropertyBag pBagContainer, int lNodePreferences)
          This function requires that Initialize be called previously This function provides "state" to the CrawlProvider.
 boolean GetChildNodes(java.lang.Object pSafeArrayDocuments, java.lang.Object pSafeArrayContainers)
          The pSafeArrayDocuments Object array returns Node Location Property Bags like those that can be passed into the IPTDataSourceProvider.AttachToDocument method.
 java.lang.Object GetContainerNodeInfoAsObject(int lInfoRequested)
          Retrieve specific information about the node specified in a call to AttachToContainerNode A client that has called AttachToContainerNode may call GetContainerNodeInfo to retrieve information about the particular node we are currently on
 java.lang.String GetContainerNodeInfoAsString(int lInfoRequested)
          Retrieve specific information about the node specified in a call to AttachToContainerNode A client that has called AttachToContainerNode may call GetContainerNodeInfo to retrieve information about the particular node we are currently on
 int GetCrawlerInfoAsInt(int lInfoRequested, com.plumtree.openfoundation.util.IXPPropertyBag pBagRepositoryInfo)
          Gets Crawler Information A client may call GetCrawlerInfo to retrieve information about the crawler that is not dependent on state.
 java.lang.Object GetCrawlerInfoAsObject(int lInfoRequested, com.plumtree.openfoundation.util.IXPPropertyBag pBagRepositoryInfo)
          Gets Crawler Information A client may call GetCrawlerInfo to retrieve information about the crawler that is not dependent on state.
 java.lang.String GetCrawlerInfoAsString(int lInfoRequested, com.plumtree.openfoundation.util.IXPPropertyBag pBagRepositoryInfo)
          Gets Crawler Information A client may call GetCrawlerInfo to retrieve information about the crawler that is not dependent on state.
 void Initialize(com.plumtree.openfoundation.util.IXPPropertyBag pBagRepositoryInfo, IPTSession pSession, IPTDocumentTypeMap pDocumentTypeMap, int lWebServiceID)
          Prepares the crawl provider for repository querying
 int QueryCapability(int nCapabilityID)
          Query a particular Capability of this Crawl Provider
 

Method Detail

QueryCapability

public int QueryCapability(int nCapabilityID)
Query a particular Capability of this Crawl Provider
Parameters:
nCapabilityID - an int corresponding to a PT_CP_CAPABILITIES type
Returns:
an int indicating ( 0=fale 1=true ) support for the capability

GetCrawlerInfoAsString

public java.lang.String GetCrawlerInfoAsString(int lInfoRequested,
                                               com.plumtree.openfoundation.util.IXPPropertyBag pBagRepositoryInfo)
Gets Crawler Information A client may call GetCrawlerInfo to retrieve information about the crawler that is not dependent on state. Review the PT_CRAWL_INFO enumeration for info that you can extract. Retrieve specific information about the node specified in a call to AttachToContainerNode
Parameters:
lInfoRequested - an int for the desired PT_CRAWL_INFO type
pBagRepositoryInfo - a provider specific repository description bag
Returns:
A string formatted version of the requested crawler information

GetCrawlerInfoAsInt

public int GetCrawlerInfoAsInt(int lInfoRequested,
                               com.plumtree.openfoundation.util.IXPPropertyBag pBagRepositoryInfo)
Gets Crawler Information A client may call GetCrawlerInfo to retrieve information about the crawler that is not dependent on state. Review the PT_CRAWL_INFO enumeration for info that you can extract. Retrieve specific information about the node specified in a call to AttachToContainerNode
Parameters:
lInfoRequested - an int for the desired PT_CRAWL_INFO type
pBagRepositoryInfo - a provider specific repository description bag
Returns:
An int version of the requested crawler information

GetCrawlerInfoAsObject

public java.lang.Object GetCrawlerInfoAsObject(int lInfoRequested,
                                               com.plumtree.openfoundation.util.IXPPropertyBag pBagRepositoryInfo)
Gets Crawler Information A client may call GetCrawlerInfo to retrieve information about the crawler that is not dependent on state. Review the PT_CRAWL_INFO enumeration for info that you can extract. Retrieve specific information about the node specified in a call to AttachToContainerNode
Parameters:
lInfoRequested - an int for the desired PT_CRAWL_INFO type
pBagRepositoryInfo - a provider specific repository description bag
Returns:
An Object version of the requested crawler information

Initialize

public void Initialize(com.plumtree.openfoundation.util.IXPPropertyBag pBagRepositoryInfo,
                       IPTSession pSession,
                       IPTDocumentTypeMap pDocumentTypeMap,
                       int lWebServiceID)
Prepares the crawl provider for repository querying
Parameters:
pBagRepositoryInfo - a provider formatted property bag
pSession - a user session
pDocumentTypeMap - The document type map used for discovering document types
lWebServiceID - The web service ID upon which this provider relies

AttachToContainerNode

public void AttachToContainerNode(com.plumtree.openfoundation.util.IXPPropertyBag pBagContainer,
                                  int lNodePreferences)
This function requires that Initialize be called previously This function provides "state" to the CrawlProvider. It sets the "start" of the crawl- subsequent calls to GetChildNodes will return the direct descendents of the node specified in AttachToContainerNode. The lNodePreferences argument tells the crawler what types of children are of interest. Tell this CrawlProvider where to start getting children
Parameters:
pBagContainer - A provider specific property bag identifying a container node
lNodePreferences - an int indicating whether document and/or containers are needed (PT_CRAWLPROVIDER_GETCHILDNODEMASK)

GetChildNodes

public boolean GetChildNodes(java.lang.Object pSafeArrayDocuments,
                             java.lang.Object pSafeArrayContainers)
The pSafeArrayDocuments Object array returns Node Location Property Bags like those that can be passed into the IPTDataSourceProvider.AttachToDocument method. The pSafeArrayDocuments Object array returns Container Property Bags which can be passed in to IPTDataSourceCrawlProvider.AttachToContainerNode. The pbDone return value indicates if there are more nodes to return. If GetChildNodes returns false, the caller should call it again, to retrieve more nodes.
Parameters:
pSafeArrayDocuments - an empty Object to be populated with a document nodes array
pSafeArrayContainers - an empty Object to be populated with a container nodes array
Returns:
a boolean indicating whether more nodes remain to be retrieved

GetContainerNodeInfoAsString

public java.lang.String GetContainerNodeInfoAsString(int lInfoRequested)
Retrieve specific information about the node specified in a call to AttachToContainerNode A client that has called AttachToContainerNode may call GetContainerNodeInfo to retrieve information about the particular node we are currently on
Parameters:
lInfoRequested - an int for the requested information type (PT_CRAWL_CONTAINER_INFO)
Returns:
A String version of the crawler info for the attached node

GetContainerNodeInfoAsObject

public java.lang.Object GetContainerNodeInfoAsObject(int lInfoRequested)
Retrieve specific information about the node specified in a call to AttachToContainerNode A client that has called AttachToContainerNode may call GetContainerNodeInfo to retrieve information about the particular node we are currently on
Parameters:
lInfoRequested - an int for the requested information type (PT_CRAWL_CONTAINER_INFO)
Returns:
An Object version of the crawler info for the attached node


Copyright © 2003 Plumtree Software Inc. All Rights Reserved.