WebCenter Interaction API  
 

IPTIndexer Members

IPTIndexer overview

Public Instance Methods

public methodClearProfile Clear the current profile query.
public methodClone Create a new IPTIndexer object that is a copy of the current one. The returned object has a reference to the same ProfileQuery (used for taxonomization) as the cloned object. The returned object has a reference to the cloned object as its "parent".
public methodCommitAllOverloaded.  
public methodCommitAsProfiled 
public methodGetSettings 
public methodIndexAdminObject Add a searchable representation of an administrative object to the current list of items awaiting indexing. Does not actually index the item in the search server, indexing is triggered by CommitAll(). For portlets, there may be side-effect indexing of associated Content Server items.
public methodIndexCard 
public methodIndexFolder Add a searchable representation of a folder to the current list of items awaiting indexing. Does not actually index the item in the search server, indexing is triggered by CommitAll().
public methodLoadQuery 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. The caller should keep track of the integer ids generated in the course of calling LoadQuery() multiple times.
public methodMatched Check the current Profile results to determine if a given card matches a given query. Returns true if it matched, false otherwise. Should only be called after {@link #CommitAsProfiled(int)}
public methodRemoveAdminObjects Request deletion of a set of objects of a given class, given the class id and an int[] array of object ids. You must call {@link #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.
public methodRetrieveStatus 
public methodRunProfile Obsolete, based on unused taxonomization code.
public methodRunSingleQueryProfile Obsolete, based on unused taxonomization code.
public methodSetSettings 
public methodSummarizeDocument 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.
public methodUnindexCards Request deletion of a set of cards, given an int[] array of object ids. You must call {@link #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.
public methodUnindexFolders Request deletion of a set of folders, given an int[] array of object ids. You must call {@link #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.
public methodUpdateCard Add a searchable representation of a card to the current list of items awaiting property updating. Does not actually index the item in the search server, indexing is triggered by {@link #CommitAll()}.
public methodwaitForAllIndexRequestsToComplete Wait until all the index requests initiated by the client have been processed by the search server. A client should invoke this method only if it must ensure that everything that it submitted over a period of time is searchable. This is not the way to simulate "synchronous" indexing. Use CommitAll(int timeout) instead. Us this method sparignly since it can potentialy create many search cluster status requests.

See Also

IPTIndexer Interface | com.plumtree.server Namespace