|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IPTIndexer
Interface for class which manages the indexing, updating, and deleting of cards, folders, and administrative objects. The methods in this interface are not intended for general custom use, they are intended for use by Plumtree server, crawler, and agent code.
Method Summary | |
---|---|
void |
ClearProfile()
Clear the current profile query. |
IPTIndexer |
Clone()
Create a new IPTIndexer object that is a copy of the current one. |
java.lang.Object |
CommitAll()
"Assynchronous" commit - client doesn't need to wait to make sure that the request was fully processed by the search server. |
java.lang.Object |
CommitAll(int timeiout)
Send any pending index, update, or delete requests to the Search Server. |
java.lang.Object |
CommitAsProfiled(int profileMode)
Send any pending profile requests to the Search Server. |
java.lang.Object |
GetSettings(int lSettingID)
Return the value of settings for the PTIndexer object. |
void |
IndexAdminObject(int nClassID,
int nObjectID)
Add a searchable representation of an administrative object to the current list of items awaiting indexing. |
void |
IndexCard(int nCardID,
IPTCardPropertyValues pPropertyValues,
IPTAccessList pCardBrowseACL,
IPTAccessList pFolderBrowseACL,
java.lang.Object vsaAncestors,
java.lang.String bstrDocumentPath,
java.lang.String bstrProvCLSID,
boolean bSummarize)
Add a searchable representation of a card to the current list of items awaiting indexing. |
void |
IndexFolder(int nFolderID,
com.plumtree.openfoundation.util.IXPPropertyBag pFolderPropBag,
IPTAccessList pBrowseACL,
java.lang.Object vsaAncestors)
Add a searchable representation of a folder to the current list of items awaiting indexing. |
int |
LoadQuery(java.lang.Object vSearchFilter)
Load a query (in the form of an IPTFilter) into the current set of filter queries, returning an integer id that can be used to refer to the filter later. |
boolean |
Matched(int lCardID,
int lQueryID)
Check the current Profile results to determine if a given card matches a given query. |
void |
RemoveAdminObjects(int ClassID,
java.lang.Object vsaObjectIDs)
Request deletion of a set of objects of a given class, given the class id and an int[] array of object ids. |
com.plumtree.openfoundation.util.IXPPropertyBag |
RetrieveStatus()
Return a PropertyBag containing status information about the indexing Search Server. |
java.lang.Object |
RunProfile(java.lang.String bstrFilePath)
Deprecated. |
boolean |
RunSingleQueryProfile(java.lang.String bstrQuery,
java.lang.String bstrFilePath)
Deprecated. |
void |
SetSettings(int lSettingID,
java.lang.Object pvValue)
Set the value of settings for the PTIndexer object. |
java.lang.String |
SummarizeDocument(java.lang.String bstrPath)
Only called during manual card submission, this method takes a full path to a file and extracts a String "summary" consisting of the first words of the full text found in the file. |
void |
UnindexCards(java.lang.Object vsaObjectIDs)
Request deletion of a set of cards, given an int[] array of object ids. |
void |
UnindexFolders(java.lang.Object vsaObjectIDs)
Request deletion of a set of folders, given an int[] array of object ids. |
void |
UpdateCard(int nCardID,
IPTCardPropertyValues pPropertyValues,
IPTAccessList pCardBrowseACL,
IPTAccessList pFolderBrowseACL,
java.lang.Object vsaAncestors)
Add a searchable representation of a card to the current list of items awaiting property updating. |
java.lang.String |
waitForAllIndexRequestsToComplete(int timeout)
Wait until all the index requests initiated by the client have been processed by the search server. |
Method Detail |
---|
void IndexCard(int nCardID, IPTCardPropertyValues pPropertyValues, IPTAccessList pCardBrowseACL, IPTAccessList pFolderBrowseACL, java.lang.Object vsaAncestors, java.lang.String bstrDocumentPath, java.lang.String bstrProvCLSID, boolean bSummarize)
CommitAll()
.
nCardID
- The object id of the card to indexpPropertyValues
- IPTCardPropertyValues enumerating the properties
of the card to index.pCardBrowseACL
- IPTAccessList of ACLs defining who can read this
card.pFolderBrowseACL
- IPTAccessList of ACLs defining who can read the
folder containing this card.vsaAncestors
- An int[] array.
The vsaAncestors array passed into this code should contain a merged
list of all immediate parent folder IDs and their ancestors. If an
entry is negative, it is interpreted as an immediate parent folder id.
So if a card exists in folders 203, 210, and 230 and the folder structures appeared as follows...
bstrDocumentPath
- Full path to a local file for the document
underlying this card. Full text will be extracted from this file
using OutsideIn.bstrProvCLSID
- CLSID of the provider for the data source of
this card, this information is indexed along with the card.bSummarize
- If true, a summary will be extracted from the
full-text content of the card. If false, the summary will be drawn
from the card properties (blank if there is no summary property).void UpdateCard(int nCardID, IPTCardPropertyValues pPropertyValues, IPTAccessList pCardBrowseACL, IPTAccessList pFolderBrowseACL, java.lang.Object vsaAncestors)
CommitAll()
.
nCardID
- The object id of the card to indexpPropertyValues
- IPTCardPropertyValues enumerating the properties
of the card to index.pCardBrowseACL
- IPTAccessList of ACLs defining who can read this
card.pFolderBrowseACL
- IPTAccessList of ACLs defining who can read the
folder containing this card.vsaAncestors
- An int[] array of ancestor folder ids, as described
in IndexCard()
void IndexFolder(int nFolderID, com.plumtree.openfoundation.util.IXPPropertyBag pFolderPropBag, IPTAccessList pBrowseACL, java.lang.Object vsaAncestors)
nFolderID
- Object id of the folder to indexpFolderPropBag
- PropertyBag with folder propertiespBrowseACL
- IPTAccessList determining who can read this foldervsaAncestors
- An int[] array of ancestor folder ids, as
described in #IndexCard()
.void UnindexCards(java.lang.Object vsaObjectIDs)
CommitAll()
for the request
to be processed by the Search Server. This method has no effect
if the object ids in question do not exist.
vsaObjectIDs
- int[] array of object ids for the cards to
delete. Throws PT_RESULTCODES.PT_E_INVALIDARG
if passed
something other than an int[] array. If the argument is null or
empty, this method has no effect.void UnindexFolders(java.lang.Object vsaObjectIDs)
CommitAll()
for the request
to be processed by the Search Server. This method has no effect
if the object ids in question do not exist.
vsaObjectIDs
- int[] array of object ids for the folders to
delete. Throws PT_RESULTCODES.PT_E_INVALIDARG
if passed
something other than an int[] array. If the argument is null or
empty, this method has no effect.void IndexAdminObject(int nClassID, int nObjectID)
nClassID
- The class id of the object to index. Should be a value
from PT_CLASSIDS.nObjectID
- The object id of the object to index. Should be
greater than 0.void RemoveAdminObjects(int ClassID, java.lang.Object vsaObjectIDs)
CommitAll()
for the request to be processed by the Search
Server. This method has no effect
if the object ids in question do not exist.
ClassID
- int Class id of the objects to delete.vsaObjectIDs
- int[] array of object ids for the objects to
delete. Throws PT_RESULTCODES.PT_E_INVALIDARG
if passed
something other than an int[] array. If the argument is null or
empty, this method has no effect.java.lang.Object CommitAll(int timeiout)
timeout
- - time( in milliseconds to wait for a commit(index)
request to be fully processed by the search server.
For example, an array Object[totalItems][4] will be returned where totalItems = numAdded + numUpdated + numDeleted. The format of the entries is:
PT_DOC_ACTION_TYPES
enumeration.
java.lang.Object CommitAll()
CommitAll(int timeout)
java.lang.Object GetSettings(int lSettingID)
lSettingID
- Setting value from the
PT_SEARCHCOLLECTION_SETTINGS
enumeration. PT_SEARCHCOLLECTION_LANGUAGE is the only legal value,
unrecognized values return null.
void SetSettings(int lSettingID, java.lang.Object pvValue)
PT_SEARCHCOLLECTION_SETTINGS
enumeration
unused and deprecated.
lSettingID
- Setting id from the
PT_SEARCHCOLLECTION_SETTINGS
enumeration.vValue
- Setting value, required type varies by id.com.plumtree.openfoundation.util.IXPPropertyBag RetrieveStatus()
IPTIndexer Clone()
int LoadQuery(java.lang.Object vSearchFilter)
vSearchFilter
- IPTFilter representing a filter query to be
used for taxonomization. Should not be null.
Matched(int,int)
method
to determine whether a particular card matched a particular filter.java.lang.Object CommitAsProfiled(int profileMode)
LoadQuery(Object)
method. The profile
request returns results (stored inside the IPTIndexer object) that
indicate which items matched which queries.The usage pattern is for the caller to make
LoadQuery(Object)
, loading up
the filters to use for taxonomization
Matched(int,int)
to determine which
documents matched which filters.
profileMode
- int profiling mode identifier, passed through
to the underlying profiling engine. Must be a value from the
PT_PROFILER_MODE
enumeration.
CommitAll()
.boolean Matched(int lCardID, int lQueryID)
CommitAsProfiled(int)
lCardID
- Object ID of the card to check.lQueryID
- int ID of the query to match against
void ClearProfile()
java.lang.String SummarizeDocument(java.lang.String bstrPath)
bstrPath
- Full path to the file from which we'll extract
the summary. Should not be null.
java.lang.String waitForAllIndexRequestsToComplete(int timeout) throws PTException
timeout
- - amout of time to wait for everything to be processed
PTException
- if the timeout occursjava.lang.Object RunProfile(java.lang.String bstrFilePath)
boolean RunSingleQueryProfile(java.lang.String bstrQuery, java.lang.String bstrFilePath)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |