|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
| 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 |
public int QueryCapability(int nCapabilityID)
nCapabilityID - an int corresponding to a PT_CP_CAPABILITIES type
public java.lang.String GetCrawlerInfoAsString(int lInfoRequested,
com.plumtree.openfoundation.util.IXPPropertyBag pBagRepositoryInfo)
lInfoRequested - an int for the desired PT_CRAWL_INFO typepBagRepositoryInfo - a provider specific repository description bag
public int GetCrawlerInfoAsInt(int lInfoRequested,
com.plumtree.openfoundation.util.IXPPropertyBag pBagRepositoryInfo)
lInfoRequested - an int for the desired PT_CRAWL_INFO typepBagRepositoryInfo - a provider specific repository description bag
public java.lang.Object GetCrawlerInfoAsObject(int lInfoRequested,
com.plumtree.openfoundation.util.IXPPropertyBag pBagRepositoryInfo)
lInfoRequested - an int for the desired PT_CRAWL_INFO typepBagRepositoryInfo - a provider specific repository description bag
public void Initialize(com.plumtree.openfoundation.util.IXPPropertyBag pBagRepositoryInfo,
IPTSession pSession,
IPTDocumentTypeMap pDocumentTypeMap,
int lWebServiceID)
pBagRepositoryInfo - a provider formatted property bagpSession - a user sessionpDocumentTypeMap - The document type map used for discovering document typeslWebServiceID - The web service ID upon which this provider relies
public void AttachToContainerNode(com.plumtree.openfoundation.util.IXPPropertyBag pBagContainer,
int lNodePreferences)
pBagContainer - A provider specific property bag identifying a container nodelNodePreferences - an int indicating whether document and/or containers are needed (PT_CRAWLPROVIDER_GETCHILDNODEMASK)
public boolean GetChildNodes(java.lang.Object pSafeArrayDocuments,
java.lang.Object pSafeArrayContainers)
pSafeArrayDocuments - an empty Object to be populated with a document nodes arraypSafeArrayContainers - an empty Object to be populated with a container nodes arraypublic java.lang.String GetContainerNodeInfoAsString(int lInfoRequested)
lInfoRequested - an int for the requested information type (PT_CRAWL_CONTAINER_INFO)public java.lang.Object GetContainerNodeInfoAsObject(int lInfoRequested)
lInfoRequested - an int for the requested information type (PT_CRAWL_CONTAINER_INFO)
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||