Menu
▾
▴
[Exist-development] Deprecated functions to be removed from trunk in the next month
|
From: Loren C. <lor...@gm...> - 2010-03-18 18:54:56
|
The following 17 deprecated functions will be removed from trunk sometime in the following month. This is to help with the maintenance of the codebase. Unsupported functionality needs to be removed so that enhancements that are being developed elsewhere in the system do not inadvertently break an unsupported feature. Please check your code and make the appropriate changes to the replacement functions. Regards, Loren metadata http://exist-db.org/xquery/metadata A module for accessing the metadata for the dynamic context. metadata metadata:metadata() node()? Retrieves metadata for the dynamic context. If the context item is undefined an error is raised. Returns the metadata documents Deprecated: An orphaned experiment. This function could be removed at anytime during the 1.5 development and will be removed in the 1.6 release. request http://exist-db.org/xquery/request A module for dealing with HTTP requests. get-uploaded-file request:get-uploaded-file($upload-param-name as xs:string) item()? Retrieve the Java file object where the file part of a multi-part request has been stored. Returns the empty sequence if the request is not a multi-part request or the parameter name does not point to a file part. $upload-param-name The parameter name Deprecated: Deprecated in favour of get-uploaded-file-data() This function could be removed at anytime during the 1.5 development and will be removed in the 1.6 release. text http://exist-db.org/xquery/text A module for text searching extension functions. kwic-display text:kwic-display($text as text()*, $width as xs:positiveInteger, $callback-function as function, $parameters as item()*) node()* Deprecated: kwic functionality is now provided by an XQuery module, see http://exist-org/kwic.html.This function takes a sequence of text nodes in $a, containing matches from a fulltext search. It highlights matching strings within those text nodes in the same way as the text:highlight-matches function. However, only a defined portion of the text surrounding the first match (and maybe following matches) is returned. If the text preceding the first match is larger than the width specified in the second argument $b, it will be truncated to fill no more than (width - keyword-length) / 2 characters. Likewise, the text following the match will be truncated in such a way that the whole string sequence fits into width characters. The third parameter $c is a callback function (defined with util:function). $d may contain an additional sequence of values that will be passed to the last parameter of the callback function. Any matching character sequence is reported to the callback function, and the result of the function call is inserted into the resulting node set where the matching sequence occurred. For example, you can use this to mark all matching terms with a <span class="highlight">abc</span>. The callback function should take 3 or 4 arguments: 1) the text sequence corresponding to the match as xs:string, 2) the text node to which this match belongs, 3) the sequence passed as last argument to kwic-display. If the callback function accepts 4 arguments, the last argument will contain additional information on the match as a sequence of 4 integers: a) the number of the match if there's more than one match in a text node - the first match will be numbered 1; b) the offset of the match into the original text node string; c) the length of the match as reported by the index. $text The text nodes $width The width $callback-function The callback function $parameters The parameters passed into the last argument of the callback function Returns the results Deprecated: Improved kwic functionality is now provided by a separate XQuery module, see http://exist-db.org/kwic.html. This function could be removed at anytime during the 1.5 development and will be removed in the 1.6 release. kwic-display text:kwic-display($text as text()*, $width as xs:positiveInteger, $callback-function as function, $result-callback as function, $parameters as item()*) node()* This function takes a sequence of text nodes in $a, containing matches from a fulltext search. It highlights matching strings within those text nodes in the same way as the text:highlight-matches function. However, only a defined portion of the text surrounding the first match (and maybe following matches) is returned. If the text preceding the first match is larger than the width specified in the second argument $b, it will be truncated to fill no more than (width - keyword-length) / 2 characters. Likewise, the text following the match will be truncated in such a way that the whole string sequence fits into width characters. The third parameter $c is a callback function (defined with util:function). $d may contain an additional sequence of values that will be passed to the last parameter of the callback function. Any matching character sequence is reported to the callback function, and the result of the function call is inserted into the resulting node set where the matching sequence occurred. For example, you can use this to mark all matching terms with a <span class="highlight">abc</span>. The callback function should take 3 or 4 arguments: 1) the text sequence corresponding to the match as xs:string, 2) the text node to which this match belongs, 3) the sequence passed as last argument to kwic-display. If the callback function accepts 4 arguments, the last argument will contain additional information on the match as a sequence of 4 integers: a) the number of the match if there's more than one match in a text node - the first match will be numbered 1; b) the offset of the match into the original text node string; c) the length of the match as reported by the index. $text The text nodes $width The width $callback-function The callback function $result-callback The result callback function $parameters The parameters passed into the last argument of the callback function Returns the results Deprecated: Improved kwic functionality is now provided by a separate XQuery module, see http://exist-db.org/kwic.html. This function could be removed at anytime during the 1.5 development and will be removed in the 1.6 release. util http://exist-db.org/xquery/util A module for various utility extension functions. serialize util:serialize($a as node()*, $b as xs:string, $c as xs:string*) xs:boolean? Writes the node set passed in parameter $a into a file on the file system. The full path to the file is specified in parameter $b. $c contains a sequence of zero or more serialization parameters specified as key=value pairs. The serialization options are the same as those recognized by "declare option exist:serialize". The function does NOT automatically inherit the serialization options of the XQuery it is called from. False is returned if the specified file can not be created or is not writable, true on success. The empty sequence is returned if the argument sequence is empty. Deprecated: Use the file:serialize() function in the file extension module instead! This function could be removed at anytime during the 1.5 development and will be removed in the 1.6 release. validation http://exist-db.org/xquery/validation A module for XML validation and grammars functions. validate validation:validate($instance as item()) xs:boolean Validate xml. The grammar files (DTD, XML Schema) are resolved using the global catalog file(s). $instance The document referenced as xs:anyURI or a node (element or returned by fn:doc()) Returns true() if the document is valid and no single problem occured, false() for all other conditions. For detailed validation information use the corresponding -report() function. Deprecated: Use the validation:parse(), validation:jaxv() or valation:jing() functions. This function could be removed at anytime during the 1.5 development and will be removed in the 1.6 release. validate validation:validate($instance as item(), $grammar as xs:anyURI) node() Validate document by using a specific grammar. $instance The document referenced as xs:anyURI or a node (element or returned by fn:doc()) $grammar The reference to an OASIS catalog file (.xml), a collection (path ends with '/') or a grammar document. Supported grammar documents extensions are ".dtd" ".xsd" ".rng" ".rnc" ".sch" and ".nvdl". Returns true() if the document is valid and no single problem occured, false() for all other conditions. For detailed validation information use the corresponding -report() function. Deprecated: Use the validation:parse(), validation:jaxv() or valation:jing() functions. This function could be removed at anytime during the 1.5 development and will be removed in the 1.6 release. validate-report validation:validate-report($instance as item()) node() Validate xml. The grammar files (DTD, XML Schema) are resolved using the global catalog file(s). An xml report is returned. $instance The document referenced as xs:anyURI or a node (element or returned by fn:doc()) Returns a validation report. Deprecated: Use the validation:parse-report(), validation:jaxv-report() or valation:jing-report() functions. This function could be removed at anytime during the 1.5 development and will be removed in the 1.6 release. validate-report validation:validate-report($instance as item(), $grammar as xs:anyURI) node() Validate document by using a specific grammar. An xml report is returned. $instance The document referenced as xs:anyURI or a node (element or returned by fn:doc()) $grammar The reference to an OASIS catalog file (.xml), a collection (path ends with '/') or a grammar document. Supported grammar documents extensions are ".dtd" ".xsd" ".rng" ".rnc" ".sch" and ".nvdl". Returns a validation report. Deprecated: Use the validation:parse-report(), validation:jaxv-report() or valation:jing-report() functions. This function could be removed at anytime during the 1.5 development and will be removed in the 1.6 release. xmldb http://exist-db.org/xquery/xmldb A module for database manipulation functions. collection-exists xmldb:collection-exists($collection-path as xs:string, ...) xs:boolean Returns true() if the collection $collection exists and is available, otherwise false(). $collection-path The collection path Returns true() if the collection exists and is available, false() otherwise Deprecated: Use xmldb:collection-available() instead. This function could be removed at anytime during the 1.5 development and will be removed in the 1.6 release. document xmldb:document($document-uris as xs:string+, ...) node()* Returns the documents $document-uris in the input sequence. Collection URIs can be specified either as a simple collection path or an XMLDB URI.If the input sequence is empty, the function will load all documents in the database. $document-uris The document URIs Returns the documents Deprecated: See the standard fn:doc() function This function could be removed at anytime during the 1.5 development and will be removed in the 1.6 release. http://www.w3.org/2005/xpath-functions A module with the XQuery/XPath Core Library Functions doctype doctype($doctype as xs:string+) node()* Returns the document nodes of the documents based on the DOCTYPE. $doctype one or more DOCTYPE names Returns the document nodes matching the DOCTYPE names Deprecated: This function is eXist-specific and deprecated. It should not be in the standard functions namespace. Please use util:doctype() instead. This function could be removed at anytime during the 1.5 development and will be removed in the 1.6 release. document document($document-uris as xs:string+, ...) node()* Returns the documents specified in the input sequence. This function is specific to eXist and will be replaced with the corresponding fn:doc function. Collection URIs can be specified either as a simple collection path or an XMLDB URI. If the input sequence is empty, the function will load all documents in the database. $document-uris The document URIs Returns the documents Deprecated: Moved to the 'http://exist-db.org/xquery/xmldb' namespace since it conflicts with the XSLT 2.0 function. This function could be removed at anytime during the 1.5 development and will be removed in the 1.6 release. item-at item-at($source as item()*, $index as xs:integer) item()? Returns the item in $source that is located at the position specified by $index. $source The source sequence $index The index of the item in the source sequence to return Returns the item Deprecated: This function is eXist-specific and deprecated. It should not be in the standard functions namespace. Use e.g. $x[1] instead. This function could be removed at anytime during the 1.5 development and will be removed in the 1.6 release. match-all match-all($nodes as node()*, $regular-expression as xs:string+, ...) node()* Tries to match each of the regular expression strings passed in $regular-expression and all following parameters against the keywords contained in the old fulltext index. The keywords found are then compared to the node set in $nodes. Every node containing all of the keywords is copied to the result sequence. $nodes The node set that is to be searched for the keyword set $regular-expression The regular expressions to be matched against the fulltext index Returns the sequence of all of the matching nodes Deprecated: This function is eXist-specific and should not be in the standard functions namespace. Please use text:match-all() instead. This function could be removed at anytime during the 1.5 development and will be removed in the 1.6 release. match-any match-any($nodes as node()*, $regular-expression as xs:string+, ...) node()* Tries to match each of the regular expression strings passed in $regular-expression and all following parameters against the keywords contained in the old fulltext index. The keywords found are then compared to the node set in $nodes. Every node containing any of the keywords is copied to the result sequence. $nodes The node set that is to be searched for the keyword set $regular-expression The regular expressions to be matched against the fulltext index Returns the sequence of all of the matching nodes Deprecated: This function is eXist-specific and should not be in the standard functions namespace. Please use text:match-any() instead. This function could be removed at anytime during the 1.5 development and will be removed in the 1.6 release. xcollection xcollection($collection-uris as xs:string+, ...) node()* Returns the document nodes in the collections $collection-uris non-recursively, i.e. does not include document nodes found in sub-collections. C.f. fn:collection(). Collection URIs can be specified either as a simple collection path or an XMLDB URI. $collection-uris The collection URIs Returns the document nodes from the specified collections excluding sub-collections Deprecated: This function is eXist-specific and deprecated. It should not be in the standard functions namespace. Please use http://exist-db.org/xquery/xmldb:xcollection() instead. This function could be removed at anytime during the 1.5 development and will be removed in the 1.6 release. |
