Loading TOC...
JavaScript fn.id

MarkLogic Server 11.0 Product Documentation
fn:id

fn:id(
   $arg as xs:string*,
   [$node as node()]
) as element()*

Summary

Returns the sequence of element nodes that have an ID value matching the value of one or more of the IDREF values supplied in $arg.

Parameters
arg The IDs of the elements to return.
node The target node.

Usage Notes

The function returns a sequence, in document order with duplicates eliminated, containing every element node E that satisfies all the following conditions:

  1. E is in the target document. The target document is the document containing $node, or the document containing the context node if the second argument is omitted. An error is raised [err:FODC0001] if $node, or the context item if the second argument is omitted, is a node in a tree whose root is not a document node or if the second argument is omitted and there is no context item [err:FONC0001], or if the context item is not a node [err:FOTY0011].
  2. E has an ID value equal to one of the candidate IDREF values, where:
    • An element has an ID value equal to V if either or both of the following conditions are true:
      • The is-id property (See Section 5.5 is-id AccessorDM.) of the element node is true, and the typed value of the element node is equal to V under the rules of the eq operator using the Unicode code point collation (http://www.w3.org/2005/xpath-functions/collation/codepoint).
      • The element has an attribute node whose is-id property (See Section 5.5 is-id AccessorDM.) is true and whose typed value is equal to V under the rules of the eq operator using the Unicode code point collation (http://www.w3.org/2005/xpath-functions/collation/codepoint).
    • Each xs:string in $arg is parsed as if it were of type IDREFS, that is, each xs:string in $arg is treated as a space-separated sequence of tokens, each acting as an IDREF. These tokens are then included in the list of candidate IDREFs. If any of the tokens is not a lexically valid IDREF (that is, if it is not lexically an xs:NCName), it is ignored. Formally, The candidate IDREF values are the strings in the sequence given by the expression: 
      for $s in $arg
return fn:tokenize(fn:normalize-space($s), ' ')
                 [. castable as xs:IDREF]
  3. If several elements have the same ID value, then E is the one that is first in document order.

Notes:

If the data model is constructed from an Infoset, an attribute will have the is-id property if the corresponding attribute in the Infoset had an attribute type of ID: typically this means the attribute was declared as an ID in a DTD.

If the data model is constructed from a PSVI, an element or attribute will have the is-id property if its schema-defined type is xs:ID or a type derived by restriction from xs:ID.

No error is raised in respect of a candidate IDREF value that does not match the ID of any element in the document. If no candidate IDREF value matches the ID value of any element, the function returns the empty sequence.

It is not necessary that the supplied argument should have type xs:IDREF or xs:IDREFS, or that it should be derived from a node with the is-idrefs property.

An element may have more than one ID value. This can occur with synthetic data models or with data models constructed from a PSVI where an the element and one of its attributes are both typed as xs:ID.

If the source document is well-formed but not valid, it is possible for two or more elements to have the same ID value. In this situation, the function will select the first such element.

It is also possible in a well-formed but invalid document to have an element or attribute that has the is-id property but whose value does not conform to the lexical rules for the xs:ID type. Such a node will never be selected by this function.

Example

let $x := document{
  <html xmlns="http://www.w3.org/1999/xhtml">
    <p id="myID">hello</p>
  </html> }
return
fn:id("myID", $x)

=> <p id="myID" xmlns="http://www.w3.org/1999/xhtml">hello</p>

Example

xquery version "1.0-ml";
declare namespace xh="http://www.w3.org/1999/xhtml";

let $x := document {
  <html xmlns="http://www.w3.org/1999/xhtml">
    <p id="myID">hello</p>
    <p>hello</p>
  </html> }
return
$x/xh:html/xh:p[. is fn:id("myID")]

=> <p id="myID" xmlns="http://www.w3.org/1999/xhtml">hello</p>

Stack Overflow iconStack Overflow: Get the most useful answers to questions from the MarkLogic community, or ask your own question.