Compass Server 3.0 Developer's Guide
[Contents] [Previous] [Next] [Last]
Symbols
- $$author 38
- $$Browse-Category 42
- $$categorized-count 41
- $$category 40
- $$Chunk-size 43
- $$classification 39
- $$content-length 39
- $$description 39
- $$encode-SOIF-Attribute 40
- $$id 38
- $$last-modified 39
- $$Next-Page 42
- $$Page 42
- $$Preserve-SOIF-Attribute 40
- $$Prev-Page 42
- $$RDM-has-hits 41
- $$RDM-has-hits-more 43
- $$RDM-has-hits-this 43
- $$RDM-has-hits-zero 43
- $$RDM-Hit 40
- $$RDM-Hit-Max 42
- $$RDM-Hit-Min 43
- $$RDM-Hits-Available 41
- $$RDM-Hits-Returned 43
- $$RDM-Hits-Searched 41
- $$RDM-Is-First-Hit 41
- $$RDM-Is-First-Page 43
- $$RDM-Rotated-Color 43
- $$RDM-rotated-colors 33
- $$RDM-Scope 42
- $$RDM-Score-Icon 44
- $$RDM-Score-Image 44
- $$RDM-Server 42
- $$RDM-Version 42
- $$RDM-View-Template 42
- $$schema-name 40
- $$score 40
- $$Search-Category 42
- $$SOIF-Attribute 38
- $$subclassification-count 41
- $$taxonomy 42
- $$title 38
- $$UI 41
- $$URL 39
A
- adding entries to database in Java 189
- adt.h 122
- advanced search interfaces 55
- AIX, compiling for 132
- allowing
- SOIF attributes 154
- allowing resources 85
- alternating colors
- for search results 33
- API
- SOIF 137
- append() 156
- assign-source
- robot application function 110
- assign-type-by-extension
- robot application function 110
- attributes
- allowing and denying 154
- for urls for opening end user page 51
- attribute-value pair
- definition 193
- attribute-value pairs
- finding value of attribute 145
- multi-value routines 147
- routines 146
- SOIF example 138
- auto-proxy
- process.conf parameter 91
B
- bindir
- process.conf parameter 92
- browse mode 16
- browse mode page
- components of 16
- browse page
- definition 193
- browse-bottom
- pattern file 50
- browse-category
- query string url attribute 52
- browse-mode-top
- pattern file 44
- buffer management
- for SOIF streams 155
C
- C
- using SOIF API 137
- using to create RDMs 157
- using to interrogate Compass Server database 157
- category-browse-bottom
- pattern file 47
- category-browse-hit
- pattern file 46
- category-browse-top
- pattern file 45
- category-search-results-bottom
- pattern file 47
- category-search-results-hit
- pattern file 46
- category-search-results-top
- pattern file 45
- CGI programs, and LiveWire viii
- CGILocation 175
- checking processing status in Java 179
- chunk-size
- query string url attribute 52
- clear-source
- robot application function 111
- Cmd-Hook
- process.conf parameter 92
- cmd-Hook
- writing 99
- colors
- for search results 33
- command-port
- process.conf parameter 92
- Compass Server database
- see database
- Compass Server end user page 11, 15
- definition 193
- Compass Server Java SDK 171, 173
- adding entries to database 189
- checking processing status 179
- creating a Search object 176
- downloading and installing 174
- executing a query 178
- formatting results as HTML 180
- getting results of a query 179
- Results class 180
- Compass Server robots
- see robots
- compiling
- robot application functions 130
- completion scripts 99
- composition of end user page 15
- configuration file for UI templates
- definition 193
- configuration files for UI templates 23
- connect-timeout
- process.conf parameter 92
- convert-timeout
- process.conf parameter 92
- convert-to-html
- robot application function 111
- copy-attribute
- robot application function 111
- creating
- a Search object in Java 176
- new UI templates 20
- SOIF streams 151
- cs.h 122
- csid.conf 21
- csidcf.h 122
- csinfo.h 122
- cslog_error 129
- csmem.h 122
- CSResource 127
- custom functions
- loading 132
- using 133
D
- data stage 86
- sources for 105, 123
- database
- getting contents as a SOIF stream 140
- searches initiated by form 53
- using Java to interact with 173
- defining
- robot application functions 123
- demo applications
- in Compass Server Java SDK 174
- denying
- resources 85
- SOIF attributes 154
- depth
- process.conf parameter 93
- destinations
- for robot application functions 104
- directive
- definition 193
- directives
- for filters 88
- functions and 120
- writing RAFs for 123
- document conventions ix
- document-browse-bottom
- pattern file 50
- document-browse-hit
- pattern file 48
- document-browse-top
- pattern file 47
- document-search-results-bottom
- pattern file 50
- document-search-results-hit
- pattern file 48
- document-search-results-top
- pattern file 47
- doIncrementalQuery() Java function 178
- doQuery() Java function 178
- downloading
- Compass Server Java SDK 174
- dumping
- the database as a SOIF stream 140
E
- email
- process.conf parameter 93
- enable parameter 106
- enable-ip
- process.conf parameter 93
- enable-rdm-probe
- process.conf parameter 93
- enable-robots-txt
- process.conf parameter 94
- end user page 11, 15, 19
- advanced search interface 55
- composition 15
- error messages 76
- opening with query string urls 51
- see also UI templates
- templates 19
- templates directory 20
- tutorial 58
- which attributes can be viewed? 28
- which tasks are allowed 27
- engine-concurrent
- process.conf parameter 94
- enumerate
- filter stage 87
- enumerate-urls
- robot application function 114
- enumerate-urls-from-text
- robot application function 115
- enumeration functions
- robot application functions 114
- enumeration stage
- sources for 106, 124
- enumeration-filter
- parameter in process.conf 84
- process.conf parameter 94
- enumerator filter 81
- error messages
- when accessing Compass Server 76
- errors
- reporting in robot application functions 129
- reporting to log files 129
- setting response status codes 128
- example4
- RDM example 162
- examples
- robot application function definition 130
- robot application functions 120
- executing a query
- in Java 178
- extract-full-text
- robot application function 115
- extract-html-meta
- robot application function 115
- extract-html-text
- robot application function 116
- extract-html-toc
- robot application function 116
- extract-source
- robot application function 116
F
- files
- used by robots 84
- filter directives 88
- filter syntax 87
- filter.conf 84, 103
- loading shared objects 132
- using functions in 133
- filter-by-exact
- robot application function 108
- filter-by-max
- robot application function 108
- filter-by-md5
- robot application function 109
- filter-by-prefix
- robot application function 109
- filter-by-regex
- robot application function 109
- filtering
- SOIF attributes 154
- filtering functions
- robot application functions 107
- filtering process
- for robots 85
- filtering support functions
- robot application functions 110
- filterrules.conf 84
- filterrules.h 122
- filterrules-process
- robot application function 110
- filterrules-setup
- robot application function 107
- filterrules-shutdown
- robot application function 117
- filters
- writing 89
- formatting results as HTML in Java 180
- forms
- for submitting searches in Compass Server database 53
- and LiveWire viii
- function list
- alphabetical SOIF API 141
- functions
- directives and 120
- loading in filter.conf 132
- passing parameters among 123
- response status codes 128
- using in filter.conf 133
G
- generate
- stage 87
- generate-by-exact
- robot application function 112
- generate-by-prefix
- robot application function 112
- generate-by-regex
- robot application function 113
- generate-md5
- robot application function 113
- generate-rd-expires
- robot application function 113
- generate-rd-last-modified
- robot application function 114
- generation functions
- robot application functions 115
- generation stage
- sources for 106, 124
- generation-filter
- parameter in process.conf 84
- process.conf parameter 94
- generator filter 81
- getopt.h 122
- getSOIFResult() Java function 179
- getStringResult() Java function 178, 179
- getting results of a query in Java 179
H
- harvest-summarizer
- robot application function 117
- header files
- robot sdk 121
- HP-UX, compiling for 132
- HTML
- and Livewire viii
I
- images
- for scoring search results 32
- increase() 156
- index-after-ngenerated
- process.conf parameter 95
- installing
- Compass Server Java SDK 174
- IRIX, compiling for 132
J
- Java
- see Compass Server Java SDK
- Java SDK 171, 173
- see Compass Server Java SDK
- Java tutorial 171
L
- libcs_param_create 125
- libcs_param_free 125
- libcs_pb_entry 124
- libcs_pb_param 124
- libcs_pblock 124
- libcs_pblock_create 126
- libcs_pblock_find 126
- libcs_pblock_findval 126
- libcs_pblock_free 126
- libcs_pblock_nninsert 126
- libcs_pblock_nvinsert 126
- libcs_pblock_pblock2str 126
- libcs_pblock_pinsert 126
- libcs_pblock_remove 126
- libcs_pblock_str2pblock 126
- LiveWire
- background for using viii
- loading
- robot application functions 132
- UI templates 21
- log file
- reporting errors to 129
- log.h
- content description 122
- getting 129
- loglevel
- process.conf parameter 95
M
- makefile 131
- matching category
- definition 193
- matching document
- definition 193
- max-concurrent
- process.conf parameter 95
- max-filesize-kb
- process.conf parameter 95
- max-memo
- process.conf parameter 95
- max-memory-per-url
- process.conf parameter 95
- max-working
- process.conf parameter 96
- memory buffer management 155
- metadata
- stage 86
- metadata sources
- for robot application functions 104
- metadata stage
- sources for 104, 123
- minidba 140
- multi-valued attribute routines 147
N
- Netscape servers
- plug-in API and 120
- NSAPI Programmer's Guide 125
O
- objlog.h
- getting 129
- onCompletion
- process.conf parameter 96
- order of search results 26
- OSF/1, compiling for 132
P
- page
- query string url attribute 53
- parameter block
- definition 193
- parameter blocks
- functions 125
- working with 125
- parameters
- for robot application functions 124
- parsing SOIF streams 151
- passing parameters to functions 123
- password
- process.conf parameter 96
- pattern file
- definition 193
- pattern files 34
- assigning to components 24
- special variables 35
- summary of 44
- pblock
- definition 193
- pblock.h 122
- pblocks
- in RAFs 124
- see also parameter blocks
- working with 125
- plug-in API
- described 120
- servers use of 120
- Unix systems supported 119
- PostConnection Java class 189
- printing SOIF streams 151
- process.conf 84
- parameters 91
- sample file 99
- prototype
- robot application functions 123
Q
- query requests
- with RDM API 161
- query string urls
- attributes 51
- for opening end user page 51
R
- RAF
- definition 194
- RAFs 103
- see robot application functions
- rating
- images for 32
- RD
- definition 194
- RDM 157
- API reference 165
- body 159
- C API 157
- creating and freeing structures 165
- definition 194
- header 158
- other structures 169
- query request 159
- syntax 158
- URL to more info 158
- using to access Compass Server database 157
- version 165
- rdm.h
- contents 160
- where it is 157
- RDM_Version 165
- RDM-browse-bottom 24
- RDM-browse-top 24
- RDM-category-browse-bottom 25
- RDM-category-browse-hit 25
- RDM-category-browse-top 24
- RDM-category-browse-view-attributes 28
- RDM-category-browse-view-hits 29
- RDM-category-browse-view-order 29
- RDM-category-match-bottom 26
- RDM-category-match-hit 25
- RDM-category-match-top 25
- RDM-category-match-view-attributes 30
- RDM-category-match-view-order 30
- RDMClassification 169
- RDM-default-browse-category 31
- RDM-default-chunk-size 31
- RDM-default-page 31
- RDM-default-scope 31
- RDM-default-search-category 31
- RDM-description 24
- RDM-document-browse-bottom 25
- RDM-document-browse-hit 25
- RDM-document-browse-top 25
- RDM-document-browse-view-attributes 29
- RDM-document-browse-view-hits 29
- RDM-document-browse-view-order 30
- RDM-document-match-bottom 26
- RDM-document-match-hit 26
- RDM-document-match-top 26
- RDM-document-match-view-attributes 30
- RDM-document-match-view-order 31
- RDMHeader 166
- RDMHeader_Create() 167
- RDMHeader_CreateRequest() 167
- RDMHeader_CreateResponse() 167
- RDMHeader_Free() 167
- RDMHeader_GetCSID() 167
- RDMHeader_GetErrorMessage() 167
- RDMHeader_GetErrorNumber() 167
- RDMHeader_GetQueryLanguage() 167
- RDMHeader_GetResponseInterpret() 167
- RDMHeader_GetType() 167
- RDMHeader_Merge() 167
- RDMHeader_Parse() 167
- RDMHeader_SetCSID() 167
- RDMHeader_SetErrorMessage() 167
- RDMHeader_SetErrorNumber() 167
- RDMHeader_SetQueryLanguage() 167
- RDMHeader_SetResponseInterpret() 167
- RDMHeader_SetType() 167
- RDMHeader_SetVersion() 167
- RDM-perform-category-browse 27
- RDM-perform-category-match 27
- RDM-perform-document-browse 27
- RDM-perform-document-match 27
- RDMQuery 168
- RDMQuery_Create() 168
- example 160
- RDMQuery_Free() 168
- RDMQuery_GetScope() 168
- RDMQuery_GetViewAttr() 168
- RDMQuery_GetViewHits() 168
- RDMQuery_GetViewTemplate() 168
- RDMQuery_Merge() 168
- RDMQuery_Parse() 168
- RDMQuery_SetScope() 168
- RDMQuery_SetViewAttr() 168
- example 160
- RDMQuery_SetViewHits() 168
- RDMQuery_SetViewOrder() 168
- RDMQuery_SetViewTemplate() 168
- rdm-query-language attribute 166
- RDMRequest 169
- RDMResponse 169
- RDM-rotated-colors 33
- RDMSchema 169
- RDM-score-icon1 32
- RDM-score-icon2 32
- RDM-score-icon3 32
- RDM-score-icon4 32
- RDM-score-icon5 32
- RDM-search-results-bottom 25
- RDM-search-results-order 26
- RDM-search-results-top 25
- RDMServer 169
- RDMTaxonomy 169
- RDM-Type attribute
- possible values 166
- rdm-type attribute 166
- rdm-version attribute 166
- RDMView 169
- RDM-view variables 28
- RDMViewHits 169
- RDMViewOrder 169
- RDMX_Create() 165
- RDMX_Free() 165
- RDMX_merge() 165
- RDMX_Parse() 165
- register-password
- process.conf parameter 97
- register-user
- process.conf parameter 97
- remote-access
- process.conf parameter 97
- rename-attribute
- robot application function 114
- REQ_ABORTED 128
- REQ_EXIT 128
- REQ_NOACTION 128
- REQ_PROCEED 128
- REQ_RESTART 128
- request
- RDM 159
- reset() 156
- resource description
- definition 194
- resource description message
- definition 194
- resource description messges
- see RDM
- resources
- for robot application functions 127
- response status codes 128
- functions and 128
- setting 128
- resultCount() Java function 180
- Results Java class 180
- resultsToHTML() Java function 181
- robot application function
- definition 194
- robot application functions
- compiling and linking 130
- defining 123
- defining new ones 119
- enumeration functions 114
- example definition 130
- filtering functions 107
- filtering support functions 110
- generation functions 115
- getting info about the resource being processed 127
- header files 121
- linking 130
- loading 132
- metadata sources 104
- passing in parameters 124
- pre-defined 103
- prototype 123
- reporting errors 129
- response status codes 128
- setup functions 106
- shutdown functions 117
- using new ones 133
- robot plug-in api 120
- robot sdk
- header files 121
- robotapi.h 122
- robots 79
- destinations for robot application functions 104
- enumerator 81
- files they use 84
- filter directives 88
- filter syntax 87
- filter.conf 84
- filtering process 85
- filterrules.conf 84
- generator 81
- how they work 81
- parameters in process.conf 91
- pre-defined robot application functions 103
- process.conf 84
- robot api 103
- sample process.conf file 99
- setting process parameters 84
- sources for robot application functions 104
- what are they? 81
- writing filters (overview) 89
- robot-statedir
- process.conf parameter 97
- robots-txt-refresh-rate
- process.conf parameter 97
- rotating colors
- for search results 33
S
- saving
- UI templates 20
- schema
- definition 194
- schema-name 143
- process.conf parameter 97
- scope
- query string url attribute 52
- RDMQuery attribute 168
- scoring
- images for 32
- scripts
- completion 99
- sdk/rdm/include 137
- sdk/robot/examples 120
- sdk/robot/include 120
- search results
- order of 26
- search results page
- definition 194
- search-category
- query string url attribute 53
- searches
- using forms 53
- searching
- Java example 181
- SearchPanel.html 174
- SearchPanel.java 174
- search-results mode 16
- search-results page
- components of 17
- search-results-bottom
- pattern file 50
- search-results-mode-top
- pattern file 44
- seed URLs 85
- selecting
- new UI template 21
- sending
- query 161
- sendrdm 161
- example use 162
- where is it 161
- server-delay
- process.conf parameter 98
- setDisplay() Java function 180
- setDisplayAsLink() Java function 180
- setScoreGif() Java function 180
- setting
- response status codes 128
- robot process parameters 84
- setup
- stage 86
- setup functions
- robot application functions 106
- setup stage
- sources for 104, 123
- setup-regex-cache
- robot application function 107
- setup-type-by-extension
- robot application function 107
- shared objects
- described 132
- loading 132
- shutdown
- filter stage 87
- shutdown functions
- robot application functions 117
- shutdown stage
- sources for 106, 124
- smart-host-heuristics
- process.conf parameter 98
- SOIF
- allowing and denying attributes 154
- API 137
- attribute-value pairs 138, 143
- definition 137, 194
- example 138
- filtering attributes 154
- finding attribute values 145
- objects 143
- parsing 151
- printing 151
- schema-name 143
- URL 143
- soif
- fields in RDMHeader and RDMQuery 161
- SOIF attributes 36
- definition 194
- SOIF streams 151
- allowing and denying 154
- memory buffer management 155
- SOIF_Apply() 145
- SOIF_AttributeCompare() 147
- SOIF_AttributeCompareMV() 148
- SOIF_Contains() 150
- SOIF_Create() 143
- SOIF_DeleteMV() 149
- SOIF_Find() 144
- SOIF_Findval() 145
- example in RAF 127
- SOIF_FindvalMV() 149
- SOIF_Free() 143
- SOIF_GetAttributeCount() 144
- SOIF_GetAttributeSize() 144
- SOIF_GetTotalSize() 143
- SOIF_GetValueCount() 144
- SOIF_GetValueSize() 144
- SOIF_Insert() 145
- SOIF_InsertAVP() 145
- SOIF_InsertMV() 148
- SOIF_InsertStr() 146
- SOIF_IsMVAttribute() 148
- SOIF_Merge() 144
- SOIF_MVAttributeParse() 148
- SOIF_ParseInitFile() 153
- SOIF_ParseInitStr() 153
- SOIF_PrintInitFile() 152
- SOIF_PrintInitFn() 152
- SOIF_PrintInitStr() 152
- SOIF_Remove() 145
- SOIF_Rename() 147
- SOIF_Replace() 146
- SOIF_ReplaceMV() 149
- SOIF_ReplaceStr() 147
- SOIF_SqueezeMV() 149
- SOIFAVPair 146
- routines 146
- SOIFAVPair_Create() 146
- SOIFAVPair_Free() 146
- SOIFAVPair_IsMV() 150
- SOIFAVPair_NthValid() 150
- SOIFAVPair_NthValue() 150
- SOIFAVPair_NthVsize() 150
- SOIFBuffer_Create() 155
- SOIFBuffer_Free() 156
- SOIFSteam
- routines 151
- SOIFstream
- getting database contents as a 140
- SOIFStream_Finish() 153
- SOIFStream_GetAllowed() 155
- SOIFStream_GetDenied() 155
- SOIFStream_IsAllowed() 154
- SOIFStream_IsEOS() 154
- SOIFStream_IsParsing() 154
- SOIFStream_IsPrinting() 154
- SOIFStream_Parse() 153
- SOIFStream_Print() 153
- SOIFStream_SetAllowed() 155
- SOIFStream_SetDenied() 155
- SOIFStream_SetFinishFn() 153
- Solaris, compiling RAFs for 132
- sources
- for data stage 105, 123
- for directives 104, 123
- for enumeration stage 106, 124
- for generation stage 106, 124
- for metadata stage 104, 123
- for robot application functions 104
- for setup stage 104, 123
- for shutdown stage 106, 124
- special variables
- for pattern files 35
- syntax 35
- status codes 128
- streams
- SOIF 151
- SubmitDemo.html 176
- SubmitDemo.java 176
- submitting
- query 161
- submitting searches
- using forms 53
- summary
- of pattern files 44
- SunOS, compiling RAFs for 132
- syntax
- for robot filters 87
- for variables in pattern files 35
- systems.h 122
T
- taxonomy
- query string url attribute 52
- template-refresh-rate variable 21
- templates 19
- end user page 19
- see also UI templates
- templates directory 20
- tmpdir
- process.conf parameter 98
- toScoreGifHTML() Java function 181
- tutorial
- customing end user page 58
U
- ui
- query string url attribute 51
- UI page 11, 15
- see end user page 15
- UI templates 19
- advanced search interface 55
- configuration files 23
- creating 20
- definition 194
- error messages 76
- images to show scores 32
- loading 21
- pattern files 34
- refresh rate 21
- saving 20
- see also end user page
- selecting a new one 21
- specifying basic parameters 31
- tutorial 58
- Unix
- systems supporting plug-in API 119
- user-agent
- process.conf parameter 98
- username
- process.conf parameter 98
- using
- Java to interact with Compass Server database 173
- new robot application functions 133
V
- variables
- in UI template configuration files 24
- view template
- definition 194
- view-attributes attribute 168
- view-hit attribute 168
- view-order attribute 168
- view-template
- query string url attribute 52
- view-template attribute 168
W
- Windows NT, compiling RAFs for 132
- writing
- robot application functions 123
[Contents] [Previous] [Next] [Last]
Last Updated: 02/07/98 20:49:27
Any sample code included above is provided for your use on an "AS IS" basis, under the Netscape License Agreement - Terms of Use