O2Search User Manual
Contents
1. User Manual 43 D O2Search Reference O2FTISearch Description Syntax Parameters Returns Constructor Searches a collection for document objects that meet the specified search criteria You can submit a query to one or more collections and you can narrow the search by submitting an existing O2FTISearch object to O2FTISearch O2FTISearch O2FTISearch const O2FTISession amp session const O2FTICollection amp collection const char query const int threshold 0 const int numMaxDocs 0 O2FTISearch O2FTISearch const O2FTISession amp session const unsigned numCollections const O2FTICollection collectionArray const char query const int threshold 0 const int numMaxDocs 0 O2FTISearch O2FTISearch const O2FTISession amp session const O2FTISearch oldSearch const char newQuery session Session in which the search is to be performed collection Searched collection collectionArray List of searched collections numCollections Number of collections in collectionArray query newQuery query in Verity syntax oldSearch O2FTISearch object for which the search is to be narrowed threshold Minimum score required for a documents to be retrieved numMaxDocs Maximum number of documents to be returned When successful creates a new O2FTISearch object containing the documents satisfying the search requirements sorted by relevance Score2. 5 User Manual Release 5 0 April 1998 Information in this document is subject to change without notice and should not be construed as a commitment by Technology The software described in this document is delivered under a license or nondisclosure agreement The software can only be used or copied in accordance with the terms of the agreement It is against the law to copy this software on magnetic tape disk or any other medium for any purpose other than the purchaser s own use Copyright 1992 1998 Technology All rights reserved No part of this publication can be reproduced stored in a retrieval system or transmitted in any form or by any means electronic mechanical photocopy without prior written permission of Technology 2 gt 5 OoEngine OoGraph OoKit OoLook O Store OsTools and O gt Web are registered trademarks of Technology SQL and AIX are registered trademarks of International Business Machines Corporation Sun SunOS and SOLARIS are registered trademarks of Sun Microsystems Inc X Window System is a registered trademark of the Massachusetts Institute of Technology Unix is a registered trademark of Unix System Laboratories Inc HPUX is a registered trademark of Hewlett Packard Company BOSX is a registered trademark of Bull S A IRIX is a registered trademark of Siemens Nixdorf A G NeXTS
3. indexes and transactions e OsEngine The object database engine provides direct control of schemas classes objects and transactions through OsEngine API It provides full text indexing and search capabilities with and spatial indexing and retrieval capabilities with O Spatial It includes a Notification manager for informing other clients connected to the same O server that an event has occurred a Version manager for handling multiple object versions and a Replication API for synchronizing multiple copies of an O2 system O Search User Manual Document search and retrieval 1 2 Programming Languages You can create and manage objects by using the following programming languages e O functions can be invoked by C programs e ODMG compliant C binding Java ODMG compliant Java binding e An object oriented fourth generation language specifically for developing object database applications e OQL ODMG standard SQL like object query language capable of handling complex objects and methods O Development Tools e Creates modifies and edits any type of object graph e OsLook Designs and develops graphical user interfaces provides interactive manipulation of complex and multimedia objects e Library of predefined classes and methods for fast development of user applications e OsTools Complete graphical programming environment for design
4. userdata d Bits html footer char query userdata d Bits fti report The method fti report Before you can index a class for full text searching you must define the fti report method within that class This method returns the text to be indexed which may include SGML tags as well as plain text You can also use this method to customize the text returned from document objects The following code defines the method ti report in class Document This code returns the attribute data which holds the contents of the document d Bits Document fti report return this data O Search User Manual 19 EH Using O Search The O2 schema The O schema used in the preceding example is composed of the classes Document and o2 list Document which are generated by importing the class Document and the type list Document In addition the following name is defined constant name TheRepository o2 list Document This name is the only root of persistence defined in the schema for this example It is used to store instances of class Document 20 O Search User Manual Creating a document object 3 2 Indexing document objects This section shows how to create a document object store it in Oo and use the O Search API to index it The complete code follows d Ref Document doc new Document doc name my document d Bits doc data str doc data doc data transaction
5. In this example a full text query is formulated using the explicit syntax and the operator near Explicit Syntax Explicit syntax uses the SEARCH 97 query language A full description of its syntax and usage is provided in the Verity Search 97 Developers Kit API Reference Guide An example of an explicit syntax query follows paragraph software sentence merge phrase annual purchase For more information on the query language please refer to the SEARCH 97 documentation Submitting a query to O2Search When you create an O2FTISearch object the query is submitted to O Search The constructor expects as arguments the session the collection on which the query is to be executed and the text of the query The Os5Search engine executes the query retrieving all documents in the collection that satisfy the query criteria In the preceding example the selection criteria is based on the proximity of the word O2 to the words VERITY or O2SEARCH Retrieving the result of an O2Search query Several methods are defined in class O2FTISearch some of which are used in the preceding example The method getFoundDocument for User Manual 25 EH Using O Search example enables applications to retrieve a document by specifying the ordinal number of the document in a list of retrieved documents You can limit the results of a search to one of the following documents whose relevance scor
6. and common errors warnings and status information O Search User Manual 29 D O2Search Reference All All information includes all preceding message categories except debugging 30 O Search User Manual O2FTISession O2FTISession Description Syntax Parameters Returns Destructor Terminates the session Frees all resources associated with the session including search objects and allocated memory O2FTISession O2FTISession None Always frees the session No error is returned User Manual 31 D O2Search Reference setinfo Description Modifies the state of a session Syntax void O2FTISession setInfo O2FTISession MessageType outLevel Fatal O2FTISession MessageType logLevel Fatal char logFile NULL Parameters outLevel Types of messages generated by the FTI engine Types are listed under Comments loglevel Error message types stored in the log file Types are listed under Comments logFile Absolute path for the log file including file name Returns When successful returns nothing When unsuccessful throws an O2FTIException Comments Message types that may be supplied in the parameter out Level include the following Error messages are stored in the log file Fatal Fatal error Error Common error Warn Warnings Status Engine status information Info Detailed information Verbose Verbo
7. ranging from dedicated noninteractive index builders to responsive GUI front end interfaces An application program interface API is provided to support the integration of full text index capabilities within Os applications An application using O2Search can perform four functions Store documents in objects of the database e Index document objects to make them searchable Search and retrieve document objects that satisfy users queries Maintain and optimize full text indexes An OsSearch application can be configured to search index or maintain indexes Then at run time the application can change the type of operation it is performing or run more than one type of operation at a time For example applications can run searches while indexing and performing maintenance functions O Search applications can use the following search techniques Searching for document objects that contain specific words Searches can also be based on an expansion list associated with a word such as a list of variations containing the stem word a list of synonyms or a list of sound alike words O Search User Manual 13 Introduction Searching for document objects that contain certain words in close proximity in the same phrase or in the same paragraph _ assigns a score to each retrieved document object which remains associated with the object for the duration of the search Retrieved documents a
8. should call this method after all indexing has been completed because index optimization speeds searches and reduces disk space usage void O2FTICollection optimize None When successful optimizes the collection When unsuccessful throws O2FTIException 42 O Search User Manual optimize 4 3 O2FTISearch Methods The public interface of the class is defined as follows class O2FTISearch public O2FTISearch const O2FTISession amp session const O2FTICollection amp collection const char query in threshold 0 between 0 and 100 int numMaxDocs 0 throw O2FTIException 0 O2FTISearch const O2FTISession amp session const unsigned numCollections const O2FTICollection collections int threshold 0 between 0 and 100 int numMaxDocs 0 throw O2FTIException 0 no limit O2FTISearch const O2FTISession amp session const unsigned numDocuments const Handle documents const char query int threshold 0 between 0 and 100 int numMaxDocs 0 throw O2FTIException 0 no limit O2FTISearch const O2FTISession amp session Narrow query result const O2FTISearch amp search const char query throw O2FTIException O2FTISearch const O2FTISearch amp search O2FTISearch Handle getFoundDocument int nth throw O2FTIException int getFoundDocumentScore int nth throw O2FTIException int getNumFoundDocuments int getNumProcessedDocuments
9. void O2FTICollection update const Handle document numDocuments Number of document objects in documentArray documentArray Document handle list document Document handle When successful updates the listed of document objects and the corresponding index When unsuccessful throws an O2FTIException object containing the message error during modification of the index 40 O Search User Manual remove remove Description Syntax Parameters Returns Deletes the specified list of document objects from a document collection O Search removes the document objects from the SEARCH 97 collection and updates the corresponding full text indexes only when the transaction is committed or validated void O2FTICollection remove int numDocuments const Handle documentArray void O2FTICollection remove const Handle document numDocuments Number of document object handles in documentArray documentArray Document object handle list document Document object handle When successful deletes the listed document objects and removes all associated index information When unsuccessful throws an O2FTIException object containing the message error during modification of the index User Manual 41 D O2Search Reference optimize Description Syntax Parameters Returns Optimizes the structure and contents of the full text index associated with the collection You
10. O You must define C document class and import it into Os Also you must define a root of persistence to store instances of this class these instances are called document objects The following example defines a class named Document A name TheRepository of type o2 list Document is defined in the schema to be used as the root of persistence for documents No constraints are imposed on the name or structure of document classes or on the way instances of classes are stored in The only constraint is that the document class must define the method ti report Your application can define any number of document classes to store and manipulate different types of documents The class Document The following code defines the class Document with attribute data to hold document contents The other attributes in this class are used to hold additional information about a document and can be ignored for now You can see how these attributes are used by reviewing the sample O Search User Manual The method fti report application provided with O Search from which this class defintion is taken class Document public d Bits data char name char origin char abstract char kind public Document d String get query d String get abstract d String html title d Bits html prolog char query userdata d Bits html header char query userdata d Bits html report char query
11. Wherunsuccessfulthrowsaro2F TIExcept iorobjectontaininghanessage incorrect query 44 O Search User Manual O2FTISearch O2FTISearch Description Destructor Removes the O2FTISearch object Syntax O2FTISearch O2FTISearch Parameters None Returns Nothing User Manual 45 D O2Search Reference getFoundDocument Description Syntax Parameters Returns Retrieves the handle for the nth zero based document object returned in the document list of the O2FTISearch object Handle O2FTISearch getFoundDocument int nth nth Ordinal number for the document in the list of retrieved documents When successful returns the requested document object When unsuccessful throws an O2FTIException object containing the message index out of range 46 O Search User Manual getFoundDocumentScore getFoundDocumentScore Description Syntax Parameters Returns Returns the relevance score of the nth document object in the document list of the O2FTISearch object int O2FTSearch getFoundDocumentScore int nth nth Ordinal number for the document in the list of retrieved documents When successful returns the corresponding document s score When unsuccessful throws O2FTIException object containing the message index out of range User Manual 47 D O2Search Reference getNumFoundDocuments Description Syntax Paramet
12. begin try Creates a session O2FTISession FTIsession argc argv Creates a full text collection O2FTICollection collection FTIsession collections example Add the new document in the full text index collection add doc o2_get_handle Add the new document in 02 d List d Ref Document gt repository TheRepository repository insert element last doc transaction validate catch const O2FTIException amp e cout lt lt Error while indexing document lt lt e errorCode Creating a document object Before executing the preceding example you must create a new document and store it in the using the C ODMG interface The example assumes that you have stored the document contents in the variable str of type char This may be for example the contents of a Microsoft Word or Acrobat PDF file Opening an O2Search session To be able to index a document object an O2Search session must be open The constructor of the class O2FTISession is used to open a new session In the example in this chapter the default settings of a User Manual 21 EH Using O Search session are used but you can change them during the session by using the public interface of class O2FTISession For example you can turn on or off logging of errors related to indexing and maintenance at run time O2FTISession records user input effectively emulating a se
13. e is above a given threshold the top scoring nth documents You can also submit search results as a new search object to further narrow the search 26 O Search User Manual O Search API Reference The O Search API enables users to use O Search indexing and searching facilities for any type of document When an error is detected O Search throws C exception containing an error code and description This chapter describes the public interface of the classes that make up the O2Search API The following classes are included e Section 4 1 O2FTISession Methods Section 4 2 O2FTICollection Methods Section 4 3 O2FTISearch Methods O Search User Manual 27 O2Search Reference 4 1 O2FTISession Methods The public interface of the class is defined as follows class O2FTISession public typedef enum None Fatal 0x01 Error 0x02 Warn 0x04 Status 0x08 Info 0x10 Verbose 0x20 Debug 0x40 Basic Fatal Error All Basic Info MessageLevel O2FTISession int const char const char MessageLevel MessageLevel const char argc argv locale outLevel logLevel logFile Warn Status Verbose english Fatal Fatal NULL throw O2FTIException O2FTISession throw O2FTIException void setInfo MessageLevel outLevel MessageLevel logLevel const char logFile throw O2FTIException void getInfo MessageLevel outLeve
14. earch SESON 21 Opening an O Search collection caen rnit 22 indexing a document 23 3 3 Searching for and retrieving document objects 24 Formulating an Osseareh 24 tU 24 EINEN ER ee a 25 Submitting a query DRS ne 25 Retrieving the result of an O Search query 23 O Search API Reference 27 4 1 O2FTiSession Method n 28 dub c EE 29 ee 31 ATE id ie ene 32 O Search User Manual TABLE CONTENTS lacobo MR Cep E E Ret orto 49 4 2 O2FTICollection Methods 34 dosis ee ee 35 e ee 36 Doo ad MONEO Lou cbe lnc Miete de mE du 38 9 I e 39 M 40 41 42 43 OZFIBearen ann 43 44 gladio sl PE 45 Document 46 Feat 111 5 CONS E RN E E CM dE UE 47 EET E ERSTEN iss utat ba 48 Pela Processed Documents 49 O Search User Manual vii TABLE OF CONTENTS viii O Search User Manual Introduction O Search combines the power of Os with the SEARCH 97 search engine by Verity Inc This combination enables you to provide full text indexing a
15. ees the O2FTICollection Returns no errors 38 O Search User Manual Description Syntax Parameters Returns Inserts the specified list of document objects into a SEARCH 97 collection or creates a new object of the given name if none exists OsSearch inserts the new document object into the SEARCH 97 collection and updates the corresponding full text indexes only when the transaction is committed or validated void O2FTICollection add int numDocuments const Handle documentArray void O2FTICollection add const Handle document numDocuments Number of document objects in documentArray documentArray Document object handle list document Document object handle When successful inserts and indexes the listed document objects When unsuccessful throws O2FTIException object containing the message error during modification of the index User Manual 39 D O2Search Reference update Description Syntax Parameters Returns Updates the specified list of document objects in a collection OoSearch updates the document objects in the SEARCH 97 collection and updates the corresponding full text indexes only when the transaction is committed or validated If an update is requested for a document that does not already exist in the collection creates it void O2FTICollection update int numDocuments const Handle documentArray
16. ents at the same time The O transaction locking mechanism enables multiple applications to generate indexes for documents in a collection while searching the same collection without the risk of losing any indexing information Multiple O2FTICollection objects can be used at the same time Maintenance methods are also defined within O2FTICollection objects for optimization and garbage collection O Search User Manual Indexing a document object Indexing a document object To index a document object add the document to an instance of O2FTICollection When an transaction is committed or validated the contents of the document object given by method report are indexed and the corresponding collection and document in the SEARCH 97 collection are updated User Manual 23 EH Using O Search 3 3 Searching for and retrieving document objects The following code demonstrates using the class O2FTISearch to query indexed collections char query O2 NEAR VERITY OR O2SEARCH try Open a full text session O2FTISession FTIsession argc argv Open or Create a full text collection O2FTICollection collection FTIsession collections example Open a Search object O2FTISearch search FTIsession collection query cout search getNumFoundDocuments of lt lt search getNumProcessedDocuments lt lt documents matched query lt lt query l
17. ers Returns Returns the number of document objects that satisfy the search criteria int O2FTISearch getNumFoundDocuments None When successful returns the number of document objects that meet the search criteria When unsuccessful throws an O2FTIException 48 O Search User Manual getNumProcessedDocuments getNumProcessedDocuments Description Syntax Parameters Returns Returns the number of document objects processed during the search int O2FTISearch getNumProcessedDocuments None When successful returns the number of document objects processed When unsuccessful throws an O2FTIException User Manual 49 D O2Search Reference 50 O Search User Manual
18. es and viewing results The combined use of OsSearch and constitutes a powerful and easy to use tool for the development of Web servers on top of 14 O Search User Manual Setting Up 2 O Search After installing Oo and O Search you can find the following OsSearch related files in your Os home directory These files are needed to build an O Search application opt O2search bin common doc filters lib You need to update the LD_LIBRARY_PATH environment variable to point to the following directory 02HOME opt o2search lib O Search User Manual 15 2 Setting Up O2Search O Search User Manual Using O gt Search This chapter presents an example of a simple O Search application The example introduces the main components of the O Search architecture and shows how the O Search API can be used to build applications that make use of full text indexing FTI and retrieval capabilities See the following sections for more information Section 3 1 Defining document objects in O2 Section 3 2 Indexing document objects Section 3 3 Searching for and retrieving document objects See Chapter 4 O2Search API Reference for a complete description of the API Also see the sample application in O2HOME samples that show how O Search can be used in conjunction with O Search User Manual 17 EH Using O Search 3 1 Defining document objects in
19. ing and developing database applications Standard Development Tools You can use any standard programming language system such as Visual and Sun Sparcworks and any supported operating system External Interfaces e OsCorba Creates Oo Orbix servers for accessing databases with CORBA e O DBAccess Connects applications to relational databases on remote hosts invokes SQL statements e O ODBC Connects remote ODBC client applications to databases O Web Creates O World Wide Web servers for accessing databases through the internet network Document search and retrieval The proliferation of personal computers and distributed servers together with the distribution of different forms and types of information across the World Wide Web has increased the demand for powerful information research and analysis tools O Search User Manual 11 Introduction Document search engines enable users to search a large number of documents using specific selection criteria These engines have proliferated across the Web to enhance users capability to locate and collect information The first search engines processed only plain text documents Today they are capable of efficiently processing many different types of documents and supporting user queries that address specific document structures Users perspective From the user s perspective the primary interface to a document search engine is
20. l MessageLevel logLevel char logFile throw O2FTIException O Search User Manual O2FTISession O2FTISession Description Syntax Parameters Returns Comments Constructor Creates an session and returns an O2FTISession instance Multiple sessions can be created by an application O2FTISession O2FTISession int char char argc argv locale english O2FTISession MessageType outLevel Fatal O2FTISession MessageType logLevel Fatal logFile NULL char argc argv locale outLevel loglevel logFile Number of elements in argv Pointer to the array of main function arguments Language driver to be used instead of the standard American English language Types of messages generated by the FTI engine Types are listed under Comments Error message types stored in the log file Types are listed under Comments Absolute path for the log file including file name When successful returns a new O2FTISession object When unsuccessful throws O2FTIException Message types that may be supplied in the parameter out Level include the following Error messages are stored in the log file Fatal Fatal error Error Common error Warn Warnings Status Engine status information Info Detailed information Verbose Verbose information Debug Debugging information Basic Basic information a combination of fatal
21. l preceding message categories except debugging O Search User Manual 33 O2Search API Reference 4 2 O2FTICollection Methods The public interface of the class is defined as follows class O2FTICollection public O2FTICollection const O2FTISession amp session const char name throw O2FTICollection const O2FTICollection amp copy O2FTICollection throw O2FTIException const O2FTICollection amp operator collection static O2FTICollection getCollection const char const O2FTISession amp getSession const void reset throw O2FTIException optimize throw O2FTIException void void void void void void void void destroy add remove update add remove update int numDocuments const Handle hdDocumentArray throw int numDocuments const Handle hdDocumentArray throw int numDocuments const Handle hdDocumentArray throw const Handle hdDocument throw const Handle hdDocument throw const Handle hdDocument throw O2FTIException const O2FTICollection amp collectionName O2FTIException O2FTIException O2FTIException O2FTIException O2FTIException O2FTIException 34 O Search User Manual O2FTICollection O2FTICollection Description Syntax Parameters Returns Constructor Opens a SEARCH 97 collection of full text indexed document objects or creates a new empty collecti
22. nd search capabilities for any document object in your Os database This chapter provides an overview of the Oo system an introduction to document search and retrieval technology and a brief overview of OsSearch See the following sections for more inforamtion Section 1 1 System overview Section 1 2 Document search and retrieval To effectively use this manual you should have some knowledge of Os and O s C ODMG binding interface You can learn about SEARCH 97 in Verity s manuals O Search User Manual 9 Introduction 1 1 System overview O s system architecture is illustrated in the following figure External Interfaces Development Tools Dev Tools C Java Se O2Corba Database Engine O Search O DB Access 2 O Store Figure 1 1 System Architecture The O system consists of the database engine development tools and external interfaces The database engine provides all the capabilities of a database and an object oriented system This engine is accessible by using programming languages O development tools and other standard development tools Numerous external interfaces are also provided 2 Web The database engine consists of the following e O Store The database management system DBMS provides low level facilities through API to access and manage databases disk volumes files records
23. on of the same name if none exists O2FTICollection O2FTICollection const O2FTISession session char name session Current session name Name of the opened collection If an absolute path name is not provided the current directory is used When successful returns a new O2FTICollection object When unsuccessful returns an O2FTIException object containing the error Unable to create a new collection indicating that disk space was insufficient to open the collection User Manual 35 D O2Search Reference O2FTICollection Description Destructor Closes the open collection Syntax O2FTICollection O2FTICollection Parameters None Returns Always closes the SEARCH 97 collection and deletes the corresponding C object No error is returned 36 O Search User Manual reset reset Description Syntax Parameters Returns Deletes all document objects from the collection and empties and deletes the indexes void O2FTICollection reset None When successful empties the collection and deletes the indexes When unsuccessful throws O2FTIException User Manual 37 D O2Search Reference destroy Description Syntax Parameters Returns Resets and closes the collection then deletes it The deleted collection is no longer available for searching or indexing void O2FTICollection destroy None Always fr
24. re listed in order by score An application program interface API enables you to integrate full text index capabilities within your applications Three C classes make up the O5Search API o2FTISession O2FTICollection and O2FTISearch Class 02FTISession opens a new gt session and records user input O Search indexes and searches 02FTICollection instances which represent full text indexed SEARCH 97 collections The contents of documents are stored in Oo whereas SEARCH 97 collections into which the documents are inserted through the o2FTICollection API class contain only index and meta data including a pointer to the appropriate document objects in Oo An application can use methods in the 02FTISearch class to search and retrieve documents stored in full text indexed collections These methods produce lists of pointers to documents that satisfy the search criterion The application uses these pointers to retrieve the corresponding Os object in the database You can further narrow your search by submitting the results to a new search All updates to data in Oo databases made within transactions so that updates can be aborted when errors occur Because SEARCH 97 does not support transactions manages them within the class O2FTICollection Search engines are commonly used in the context of intranet Internet applications in which a Web browser is used as the interface for submitting queri
25. se information e Debug Debugging information Basic Basic information a combination of fatal and common errors warnings and status information All All information includes all preceding message categories except debugging 32 O Search User Manual getinfo getinfo Description Syntax Parameters Returns Comments Returns information about the current session void O2FTISession getInfo O2FTISession MessageType outLevel O2FTISession MessageType logLevel char logFile outLevel Types of messages generated by the FTI engine Types are listed under Comments loglevel Error message types stored in the log file Types are listed under Comments logFile Absolute path for the log file including file name Returned pointers refer to internal data which you must not modify You must make a copy if you need to modify them When successful returns nothing When unsuccessful returns an O2FTIException Error message values that may be supplied in the parameter outLevel include the following Error messages are stored in the log file Fatal Fatal error Error Common error Warn Warnings Status Engine status information Info Detailed information Verbose Verbose information Debug Debugging information Basic Basic information a combination of fatal and common errors warnings and status information All information includes al
26. ssion Most applications require you to open at least one session but you can open multiple sessions at the same time For example if an application supports multiple users a separate session can be created for each user Opening an O2Search collection An instance of O2FTICollectionis a transient object that corresponds to a SEARCH 97 collection The constructor of the class O2FTICollection either opens the existing collection or creates a new one if none of the given name is found The constructor name parameter is used to locate the corresponding SEARCH 97 collection file or to create a new one You must provide the absolute path including the name The o2FTICollection class contains the internal data structure required to enable updates to SEARCH 97 to be managed in the context of an O Search transaction When an Os5Search application updates an instance of O2FTICollection the update of the corresponding SEARCH 97 collection is performed only after transaction validation is complete In the same way any document removed from a full text indexed collection through the O2FTICollection interface belongs to that collection until the transaction is validated The commit or validate of an transaction in an O Search application synchronizes the contents of the document objects stored in the database with those of the SEARCH 97 collections used in a given session Multiple applications can work on the same OsSearch collection and docum
27. t lt n cout lt lt for int 1 0 i lt search getNumFoundDocuments 1 cout lt lt cout lt lt Score lt lt search getFoundDocumentScore i d Ref Document doc search getFoundDocument i OL READ cout lt lt doc gt name lt lt Formulating an O Search query A query expression is any statement you enter for performing a search Two kinds of full text queries are defined simple syntax and explicit syntax Simple Syntax When you use simple syntax the query parser interprets single words as if they were preceded by the MANY modifier and the STEM operator When you use the MANY keyword the score for each document is 24 O Search User Manual Submitting a query to O2Search based on the frequency with which the word appears in the document the more times it appears the higher the documents score The full text engine searches for the words you specify as well as words that have the same stem The query film retrieves all documents containing the word film and all words with the same stem For example films filmed and filming are stemmed variations of the word film The query cartoons Jones Chuck retrieves documents about cartoons made by Chuck Jones The implicit operator AND is added between words When you enclose a word in double quotations marks the word is interpreted literally and no stemmed variations are included in the search
28. tep is a registered trademark of the NeXT Computer Inc Purify Quantify are registered trademarks of Pure Software Inc Windows is a registered trademark of Microsoft Corporation All other company or product names quoted are trademarks or registered trademarks of their respective trademark holders Who should read this manual This manual describes how to use an Os module that enables you to design and develop applications which use a full text index The module provides indexing and search capabilities for text based objects in your Oo database The manual contains a comprehensive list of OoSearch methods and commands Other documents available are outlined click below See O2 Documentation set Table of Contents O Search User Manual gt 22 TABLE OF 5 Introduction 9 1 1 System WENN nein 10 1 2 Document search and retrieval 11 BR TP T TE 12 cipe E g een a o 12 EARCH ane a d LE A dE 12 13 Setting Up O Search 15 Using O Search 17 3 1 Defining document objects in O5 18 The class Locis nit it nOn vn MM de timc iT 18 The menoa s 19 TORE EN 20 3 2 Indexing document objects 21 Creating document ODE aan 21 Opening an S
29. the engine s query language which is used to search documents stored in a document repository The syntax of document retrieval query languages is usually simple and combines Boolean operators for textual searches like NEAR or with operators based on the logical structure of documents like attribute contains The result of a query is a set of identifiers for documents or regions within documents that satisfy the search criteria The user can choose a document from the result list to view with an appropriate tool Search engine From the perspective of the search engine a document repository is a set of indexes Currently many different methods of indexing are used To index a document the engine analyzes it and builds a set of keywords and keyword locations The set of keywords and locations comprise the document index Users queries are translated into a set of keywords and associated operators that are used to search the document index SEARCH 97 SEARCH 97 is a document search and retrieval system developed and distributed by Verity Inc Documents maintained by the SEARCH 97 engine are full text indexed and maintained in a SEARCH 97 collection SEARCH 97 s knowledge based indexing and retrieval uses the knowledge representation Verity Query Language to store and organize the information and to accelerate category based searching The search engine also takes advantage of thesauri word stemming linguistic anal
30. ysis and other methods of query expansion By using filters and viewers the engine can extract index and render in HTML the contents of documents stored in more than 200 formats These functions are executed in real time for Web browser display maintaining the format designed by the documents creator O Search User Manual Document search and retrieval The main features of SEARCH 97 include the following a powerful query language that supports word concept field and proximity searches e universal data support including the support to multiple document types and formats located anywhere on the Web e dynamic access to documents that are stored in a collection An individual SEARCH 97 collection represents a logical group of documents plus a set of meta data about those documents such as word indexes document field information and logical pointers to the actual document text A collection is an API object that can be searched by the SEARCH 97 engine Each collection is stored in a file Concurrent access to document data is enabled through file sharing and is synchronized through file locking For more information about SEARCH 97 please refer to Verity s SEARCH 97 documentation O Search O Search combines the power of Os with that of SEARCH 97 to enable application programmers to add full text indexing and search capabilities to any document object stored in an O database O2Search supports applications
Download Pdf Manuals
Related Search