Aqualogic Interaction API  
 

com.plumtree.server.search Namespace

Server Search Interface Documentation

Namespace hierarchy

Classes

Class Description
PTSFieldType An enumeration of field types supported by Plumtree Search.
PTSTextQueryParseMode An enumeration of ways in which a text (string) query may be parsed.

Interfaces

Interface Description
IPTSBooleanQuery An IPTSQuery that is the conjunction (AND) or disjunction (OR) of one or more other IPTSQuery objects.
IPTSearchFactory Defines factory methods for all other objects in the com.plumtree.server.search package.
IPTSField A single field that might appear in a search result or as part of a search query.

Obtain instances of IPTSField from factory methods in IPTSearchFactory, IPTSPlumtreeCollection, IPTSPortalCollection, IPTSCollabCollection, and IPTSContentCollection. These factory methods return all the fields in items indexed by the various Plumtree applications.

Fields in IPTSearchFactory and IPTSPlumtreeCollection can generally appear in any item indexed in the search server. Fields in IPTSPortalCollection, IPTSCollabCollection, and IPTSContentCollection appear in items indexed by that specific application.
IPTSGroupInfo Holder class for info about a single "group" of results discovered during execution of a query request.
IPTSModifiableQuery Base interface for all search queries that can be modified with extra options such as spell correction, thesaurus, etc. Full-text and metadata queries typically could be modified, but collection or security queries usually are not. Queries that have child queries (e.g. IPTSBooleanQuery) are usually modifiable as well, and the selected modification options apply to any child queries that are also modifiable.
IPTSQuery A search query that may be used within an IPTSQueryRequest. See IPTSQueryRequest.setQuery and IPTSQueryRequest.restrictTo This is the base interface that all queries implement.

Queries may be composed together using the IPTSBooleanQuery subinterface. Also, queries may be restricted to specific areas within the Plumtree applications (such as folders or projects) using IPTSQuery objects returned by factory methods in IPTSPortalCollection and IPTSCollabCollection.
IPTSQueryRequest  
IPTSQueryResponse The response from a search query request.
IPTSResult A single search result, returned as part of an IPTSQueryResponse.
IPTSSearchableCollection Interface that returns the most basic set of fields (IPTSField instances) necessary for the Plumtree search API to function. These fields, such as Rank, have more to do with the mechanics of querying and retrieving than with the actual content of searchable items.

For fields that are indexed by the actual Plumtree applications, see subinterfaces IPTSPortalCollection, IPTSCollabCollection, IPTSContentCollection in package com.plumtree.server.search.ptapps.
IPTSSpellingCorrection A single spelling correction done as part of a query request.
IPTSWeightedFieldList A weighted list of IPTSField objects. Used when setting the default field(s) to be searched by text search queries. See IPTSSearchableCollection.TextQueryDefault and IPTSQueryRequest.setTextQueryDefaultFields.