|
PF/Tijah Home
Documentation
   |
Table of contents
pf:add-doc
| Signatures: | pf:add-doc($url as xs:string, $name as xs:string) as docmgmt |
| | pf:add-doc($url as xs:string, $name as xs:string, $coll as xs:string) as docmgmt |
| Purpose: | Add a document to the database |
| Parameters: | $url: full path or url of the XML document |
| | $name: logical name of the document in the database (must be unique) |
| | $coll: name of collection to which the document is added (optional) |
| Returns: | Nothing (docmgmt is an internal type that is returned by document management functions. Items of type docmgmt are not serialized as XML) |
| Status: | IMPLEMENTED |
| Remarks: | If no collection is specified, the logical name of the document will function as a collection with one document. |
tijah:create-ft-index
| Signatures: | tijah:create-ft-index( ) as docmgmt |
| | tijah:create-ft-index( $colls as xs:string* ) as docmgmt |
| | tijah:create-ft-index( $opt as node() ) as docmgmt |
| | tijah:create-ft-index( $colls as xs:string*, $opt as node() ) as docmgmt |
| Purpose: | Create a full text index on one or more Pathfinder collections. |
| Parameters: | $colls: Sequence of collection names to index. (optional) |
| | $opt: A single node <TijahOptions /> (optional) |
| Returns: | Nothing (docmgmt is an internal type that is returned by document management functions. Items of type docmgmt are not serialized as XML) |
| Status: | IMPLEMENTED |
| Remarks: | If no collections are specified, the full text index is created for all collections in the database. |
tijah:delete-ft-index
| Signatures: | tijah:delete-ft-index( ) as docmgmt |
| | tijah:delete-ft-index( $opt as node() ) as docmgmt |
| Purpose: | Delete a full text index. |
| Parameters: | $opt: A single node <TijahOptions /> (optional) |
| Returns: | Nothing (see tijah:create-ft-index()) |
| Status: | IMPLEMENTED |
| Remarks: | The option node is only needed to remove named indexes, for instance <TijahOptions ft-index="myindex"/>. |
tijah:extend-ft-index
| Signatures: | tijah:extend-ft-index( $colls as xs:string* ) as docmgmt |
| | tijah:extend-ft-index( $colls as xs:string*, $opt as node() ) as docmgmt |
| Purpose: | Extend a full text index with one or more Pathfinder collections. |
| Parameters: | $colls: Sequence of collection names to index. (optional) |
| | $opt: A single node <TijahOptions /> (optional) |
| Returns: | Nothing (see tijah:create-ft-index()) |
| Status: | IMPLEMENTED |
| Remarks: | The option node is only needed to extend named indexes, for instance <TijahOptions ft-index="myindex"/>. |
tijah:ft-index-info
| Signatures: | tijah:ft-index-info( ) as element()* |
| | tijah:ft-index-info( $ft-index as xs:string ) as element()* |
| Purpose: | Give info about existing full text indexes. |
| Parameters: | $ft-index: Name of full text index (optional) |
| Returns: | A single element for each index, for instance <ftindex collections="*" tokenizer="flex" stemmer="nostemming">DFLT_FT_INDEX</ftindex>, or nothing if there is no index. |
| Status: | IMPLEMENTED |
tijah:nodes
| Signature: | tijah:nodes( $qid as xs:integer ) as node()* |
| Purpose: | Get the result nodes given a query result identifier. |
| Parameters: | $qid: the query identifier must be created by tijah:query-id() or tijah:queryall-id() in the same XQuery statement. |
| Returns: | A sequence containing the result nodes sorted on relevance. |
| Status: | IMPLEMENTED |
tijah:query
| Signatures: | tijah:query( $start as node()*, $nexi as xs:string ) as node()* |
| | tijah:query( $start as node()*, $nexi as xs:string, $opt as node() ) as node()* |
| Purpose: | Run an NEXI query on a predefined full-text index. |
| Parameters: | $start: Sequence of nodes to restrict the query on. |
| | $nexi: NEXI query. |
| | $opt: A single node <TijahOptions /> (optional) |
| Returns: | A sequence of nodes, sorted on relevance |
| Status: | IMPLEMENTED |
| Remarks: | Semantically, this function is a shortcut for tijah:nodes( tijah:query-id() ). |
tijah:query-id
| Signature: | tijah:query-id( $start as node()*, $nexi as xs:string ) as xs:integer |
| | tijah:query-id( $start as node()*, $nexi as xs:string, $opt as node() ) as xs:integer |
| Purpose: | Run an NEXI query on a predefined full-text index. |
| Parameters: | $start: Sequence of nodes to restrict the query on. |
| | $nexi: NEXI query. |
| | $opt: A single node <TijahOptions /> (optional) |
| Returns: | A unique query result identifier. |
| Status: | IMPLEMENTED |
tijah:queryall
| Signatures: | tijah:query( $nexi as xs:string ) as node()* |
| | tijah:query( $nexi as xs:string, $opt as node() ) as node()* |
| Purpose: | Run an NEXI query on all data in a predefined full-text index. |
| Parameters: | $nexi: NEXI query. |
| | $opt: A single node <TijahOptions /> (optional) |
| Returns: | A sequence of nodes, sorted on relevance |
| Status: | IMPLEMENTED |
| Remarks: | Semantically, this function is a shortcut for tijah:nodes( tijah:queryall-id() ). |
tijah:queryall-id
| Signature: | tijah:queryall-id( $nexi as xs:string ) as xs:integer |
| | tijah:queryall-id( $nexi as xs:string, $opt as node() ) as xs:integer |
| Purpose: | Run an NEXI query on a predefined full-text index. |
| Parameters: | $nexi: NEXI query. |
| | $opt: A single node <TijahOptions /> (optional) |
| Returns: | A unique query result identifier. |
| Status: | IMPLEMENTED |
tijah:resultsize
| Signature: | tijah:resultsize( $qid as xs:integer ) as xs:integer |
| Purpose: | Return the size of the result of a tijah query. |
| Parameters: | $qid: the query identifier must be created by tijah:query-id() or tijah:queryall-id() in the same XQuery statement. |
| Returns: | Number of nodes to be returned by the query. |
| Status: | IMPLEMENTED |
tijah:score
| Signature: | tijah:score( $qid as xs:integer, $node as node()* ) as xs:double* |
| Purpose: | Get the score values from a sequence of nodes. |
| Parameters: | $qid: the query identifier must be created by tijah:query-id() or tijah:queryall-id() in the same XQuery statement. |
| | $node: sequence of nodes |
| Returns: | A sequence containing the scores of the nodes passed in the second argument, in the same order. If a node was not scored it gets a score zero. |
| Status: | IMPLEMENTED |
tijah:tokenize
| Signature: | tijah:tokenize( $str as xs:string ) as xs:string |
| Purpose: | Tokenize a string using the standard Tijah tokenizer. |
| Parameters: | $str: The string to be tokenized. |
| Returns: | The tokenized string |
| Status: | IMPLEMENTED |
|
