Home >	Contents >	Index >

Expanded TOC   |    Accordion TOC   |    Annotated TOC   |    Index

ICS.Search

Searches an index.

Syntax

public IList 
Search(String sIndex,
       String sWhat,
       String sRelevance,
       String sQueryParser,
       int nMaxResults,
       FTValList vlAdditionalIndexes,
       String sList,
       String sEngine,
       String sCharset,
       StringBuffer sbError)

Parameters

sIndex

The name of the search index. If null, the default index is specified in the ContentServer properties av.defaultindex or verity.defaultindex as appropriate.

sWhat

Query to submit. This should be in the format the given search engine understands.

sRelevance

The relevance string. May be null.

sQueryParser

The AltaVista search engine supports three search types--Simple, Advanced, and Combined. Advanced is the default.

The Verity search engine supports three query parsers-Simple, FreeText, and BoolPlus. The optional QueryParser parameter tells the Verity search engine the syntax of the WHAT clause. If this argument is omitted, then the Simple parser is used by default. The parser may be specified by the verity.parser property in the futuretense.ini file.

nMaxResults

The maximum number of results to return. Set this to 0 for unlimited results.

vlAdditionalIndexes

The name/value pairs of additional indexes to search. May be null.

sList

Name of the output list. Columns returned are:

• ENTRY - Name of the index entry that matches the search criteria.
• DETAIL - Details of the index entry that matches the search criteria.
• DATE - Date the entry was added or the date specified when the index was added. Format is in Java SQL.
• RELEVANCE - Relevance value associated with the search result. The closer the value is to 1, the more useful and relevant the search result is likely to be.

sEngine

Search engine name. If null, the value of the Content Server property, cs.searchengine, is used.

sCharset

Constant value representing the character set the index uses.

• For the AltaVista search engine, this value can be 0, 1, or 2 (ISO_LATIN1, ASCII8, or UTF8). If sCharSet is null, Content Server uses the value of av.charset in the properties file.
• For the Verity search engine, this value specifies the name of the subdirectory of the common directory where the locale is defined. If sCharSet is null, Content Server uses the value of verity.charset in the properties file.

sbError

For return values; may contain error information.

Description

The Search method searches an index. The resultset of the query is stored in a list.

Returns

Returns the name/value pairs of the result set. If an error occurs, or if there are no results satisfying the query, then a null is returned.

Errno

Use GetErrno (), and see Appendix A, "Error Conditions," for the possible errno values.

 

		Home >	Contents >	Index >
	FatWire JAVA Reference Copyright 2005 by FatWire Software All rights reserved.