This is a
The WG is republishing this revised Use Cases document on 28 January 2010 to reflect changes that have been made in response to comments submitted on the revised Candidate Recommendation of the XQuery and XPath Full Text 1.0 specification.
This document incorporates changes made against the
Please report errors in this document using W3C's
Publication as a Working Draft does not imply endorsement by the W3C Membership. This is a draft document and may be updated, replaced or obsoleted by other documents at any time. It is inappropriate to cite this document as other than work in progress.
This document was produced by groups operating under the
This document specifies usage scenarios for full-text
queries as part of XQuery
(1) Use a current operating system and browser.
(2) If necessary, set the character encoding in the browser manually to Unicode or UTF-8. Often this setting may be changed from the View menu.
(3) If after setting the character encoding to Unicode, the Chinese characters in the subject elements of the sample data still do not display, it is likely that the browser cannot locate a font that contains Chinese characters in Unicode encoding. It might be necessary to add a Unicode font, preferably Arial Unicode MS.
The use cases listed below were created by the
The document supplements the XML Query Use Cases which can be found in the W3C
XML Query Use Cases
These use cases:
(1) Present some possible functions and features for tokenized text support in XQuery and XPath.
(2) Illustrate simple and complex queries. The more complex queries would normally only be constructed by programmers, librarians, and other expert users. Sometimes they may be provided for novice users via saved queries and graphical user interfaces. Each query illustrates a single functionality. Queries may overlap in their functionalities (e.g., phrases and ordered distance queries allowing no intervening words). Overlapping and similar functionalities are noted in the comments on query behavior.
(3) Draw from sample data which are almost entirely in English. Use cases in other languages are solicited, especially where they illustrate language-specific implementations of functions and features. Among the most sought after are use cases for queries using prefix and infix wildcards, proximity queries, and operators and queries requiring functionality which may not have Western language equivalents.
(4) Include queries which in most instances can be written with pure Boolean full-text predicates or
with scoring (e.g., scoring on the number of occurrences of a word or phrase,
scoring on how close words are to one another within a distance
query, scoring on how similar a word is to the one being
stemmed)
(5) Query element content. See Section 4 (OTHER) for explicit queries on attribute values.
(6) Include queries which are case insensitive. When returning a paragraph, the text is returned as it occurs in the data model. This approach was chosen to keep the sample data short and the expected results meaningful. It would have been equally valid to return only the words queried. A case-sensitive query is found in Section 9 (CHARACTER).
(7) Include queries which when they target XML elements are understood, unless otherwise stated, to query text within any text node descendant of the element.
(8) Include queries which return only elements and attributes which meet all the conditions specified in the query. In particular, pure Boolean full-text predicate queries return results where the Boolean conditions in the query are satisfied, i.e., are used to select what is being returned to users.
Query results may be returned in different ways. From a query for books containing the word "usability", users might be interested in returning, for each book containing the word "usability", its number and its entire content. In another situation for the same query, users might be interested in returning, for each book containing the word "usability", its number and only the elements and attributes in the content which contain the word "usability". As in this second situation, the queries in these use cases return only elements and attributes which meet all the conditions specified in the query.
The Return clause may also include additional or different elements and attributes if specified, and may construct new elements.
(9) Include queries which provide some of the basic functionality of fuzzy match querying (e.g., wildcards, stemming, thesaurus support, proximity).
(10) Provide highlighting of found words and phrases in the expected results of queries as an aid to users. The presence of highlighting says nothing about whether highlighting will be a feature of XQuery or XPath full-text querying.
(11) Display query solutions in XQuery and when possible in XPath. Queries that may not be written in XPath include those that contain element constructors and that cannot be written without let, where, and order by clauses.
Examples of full-text querying functionalities for XML query languages
can be found in
To make the output more readable, the output of queries has been formatted using whitespace which may not be returned by a query processor. This whitespace should not be considered normative for the correctness of results.
The queries in these use cases are presented in the following format:
Query number Query title
User statement of query
Statement of functionality illustrated by query
Operands: Parts of words, words, phrases
Functionality: Operators, functions, collations, other functionality
Data context: One XPath expression locating the data being queried.
Query context: One or more XPath expressions locating the elements and attributes to be queried. The context of elements and attributes used in the Query context is relative to the Data context defined above.
Return: One or more XPath expressions which are returned only if the conditions specified in the query are met. Returned elements or attributes may differ from those specified in the Query context. Newly constructed elements might be returned. As in the Query context, the context of elements and attributes in Return statements is relative to the Data context defined above.
Comments: Comments on query behavior in general, and against the sample data in particular, plus the rationale for including this query in the use cases.
The example queries in these use cases are based on a collection with the following XML Schema:
The data consists of a collection of three books. Two are primarily instructive text. The third is a guide to a manuscript collection. All contain metadata and full text.
The sample data binds to this URL: "http://bstore1.example.com/full-text.xml".
These use cases query words and phrases in XML elements with simple content.
These use cases begin with the simplest queries possible. They query a word or phrase in an element with simple content and no descendants. One of these queries is on Chinese characters. Some queries return additional or different elements than were queried. A query queries and returns the full document. Others find a phrase only when it starts an element and find a exact phrase when it is the entire content of an element, allowing full-text variations, such as case, diacritics, and wildcards.
Find all book titles containing the word "usability".
This query finds a word in an element.
Operands: "usability"
Functionality: word query
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./metadata/title
Return: ./metadata/title
Comments: This is the simplest query possible, a query on a word in an element. This query does not employ wildcards, stemming, or thesaurus support. While this query finds useful results in the sample data, many queries such as one on the word "test" would not. A query on the word "test" would return no results, missing the word variants which exist in the sample data: "pretest", "tested", "testers", "testimony", "testing", and "tests".
Find all book subjects containing the phrase "usability testing".
This query finds a phrase in an element.
Operands: "usability testing"
Functionality: phrase query
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./metadata/subjects/subject
Return: ./metadata/subjects/subject
Comments: This is a simple query on a phrase in an element. Like an ordered distance query allowing no intervening words, the words in this phrase query must be adjacent to each other and must appear in the order specified. While this query finds useful results in the sample data, many queries such as one on "software developer" would not. A query on the phrase "software developer" would return no results, missing "developer of software" which exists in the sample data.
Find all book subjects containing the phrase (n-gram) "网站".
This query finds a phrase (n-gram) in an element.
Operands: "网站"
Functionality: phrase query, language qualifier
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./metadata/subjects/subject
Return: ./metadata/subjects/subject
Comments: This query finds a phrase (n-gram) consisting of two Chinese characters. It assumes a specific language dependent tokenization.
Find all books with "usability tests" in book or chapter titles.
This query finds a phrase in different elements.
Operands: "usability tests"
Functionality: phrase query
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./metadata/title, ./content/part/chapter/title
Return: .
Comments: This query is an example of a query in two different elements.
Find all books with the phrase "usability testing" in some subject.
This query finds a phrase in an element and returns different elements from the same document.
Operands: "usability testing"
Functionality: phrase query
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./metadata/subjects/subject
Return: ./metadata/title, ./metadata/author
Comments: This query queries the subject element, but does not return it. It returns two different elements.
Find all book titles which start with "improving" followed within 2 words by "usability".
This query finds an element which starts with specific words.
Operands: "improving" "usability"
Functionality: word queries, ordered distance (0 to 2 intervening words), starts-with functionality
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./metadata/title
Return: ./metadata/title
Comments: The starts-with functionality restricts the query to the first words or phrase in an element. It is especially useful in querying journal
titles (e.g., title element, because the title element does not start with "improving".
Find all books with the entire title "improve the usability of a web site through expert reviews and usability testing", allowing any form of the word "improve".
This query finds the phrase when it is the entire content of an element.
Operands: "improve the usability of a web site through expert reviews and usability testing"
Functionality: phrase query, character wildcard (suffix) (0 or more), entire element content functionality
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./metadata/title
Return: ./metadata/title
Comments: This query insists that the element contains the entire phrase being queried, no more and no less. It allows full-text variations, such as case, diacritics, and wildcards.
These use cases by default query across XML element boundaries.
Boundaries include XML tags: Start-Tags, End-Tags, and Empty-Element Tags. Descendant XML tags and attribute values are removed from the string to be queried by tokenization before the query. At the XQuery Data Model level tags are a syntactic element.
Find queries in an element which do not query some or all of its descendant elements in Section 14 (IGNORE).
Find queries on attribute values in Section 4 (OTHER).
Find all book chapters containing the phrase "one of the best known lists of heuristics is Ten Usability Heuristics".
This query crosses element boundaries.
Operands: "one of the best known lists of heuristics is Ten Usability Heuristics"
Functionality: phrase query
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./content/part/chapter
Return: .
Comments: Querying across element boundaries is similar to an XQuery and XPath character string function converting the sub-tree
under an element into a string by removing all markup. The citation element tags, including element names, attribute names, and attribute values, have been removed by tokenization.
Find all part introductions containing the word "prototypes".
This query crosses element boundaries.
Operands: "prototypes"
Functionality: word query
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./content/part/introduction
Return: .
Comments: Querying across element boundaries is similar to an XQuery and XPath character string function converting the sub-tree
under an element into a string by removing all markup. The bold element tags have been removed by tokenization.
Find all book text with the word "tests".
This query finds a word in an element and its descendants.
Operands: "tests"
Functionality: word query
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./content
Return: .
Comments: Querying across element boundaries is similar to an XQuery and XPath character string function converting the sub-tree
under an element into a string by removing all markup. Element tags, including element names, attribute names, and attribute values, have been removed by tokenization, including part,
chapter, title, p, component, subComponent, subsubComponent, and componentTitle tags.
Find all book text with the phrase "usability testing once the problems".
This query finds a phrase which begins in one element and ends in a sibling.
Operands: "usability testing once the problems"
Functionality: phrase query
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./content
Return: .
Comments: Querying across element boundaries is similar to an XQuery and XPath character string function converting the sub-tree
under an element into a string by removing all markup. Element tags, including element names, attribute names, and attribute values, have been removed by tokenization, including title and p tags.
Find all books with word "identify" in book introductions or part introductions.
This query finds a word in an element in different sub-trees.
Operands: "identify"
Functionality: word query, character wildcard (suffix) (0 or more)
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./content/introduction, ./content/part/introduction
Return: .
Comments: This query looks for a word in multiple instances of the introduction element which appear as children
of the content or part elements.
Find all books if any one contains the word "mouse".
This query finds a word in a document (anywhere in the document), crossing all element boundaries.
Operands: "mouse"
Functionality: word query
Data context: doc("http://bstore1.example.com/full-text.xml")/books
Query context: .
Return: .
Comments: This query queries the root element and all its descendants. Querying across element boundaries is similar to an XQuery and XPath character string function converting the sub-tree under an element into a string by removing all markup. Element tags, including element names, attribute names, and attribute values, have been removed by tokenization. This query looks for a word inside an entire document and returns the entire document if the word exists. It does not employ wildcards, stemming, or thesaurus support. It is similar to search engine queries that search a collection of documents and return a subset of the searched collection.
Unlike all the other use cases in this document which query element content implicitly, these use cases query XML attribute values. Attribute values are not queried implicitly; they are queried explicitly.
Find all books with "improve" "web" "usability" in the short title.
This query finds multiple words in an attribute allowing word variants and allowing the words in any order with up to a specified number of intervening words.
Operands: "improve" "web" "usability"
Functionality: word queries, stemming, unordered distance (0 to 2 intervening words)
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./metadata/title/@shortTitle
Return: ./metadata/title
Comments: This query illustrates full-text querying in an attribute.
Find all books with the phrase "manuscript guides" in the short title and the phrase "user profiling" in a component title.
This query finds a phrase in an attribute and a phrase in an element.
Operands: "manuscript guides" "user profiling"
Functionality: phrase queries, stemming, and query
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./metadata/title/@shortTitle, ./componentTitle
Return: ./metadata/title/@shortTitle/text()
Comments: This query combines querying in an element with querying in an attribute.
These use cases illustrate queries which use wildcards to append or insert a character or sequence of characters to a word or a part of a word. Character wildcards may be prefix (appended before the first character), infix (inserted into a word), or suffix (appended after the last character).
Find all books with the word "test" with a one character suffix in the text.
This query finds a word with a one character suffix (one character after the last character).
Operands: "test"
Functionality: word query, character wildcard (suffix) (1)
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./content
Return: .
Comments: This query finds "tests", but not "pretest, "tested", "testers", "testimony", and "testing" which also appear in the sample data. There is no "test" in the sample data, but if there was, this query would not have found it.
Find all books with the word "way" with no prefix or a one character prefix in the text.
This query finds a word with no prefix or a one character prefix (zero or one character before the first character).
Operands: "way"
Functionality: word query, character wildcard (prefix) (0 or 1)
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./content
Return: .
Comments: There is no "way" in the sample data but if there was, this query would have found it.
Find all books with the words "serve" or "service" in the text.
This query finds words with no infix character or any number of infix characters (zero or more characters inserted in the middle of a word).
Operands: "serv", "e"
Functionality: word query, character wildcard (infix) (0 or more)
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./content
Return: concat(./@number, ", ", ./metadata/title)
Comments: This query finds the word "service" and would find the word "serve" if it existed in the sample data. It does not find the word "served" which exists in the sample data.
Find all books with the phrases "usability testing" or "user testing" in the text.
This query finds a phrase allowing a suffix of one or more characters (one or more characters after the last character) on a part of one of the words.
Operands: "us testing"
Functionality: phrase query, character wildcard (suffix) (1 or more)
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./content
Return: concat(./@number, ", ", ./metadata/title)
Comments: This is a suffix query on a part of a word "us" which is not one of the words or one of the roots of the words desired in the results. The query on "us" will find "usability" and "user". Where stemmed queries (Section 6 (STEMMING)) attempt to find linguistic variants of a word or the root of a word, wildcards may be applied to any part of a word and will find all character combinations found.
Find all books with the word "test" with a three to four character suffix in the text.
This query finds a word with a number of characters within a specified range in a suffix (specified range of characters after the last character).
Operands: "test"
Functionality: word query, character wildcard (suffix) (3 to 4)
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./content
Return: .
Comments: This query allows any three or four character suffix. It finds "testers" and "testing", but not "pretest" "tests" and "tested" which also appear in the sample data. There is no "test" in the sample data, but if there was, this query would not have found it.
These use cases invoke a stemming algorithm (e.g., Porter) which finds noun, verb, adjective, and adverb forms of a word or root of a word in singular and plural.
Find all books with the word "test" in the text.
This query finds a word and its variants applying a stemming algorithm.
Operands: "test"
Functionality: word query, stemming
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./content
Return: .
Comments: Unlike the wildcard queries in Section 5 (WILDCARD) which allow any suffix, this query will not return the word "testimony" which occurs in the sample data.
Find all books with the phrases "usability testing" or "users testing" in the text.
This query finds phrases applying a stemming algorithm to selected words within the phrases.
Operands: "usability testing" "users testing"
Functionality: phrase queries, stemming
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./content
Return: .
Comments: This query applies stemming to one word in a phrase. Unlike the wildcard queries in Section 5 (WILDCARD) which allow any suffix, a stemmed query on "us" will not
find "user" and "usability", because they do not share the same root. This query uses an ftor query introduced in Section 10 (LOGICAL).
These use cases illustrate queries which return synonyms or related words identified by thesauri, dictionaries, and taxonomies.
Find all introductions which quote someone.
This query finds words and phrases using a thesaurus to return synonyms.
Operands: "quote"
Functionality: word query, thesaurus support
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: .//introduction
Return: .
Comments: This query uses thesaurus support to identify synonyms for the word "quote" via preferred and used for terms: "said", "says", "stated", "states", "spoke", "speaks", "replied", "replies", "reply", "remarks", "remarked", "responded", "response", "reports", "reported", "quotes", "quoted", "according to", "commented", "discussed", "expressed", and "told". These words and phrases become additional operands.
Find all books with text on improving "web site components".
This query finds words using a thesaurus to identify narrower terms.
Operands: "web site components"
Functionality: phrase query, thesaurus support
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./content
Return: .
Comments: This query employs a thesaurus to identify web site components via narrower terms: "layout", "terminology", "graphics", "menus", and "navigation". These words become additional operands.
Are there any "letters" or "holiday cards" in John Wesley Usabilityguy's papers?
This query finds words and phrases using a thesaurus to identify broader terms.
Operands: "letters" "holiday cards"
Functionality: word query, phrase query, thesaurus support
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book[@number="3"]
Query context: ./content
Return: .
Comments: This query employs a thesaurus to identify the broader term "correspondence". It becomes an additional operand.
Find all books with words which sound like "Merrygould".
This query finds words using a dictionary of words which sound like the word queried.
Operands: "Merrygould"
Functionality: word query, sounds-like dictionary support
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: .
Return: .
Comments: This query uses sounds-like support to identify words which sound like the word "Merrygould". It finds the word "Marigold". Examples of how this query is implemented include keeping a list of similar words (akin to a thesaurus) or using a system based on phonetic similarity.
Find all books which contain words that are close in spelling to "sucessfull".
This query finds words using a dictionary of words that are spelled similarly.
Operands: "sucessfull"
Functionality: word query, similarly spelled dictionary support
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: .
Return: .
Comments: This query uses support for similarly spelled words to identify words close in spelling to "sucessfull". It finds the word "successful". Examples of how this query is implemented include keeping a list of similar words (akin to a thesaurus) or using a system based on spelling similarities.
Find out whether John Wesley Usabilityguy included research on "AIDS" and "other infectious diseases" among the charities he supported.
This query finds words using a taxonomy to identify subordinate terms.
Operands: "AIDS"
Functionality: word query, case sensitivity (limited to upper case), taxonomy support
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book[@number="3"]
Query context: ./content/part/component
Return: .
Comments: This query uses a taxonomy to identify other infectious diseases: "Hepatitis" and "Tuberculosis". These words become additional operands.
These use cases query a phrase, one word of which has been identified as a stop word via a stop word list. The first treats the stop word as a stop word. The second does not, making it available again for querying. Another query calls a stop word list then excludes a word on the list making that word available for querying.
Words identified as stop words may be routinely eliminated from queries, allowing any word to be substituted.
Find all books with the phrase "planning then conducting" in the text where "then" is treated as a stop word.
This query finds a phrase substituting any word for a word which has been identified as a stop word via a stop word list.
Operands: "planning then conducting"
Functionality: stop word (then), phrase query
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./content
Return: .
Comments: Once the stop word "then" has been identified via the stop word list at http://bstore1.example.com/StopWordList.xml, this query is reduced to a query on the phrase "planning" any word "conducting", allowing any word as a substitute for the stop word. It finds both "planning and conducting" and "planning then conducting" in the sample data.
Find all books with the phrase "planning then conducting" in the text where "then" is not treated as a stop word.
This query does not eliminate a word from the query even though it has been identified as a stop word in the stop word list, making it available again for querying.
Operands: "planning then conducting"
Functionality: stop word (then), phrase query
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./content
Return: .
Comments: Even though the word "then" has been identified as a stop word, this query makes it available again for querying. It finds only "planning then conducting" in the sample data.
Find books with the phrase "not been approved" in the text.
This query finds a phrase substituting any words for words which have been identified as stop words via a stop word list, removing the word "not" temporarily from the stop word list.
Operands: "not been approved"
Functionality: phrase query, stop word list (not, been), the stop word "not" is excluded from the list and used in the query
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./content
Return: ./metadata/title, ./content
Comments: The stop words "not" and "been" are identified via a stop word list, however the stop word "not" is removed temporarily from the stop word list and used as an operand in the query. The query becomes a query on the phrase "not" [any word] "approved", allowing any word as a substitute for the stop word "been". It does not return books with the word "approved" in the phrases "been approved" and "approved travel orders" in the sample data.
These use cases illustrate queries on words entered with diacritics sometimes finding the same; other times finding words with and without diacritics. They query words entered in upper case sometimes finding the same; other times finding words in both upper and lower case.
Verify the existence of a "résumé" in the papers of John Wesley Usabilityguy.
This query finds a word only if it contains the diacritics as written in the query.
Operands: "résumé"
Functionality: word query, functionality requiring presence of diacritics as written in the query, character wildcard (suffix) (1)
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./content
Return: .
Comments: The desired results include only the words "résumé" and "résumés" with diacritics as written in the query, not the more often used words "resume" (which is present in the sample data) and "resumes".
Verify the existence of a résumé in the papers of John Wesley Usabilityguy.
This query finds a word whether diacritics are present or not.
Operands: "resume"
Functionality: word query, functionality finding words with and without diacritics, character wildcard (suffix) (1)
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./content
Return: .
Comments: The desired results include either the words "résumé" or "résumés" with diacritics or the words "resume" or "resumes" without diacritics. Whether diacritics are written in the query or not is not considered.
Find out whether John Wesley Usabilityguy included research on "AIDS" among the charities he supported.
This query finds a word in upper case characters.
Operands: "AIDS"
Functionality: case sensitivity (limited to upper case), word query
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: .
Return: .
Comments: This query does not return the word "aids" with lower case characters which exists in the sample data.
Find out whether John Wesley Usabilityguy included research on "AIDS" among the charities he supported.
This query finds a word with upper or lower case characters.
Operands: "AIDS"
Functionality: word query, case insensitivity
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: .
Return: .
Comments: This query finds the word "aids" with characters in upper or lower case.
These use cases include queries containing logical expressions: or, and, the unary not,
and not, and mild not.
Find all books with the words "web" or "software" in the text.
This query finds any or all of the words.
Operands: "web" "software"
Functionality: word query, or query
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./content
Return: .
Comment: The or query finds any or all of words queried.
Find all books with the words "web" "software" in the text.
This query finds all of the words.
Operands: "web" "software"
Functionality: word queries, and query
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./content
Return: .
Comments: The and query finds all the words.
Find all book text containing the words "goal" "obstacles" "task" in this order.
This query finds multiple words in the order queried.
Operands: "goal" "obstacles" "task"
Functionality: ordered word query
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./content
Return: .
Comments: This query finds multiple words in a specified order. It is more permissive than a phrase query. It is comparable to an ordered distance query where the number of intervening words is zero or more.
Find all books which do not belong in a collection on "usability testing".
This query finds books which do not contain a phrase in an element and its descendants.
Operands: "usability testing"
Functionality: phrase query, character wildcard (suffix) (0 or more), unary not query
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: .
Return: .
Comments: Unlike the and not query below, the unary not query
requires only one operand. This query has value for information architects and data managers
who will use it for checks such as this one: to find nonconforming data in a document or a
collection.
Find all books with the word "usability" and not the word "plan" in the metadata.
This query finds a word only when another is not found in an element or its descendants.
Operands: "usability" "plan"
Functionality: word query, and not query
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./metadata
Return: .
Comments: The and not query is also called a but, but not, without
query. Unlike the unary not query above,this query requires two operands. Book 2
which contains the words "usability" and "plan" in the metadata is not returned.
Find all books with listings for "résumés", "drafts", or "correspondence", and not "book drafts" in the text.
This query finds books with multiple words and not a phrase containing one of those words.
Operands: "résumés" "drafts" "correspondence" "book drafts"
Functionality: word queries, or query, phrase query, and not query,
with diacritics as written in the query
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./content
Return: .
Comments: This query will not return a result the user wants because that result also includes what the user does not want, "book drafts".
Find all books with listings for "résumés", "drafts", or "correspondence", and not "book drafts", in the metadata or text.
This query finds books with multiple words and not a phrase which contains one of the words, while not eliminating a result if it contains the phrase as well as one of the words searched.
Operands: "résumés" "drafts" "correspondence" "book drafts"
Functionality: word queries, or query, phrase query, mild not query,
with diacritics as written in the query
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./content
Return: .
Comments: This query will return a result the user wants even though it contains the phrase the user deprecated via the mild not, "book drafts". The user will not lose results which contain what he wants when that book also contains what he does not want. Books containing instances of "book drafts" (a subset of "drafts") are not automatically excluded. Instead the "book drafts" instances are not considered when determing whether or not to include books in the result set.
These use cases illustrate instance queries and occurrence count queries. They query words within the same, any, and every instance of an element. Another query finds a phrase only if it occurs over a specified number of times in a book.
Find all books with the phrase "web site" and the word "usability" in the same subject.
This query finds a word and a phrase in the same instance of an element.
Operands: "web site" "usability"
Functionality: phrase query, word query, and query
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./metadata/subjects/subject
Return: .
Comments: This query finds a word and a phrase in an instance of an element, not allowing one
of the operands to be found in an instance of the element and the other operand in a different instance of
the element. This query does not find Book 2 which has "usability" and "web site" in different instances of the subject element.
Find all books with the phrase "web site" and the word "usability" in any subject.
This query finds a word and a phrase in any instance of an element across the siblings of the same element. The word and the phrase may be in different elements.
Operands: "web site" "usability"
Functionality: phrase query, word query, and query, existential quantification
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./metadata/subjects/subject
Return: .
Comments: This query finds words and phrases in any instance of an element, allowing one of the operands to be found in one sibling and the other operand in a different sibling of the same element name.
Find all books with the words "ersatz" and "publications" in every publisher name.
This query finds two words in every instance of an element.
Operands: "ersatz" "publications"
Functionality: word query, and query, universal quantification
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./metadata/publicationInfo/publisher
Return: .
Comments: This query does not return a book if at least one of its publishers does not contain the words "ersatz" and
"publications". Book 1 is returned because it has an instance of the publisher element which satisfies the full-text conditions (contains both "Ersatz" and
"Publications"). Book 2 is not returned because even though it has a publisher that satisfies the full-text conditions, it also has a publisher that
does not satisfy it. Book 3 is not returned because it has an instance of the publisher element which
does not satisfy the query (contains "Ersatz" but not "Publications").
Find all books which repeat the phrase "expert review methods" in the text at least two times.
This query finds a phrase which is repeated a specified number of times.
Operands: "expert review methods"
Functionality: phrase query, at least functionality
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./content
Return: .
Comments: This query excludes books with only minor (single occurrence) references to "expert review methods".
These use cases illustrate unordered and ordered distance queries which find sequences of words allowing up to a specified number of intervening words. They also include a query to find words within a window, within a sentence, and within a paragraph.
Find all books with information on "software developers".
This query finds multiple words in any order allowing up to a specified number of intervening words.
Operands: "software" "developer"
Functionality: word queries, stemming, unordered distance (0 to 3 intervening words)
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./content
Return: .
Comments: This query finds "developer of software", which occurs in the sample data.
Find all books with information on "efficient task completion".
This query finds multiple words in the order queried allowing up to a specified number of intervening words.
Operands: "efficient" "task" "completion"
Functionality: word queries, ordered distance (0 to 10 intervening words)
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./content
Return: .
Comments: This query is more permissive than an phrase query on "efficient task completion" which would return no results.
Find all books about "users feeling well-served".
This query finds books with multiple words within an ordered window of up to a specified number of words.
Operands: "users" "feeling" "well served" "well-served"
Functionality: word queries, ordered window (0 to 15 words)
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./content
Return: .
Comments: This query opens a window on the first found word (which because of the ordered operator must be the first word queried) and counts a specified number
of words from that first word within which it may find the remaining word or words, finding them
in the order queried.
Find all books which discuss "questions asked during cognitive walk-throughs".
This query finds books with multiple words in any order within a sentence.
Operands: "users" "would" "know" "step"
Functionality: word queries, stemming, unordered sentence query
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./content
Return: .
Comments: This query expects an implementation-defined tokenized sentence or a sentence element.
Find all paragraphs which define what "Web site usability" is.
This query finds books with multiple words and phrases in any order within a paragraph.
Operands: "usability" "web site" "efficiency" "satisfaction"
Functionality: word queries, phrase query, unordered paragraph query
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./content
Return: .
Comments: This query expects an implementation-defined tokenized paragraph or a paragraph element. Depending on the implementation, this query might return no result instead of the Expected Result presented.
These use cases illustrate queries traversing relative XPath axes.
Find all books with paragraphs containing the phrase "computer workstation" and footnotes within those paragraphs containing the word "comfortable".
This query finds a phrase in an element, then finds a word in a child element.
Operands: "computer workstation" "comfortable"
Functionality: phrase query, word query
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: .//p, .//p/footnote
Return: ./metadata/title, .//p
Comments: This query combines phrase and word search in different elements which have a parent-child relationship.
Find the first two steps in chapters on "conducting usability tests."
This query finds words in an element, then returns its first two children elements.
Operands: "usability", "test"
Functionality: word queries, stemming
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./content/part/chapter/p
Return: ./metadata/title ./content/part/chapter/p/step[1], ./content/part/chapter/p/step[2]
Comments: This query finds words in a p element and uses XPath to return the first two children
of the element.
Are there any "flow diagrams" of "human computer interaction" scenarios in John Wesley Usabilityguy's papers?
This query finds a phrase in an element, then finds another phrase in an ancestor element.
Operands: "flow diagrams" "human computer interaction"
Functionality: phrase queries, character wildcard (suffix) (0 or one)
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book[@number="3"]
Query context: ./content/part/component/(subComponent|subComponent/subsubComponent)/componentTitle
Return: ./metadata/title, ./content
Comments: This query looks for a phrase in an element and a different phrase in its ancestor elements.
Find all book chapters with paragraphs on "usability testing" followed by paragraphs on "information architecture".
This query finds a phrase in an element, then finds another phrase in one of its right siblings.
Operands: "usability testing" "information architecture"
Functionality: phrase queries
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./content/part/chapter/p
Return: ./metadata/title, ./content
Comments: This query returns book chapters if they contain paragraphs following each other as specified in the query.
These phrase and proximity queries cross element boundaries ignoring the content of descendant elements. One query ignores the content of a complete sub-tree. Other queries ignore only the content of specified descendant elements. The last query performs a level-by-level ignore. It ignores the content of descendant elements when querying the content of the parent element. Its descendant elements are promoted and then their content is queried.
Find advice on whether the observer should "correct" or provide "guidance" to the user during usability "testing".
This query ignores the content of all descendant elements.
Operands: "testing" "correct" "guidance"
Functionality: phrase query, word queries, or query, ordered distance query (0 to 60 intervening words), ignore content of descendant elements
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: .//p
Return: .
Comments: This query ignores the content of all the descendant elements of the p element, so it ignores the footnote and testingProcedure elements. If the descendant elements were not ignored, the words searched would be too distant from each other to have been returned.
Find all book chapters containing "users can be tested at any computer workstation or in a lab" ignoring footnotes.
This query finds book chapters containing the phrase "users can be tested at any computer workstation or in a lab" ignoring the content of a descendant element explicitly specified by an XPath expression.
Operands: "users can be tested at any computer workstation or in a lab"
Functionality: phrase query, ignore content of footnote element
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./content/part/chapter
Return: ./metadata/title, ./content/part/chapter
Comments: This query ignores the content of a descendant element, the footnote element.
Find all book chapters containing the phrase "at any computer workstation or in a lab" ignoring footnotes on workstations.
This query ignores the content of a descendant element specified by a full-text query.
Operands: "at any computer workstation or in a lab", "workstations"
Functionality: phrase query, character wildcard (suffix) (1), ignore content of a descendant element found by a full-text query
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./content/part/chapter
Return: ./metadata/title, ./content/part/chapter
Comments: This query ignores the content of a descendant element identified dynamically by a full-text query.
Find all books with the word "workstation" near the word "lab".
This query performs a level-by-level ignore. It ignores the content of descendant elements when querying the content of the parent element. Its descendant elements are promoted and then their content is queried. It differs from the ignore queries above because it queries the content of parent elements skipping over the descendant elements, then instead of stopping there it queries the content of descendent elements in isolation.
Operands: "workstation" "lab"
Functionality: word queries, unordered distance (0 to 6 intervening words), level by level ignore (ignore the content of descendant element when searching the parent element and promote the descendant element and query it in isolation)
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./content/part/chapter/p, /content/part/chapter/p/footnote
Return: ./metadata/title, .//chapter/(p|p/footnote)
Comments: This query ignores the content of the descendant element footnote when querying its parent element p returning "workstation" and "lab" from "Users can be tested at any computer workstation or in a lab". Then the descendant element footnote is promoted and queried separately returning "workstation" and "lab" from "They may be more comfortable at their own workstation than in a lab". This query is written using the standard ignore syntax ORing together parent and descendant elements to be queried separately.
The use cases illustrate a multi-lingual query and queries which use multiple full-text functionalities in conjunction with other XQuery and XPath functionalities.
Find all books with the subject "网站可用性", with an introduction written by "Elina Rose", which mention the name of the usability expert "Millicent Marigold".
This query finds words and a phrase in more than one language.
Operands: "网站可用性" "Elina" "Rose" "Millicent" "Marigold"
Functionality: phrase query, word queries, and query, unordered distance (0 to 3 intervening words), capacity to enter, query, and return multiple languages
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./metadata/subjects/subject, ./content/introduction/author, ./content
Return: ./@number, ./metadata/title, ./metadata/subjects/subject, ./content/introduction/author, ./content
Comments: This query accepts multiple languages as input and returns multiple languages as output.
Find all paragraphs in books which discuss the role of "task performing" in "expert reviewer" methods.
This query finds multiple words close to each other and a phrase in one instance of an element.
Operands: "task" "performing" "expert reviewer"
Functionality: word queries, stemming, phrase query, unordered distance (0 to 3 intervening words between "task" and "performing")
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./content//p
Return: ./metadata/title, ./content
Comments: This query combines functionalities introduced in previous sections.
Find all books on "usability testing" which "quote" "Millicent Marigold" on the value of "iterating" multiple times.
This query finds multiple words in three nested levels of distance queries. It uses wildcards, stemming, and thesaurus support.
Operands: "usability testing" "quote" "millicent" "marigold" "iterating"
Functionality: phrase query, character wildcard (suffix) (0-5), word queries, thesaurus support, stemming, ordered distance (0 to 3 intervening words between "millicent" and "marigold"), unordered distance (0 to 3 intervening words between ("millicent ... marigold" and (one of the following from stemming: "quote", "quoted", "quotes", "quotation", "quotations" or one of the following from thesaurus support: "said", "says", "stated", "states", "statement", "spoke", "speaks", "replied", "replies", "reply", "remarks", "remarked", "responded", "response", "reports ", "reported", "quotes", "quoted", "according", "commented", "discussed", "expressed", "told"), unordered distance (0 to 50 intervening words between ("millicent ... marigold" ... ("quote" or any of its wildcard- or thesaurus-derived substitutes) and ("usability testing" and "iterating")).
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./content
Return: .
Comments: This query combines functionalities introduced in previous sections. This query will return the result shown or no results depending on whether the wildcard or thesaurus match option was processed first. The processing order of these two match options is implementation-defined.
Find advice on whether an observer in a "usability test" should "correct" or provide "guidance" to the user in a book not authored by Montana Marigold.
This query uses synonyms supplied by the user, uses the unary not, nests a Boolean query and a phrase query within a window query, and ignores the tags and content of a descendant element.
Operands: "usability testing" "correct" "comment" "guidance" "help" "assistance" "montana" "marigold"
Functionality: phrase query, word queries, character wildcard (suffix) (0 or more), synonyms for "correct" and "guidance" provided by the user ("comment" or "assistance" or "help"), stemming, or query ("correct" or "comment" or "guidance" or "assistance" or "help"), and query ("montana" and "marigold"), unary not query (not "montana" and "marigold"),
unordered window (0 to 70 words within a window of "usability testing" and ("correct" or "comment" or "guidance" or "assistance" or "help"). Ignores content of descendant elements.
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./metadata/author, ./content
Return: ./@number, ./metadata/title, ./content
Comments: This query combines functionalities introduced in previous sections.
For each book with a title containing the word "usability", a book introduction containing the word "satisfaction", and a part introduction containing the phrase "identify problems", return the book title and the authors if it has authors. Return the book title and publisher, if it has no authors.
This query finds words and a phrase in different elements in different sub-trees. It also contains a conditional return.
Operands: "usability" "satisfaction" "identify problems"
Functionality: word queries, phrase query, conditional query
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./metadata/title, ./content/introduction, ./content/part/introduction
Return: ./@number, ./metadata/title, ./metadata/author, ./metadata/publicationInfo/publisher, ./content/introduction, ./content/part/introduction
Comments: This query combines functionalities introduced in previous sections.
These queries combine full-text queries with other XQuery and XPath functionalities.
For books with "usability" in the title create a flat list of all title-author pairs, with each pair enclosed in a newly constructed element.
This query finds a word in an element and returns the element and another wrapped in a new element.
Operands: "usability"
Functionality: word query, construction of new element
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./metadata/title
Return: result (constructed element), ./metadata/title, ./metadata/author
Comments: This query finds the word "usability" in the title of a book and building title-author pairs for those books returning them wrapped in a newly constructed result element.
Find all books with a chapter title on "usability tests". Return book title, chapter title, and the number of steps in chapters.
This query finds words then returns among other elements a constructed element reporting the number of occurrences of a descendant element.
Operands: "usability" "test"
Functionality: word queries, and query, stemming, count, construction of new element, conditional expression
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./content/part/chapter/title, ./content/part/chapter/p/step
Return: ./@number, ./metadata/title, ./content/part/chapter/title, number-of-steps (constructed element)
Comments: This query finds the word "usability" and stemmed forms of the word "test" in the titles of
book chapters. It returns chapter titles along with an occurrence count of descendant step elements. The query returns a number of steps equal to
0 if the chapter is on usability testing but does not specify any steps (e.g., there are not descendant step elements).
For each book with "usability" in the book title, return the book title and a second element. Return the book title and a third element if the second element does not exist.
This query finds a word and contains a conditional return.
Operands: "usability"
Functionality: word query, count, conditional expression
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./metadata/title
Return: ./@number, ./metadata/title, ./metadata/author, ./metadata/publicationInfo/publisher
Comments: This query finds the word "usability" in the title of a book, then returns title-author pairs
for those books when there are author elements. If there are no author elements, it returns publisher elements.
For each book with "usability" in the book title, return its book title and the round number of its suggested price if the price exceeds $25.
This query finds a word and contains a conditional return based on a function on a numeric value.
Operands: "usability"
Functionality: word query, round(), numeric value comparison, conditional expression
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./metadata/title, ./metadata/price
Return: ./@number, ./metadata/title, ./metadata/price
Comments: This query finds the word "usability" in the title of a book, then returns the round number of its price if the price exceeds a specified value.
Find all introductions in books, published in "Washington, D.C.", which include listings for "résumés", "drafts", and "correspondence".
This query finds words and a character string.
Operands: "résumés" "drafts" "correspondence" character string "Washington, D.C."
Functionality: word query, with diacritics as written in the query, and query, character string query
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./content/introduction, ./metadata/publicationInfo/place
Return: ./@number, ./metadata/title, ./content//introduction
Comments: This query performs a full-text query when it needs to find word variants in full text and performs a character string query when word variants are not possible.
For each book on "usability" return the book title and a new has-publishers element with value true if the book has more than 1 publisher. Return the title and a new has-publishers element with value false if the book does not have more than one publisher.
This query finds a word, then returns Boolean values based on the number of occurrences of an element.
Operands: "usability"
Functionality: word query, construction of new Boolean values, construction of new element, count, >, conditional expression
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./metadata/title
Return: ./@number, ./metadata/title, has-publishers (constructed element)
Comments: This query finds "usability" in the title of a book, then returns the title and Boolean values showing whether the book has more than one publisher or not.
Find all books about conducting "usability tests" which have more than one author and are published after "2000".
This query finds a phrase, counts the number of occurrences of an element, runs a greater than comparison on dates, and combines the results.
Operands: "usability testing", "2000"
Functionality: phrase query, character wildcard (suffix) (0 or more), count, >
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./metadata/subjects/subject, ./metadata/author, ./metadata/publicationInfo/(dateIssued|dateRevised)
Return: ./@number, ./metadata/title, ./metadata/author, ./metadata/subjects/subject
Comments: This is a full-text query on the phrase "usability testing" using a wildcard on the word "test", restricted to the subject element. The query
counts the number of author elements, and runs a greater than comparison on dates.
Find all books published after "2001" which share a subject with the book with the short title "Usability Basics".
This query finds words using an XPath expression to identify the words queried and looks for a publication date after the one specified.
Operands: "Usability Basics", "2001"
Functionality: phrase query, and query, date comparisons, XPath expression to identify the words queried.
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./metadata/title/@shortTitle, ./metadata/subjects/subject, ./metadata/publicationInfo/dateIssued|dateRevised
Return: ./@number, ./metadata/title, ./metadata/author
Comments: This query returns a book if its last date of publication is after 2001 and one of its subjects is the same as a subject of the book with the short title "Usability Basics". This query uses an XPath expression to dynamically find the subjects of books.
Find all books which discuss "successfully completing tasks".
This query finds words within a window, allowing more words within the window depending on the number of chapters in the book.
Operands: "successfully" "completing" "tasks"
Functionality: word query, stemming, unordered window of at most (number of chapters in the book times 3) words
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./content
Return: ./metadata/title, ./content
Comments: This query uses an XQuery expression to determine the number of words in an unordered window. It allows more words in the window when there are more chapters in the book. The query returns "tasks which are critical for users to be able to complete successfully" from Book 2, because there are three chapters in Book 2 which multiplied by four allows up to twelve words within the window.
All the queries in these Use Cases may be written with or without score. The Use Cases in this section are merely a small subset that focuses on score.
These queries exploit score and can not be written as queries with pure Boolean full-text predicates. Among these queries are a query that computes and returns only scores, a query which returns only results over a specified threshold, a query which filters by score, a query which returns all the documents ordered, and a query which uses weighting to impact scoring and sorting.
Scoring methodologies are not defined in this recommendation. Scoring is implementation-defined.
Find all books which mention "usability" in the title or the text. Return book titles and scores.
This query performs a word query and returns scores, highest scores first.
Operands: "usability"
Functionality: word query, implementation-defined scoring, returns score, construction of new element
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./metadata/title, ./content
Return: ./@number, ./metadata/title, score (constructed element)
Comments: This query is only possible as a scored query. Scores are included between 0 and 1. The scoring methodology in this use case is for illustrative purposes only. Scoring methodologies will be implementation-defined. This query returns the same results as a query with a pure Boolean full-text predicate. The difference is that the results are scored and the results are returned displaying the score and ranked by score.
Find the best two books on "usability".
This query performs a word query and returns only the results with the two top scores.
Operands: "usability"
Functionality: word query, implementation-defined scoring, returns books with the top two scores, conditional expression
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: .
Return: ./@number, ./metadata/title
Comments: This query returns results only for the two books with the highest scores. This query is only possible as a scored query. The scoring methodology in this use case is for illustrative purposes only. Scoring methodologies will be implementation-defined. This query returns the same results as a query with a pure Boolean full-text predicate. The difference is that the results are scored and through the introduction of a third variable only the two results with the highest scores are returned.
Find all books that focus on "usability".
This query performs a word query and filters on scores.
Operands: "usability"
Functionality: word query, implementation-defined scoring, filters on scores (accepts only those with score over 0.1)
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: .
Return: ./@number, ./metadata/title
Comments: This query is only possible as a scored query. The scoring methodology in this use case is for illustrative purposes only. Scoring methodologies will be implementation-defined. This query returns the same results as a query with a pure Boolean full-text predicate. The difference is that the results are scored and then filtered on the scores.
Find all books with parts about "usability testing".
This query finds books which contain parts about usability testing, returning entire books, but without part elements identified as irrelevant via score.
Operands: "usability testing"
Functionality: phrase query, character wildcard (suffix) (0 or more), implementation-defined scoring, filters on scores (under .05), conditional return
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: .//part
Return: . without irrelevant .//part
Comments: This query is only meaningful as a scored query. The scoring methodology in this use case is for illustrative purposes only. Scoring methodologies will be implementation-defined. This query returns the same results as a query with a pure Boolean full-text predicate. The difference is that this query filters the part elements. They are included or excluded from the results depending on their score.
Return all books, listing books with text on "software" first.
This query performs a word query, returns all the documents in the database, and orders them returning those with found word first, those without last.
Operands: "software"
Functionality: word query, implementation-defined scoring
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: .
Return: .
Comments: This query is only meaningful as a scored query. The scoring methodology in this use case is for illustrative purposes only. Scoring methodologies will be implementation-defined. This query returns the more results than a parallel query with a pure Boolean full-text predicate. In a parallel query with a pure Boolean full-text predicate, the last result would have a Boolean value of false and would not be returned. In this scored query the last result receives a score and is returned.
Finds books which discuss "conducting usability tests" returning those which mention "measuring success" first.
This query finds words using weighting on optional words to impact the scoring and sorting.
Operands: "conduct" "usability" "tests" "measuring" "success"
Functionality: word queries, stemming, unordered distance (0 to 10 intervening words between "conduct" and "usability" and between "usability" and "tests"), unordered distance (0 to 4 intervening words between "measuring" and "success"), weight declaration
Data context: doc("http://bstore1.example.com/full-text.xml")/books/book
Query context: ./content
Return: ./metadata/title, ./content
Comments: This query returns books on "conducting usability tests", using a weight declaration to return books with mentions of "measuring success" higher in the sort.
The editors thank the members of the Full Text Task Force of the XML Query and XSL Working Groups, which produced the material in this document. Special thanks to Stephen Buxton for contributing the first version of the schema.
The editors thank the following staff at the Library of Congress for providing and improving sample data and queries: Ardith Bausenbach, Caroline Arms, Marla Banks, Susan David, Ray Denenberg, Louis Drummond, Bohdan Kantor, Mary A. Lacy, Joe Pagano, Betsy Reifsnyder, Belinda D. Urquiza, and Anne Washington.
Thanks also to Bohdan Kantor, Foster Zhang, François Yergeau, and Michel Biezunski for assistance in translating the subjects in the sample data into Chinese and French.
The editors also wish to thank the members of the W3C Internationalization Working Group for their assistance.
The following references are some of the works considered by the Working Groups in deriving its use cases.
| Pat Case | 2008-07-10 | Corrected 2.2.7 Q7 Entire Element Content Query | Added "with wildcards" to the XQuery and XPath solutions. |
| Pat Case | 2008-07-10 | Corrected 4.2.1 Q1 Query on Attribute | Moved "with stemming" to after "improve" and added parentheses around ("improve" with stemming ftand "web" ftand "usability") to make the distance operator applicable to all 3 operands in the XQuery and XPath solutions. |
| Pat Case | 2008-07-10 | Corrected 5.2.1 Q1 One Character Suffix Wildcard Query | Capitalized the "S" in "Solution in XQuery". |
| Pat Case | 2008-07-10 | Corrected 16.2.9 Q9 Query Using an XQuery Expression to Determine the Number of Words Allowed in a Window | Changed the 2nd "for" to "let" in the XQuery solution. |
| Pat Case | 2008-07-10 | Corrected 17.2.4 Q4 Query Combining Score and XML Structure with a Conditional Return | Added the "local" prefix to 2 filter functional calls in the XQuery solution. |
| Pat Case | 2008-07-14 | Corrected 13.2.2 Q2 Query on Element Returning Its First Two Children | Corrected the let statement to read: let $para := $book//chapter/p[. ftcontains "usability" ftand "test" with stemming] in the XQuery solution. |
| Pat Case | 2008-07-14 | Corrected 13.2.4 Q4 Query on Element and Its Right Siblings | Changed the expected results to title and chapters. |
| Pat Case | 2008-07-14 | Corrected 16.2.4 Q4 Full-Text Query with Numeric Value Comparison | Removed duplicate books/book from the for clause in the XQuery solution. |
| Pat Case | 2008-07-14 | Corrected 15.2.4 Q4 Window Query with Wildcards and Stemming Ignoring Content of a Descendant Element | Removed count($au) > 0 from and corrected window size to 0 in XQuery solution. |
| Pat Case | 2008-07-14 | Corrected 16.2.9 Q9 Query Using an XQuery Expression to Determine the Number of Words Allowed in a Window | Changed the for statement to a let statement in the XQuery solution. Also changed the ./contents/part/chapter paths in both the XQuery and XPath solutions to eliminate the incorrect contents (should be content) element. |
| Pat Case | 2008-07-16 | Corrected 11.2.2 Q2 Query in Any Instance of an Element (Existential Quantification) | Corrected use of $s1 and $s2 variables in the XQuery and XPath solutions. |
| Pat Case | 2008-07-16 | Corrected 13.2.3 Q3 Query on Element and Its Ancestors | Camel-cased element names and corrected the paths defining the variables in the XQuery and XPath solutions. Added a 2nd count clause in the XQuery solution. Corrected the Query Context. |
| Pat Case | 2008-07-16 | Corrected 16.2.7 Q7 Full-Text Query with Date Comparison and Element Occurrence Count | Added Book 3 to the expected results. Corrected the 2nd author's first name in Book 1 expected results. |
| Pat Case | 2008-07-17 | Corrected 5.2.5 Q5 Specified Range of Characters Suffix Wildcard Query | Removed a stray angle bracket from expected results. |
| Pat Case | 2008-08-5 | Corrected 5.2.3, 5.2.4, 5.2.5, and 6.2.2. | Corrected return statements and expected results in 5.2.3, 5.2.4, 5.2.5, and 6.2.2. |
| Pat Case | 2008-08-11 | Recorrected 4.2.1 Q1 Query on Attribute | Removed newly added parentheses around ("improve" with stemming ftand "web" ftand "usability"), trying to use only significant parentheses in the solutions. |
| Pat Case | 2008-08-11 | Corrected 3.2.6 Q6 Query on Entire Document | Corrected XQuery and XPath solutions to return all the book elements if the word was found in any one of them. |
| Pat Case | 2008-08-19 | Removed count > 0 from most use cases. | Removed count > 0 from XQuery and XPath (if any) solutions for use cases where it is no longer needed. |
| Pat Case | 2008-08-19 | Corrected 5.2.3, 5.2.4, 5.2.5, and 6.2.2 again. | Removed the fn: prefix from return statements in XQuery and XPath solutions for use cases 5.2.3, 5.2.4, 5.2.5, and 6.2.2. |
| Pat Case | 2008-08-19 | Removed or moved parentheses. | Removed or moved parentheses.to reflect changes in processing order for operators and match options in XQuery and XPath (if any) solutions for use cases 4.2.1, 10.2.6, 10.2.7, 11.2.3, 12.2.3, 12.2.4, 14.2.1, 14.2.3, 15.2.2, 15.2.4, 16.2.2, 16.2.5, 16.2.7, 17.2.6 |
| Pat Case | 2008-08-19 | Simplified queries by using a union in XPath statements. | Used union in XPath statements in XQuery and XPath solutions for use cases 2.2.4, 3.2.5, and 14.2.4. |
| Pat Case | 2008-08-19 | Changed text in Comments. | Changed the word "returns" to "finds" when it was more appropriate in Comments. |
| Pat Case | 2008-08-20 | Removed / in $book//content. | In XQuery solutions replaced $book//content with the simpler and more direct $book/content. |
| Pat Case | 2008-08-20 | Removed .// when unnecessary. | In XQuery and XPath solutions, replaced /books/book[.//content ... ] with /books/book[content ... ]. |
| Pat Case | 2008-10-31 | Corrected 3.2.5 Q5 Query in Different Sub-Trees. | Removed a stray "i" in 3.2.5 Q5 Query in Different Sub-Trees. |
| Pat Case | 2008-11-05 | Corrected 9.2.1 Q1 Diacritics Sensitive Query and 9.2.2 Q2 Diacritics Insensitive Query | Added ? wildcard indicators after the period indicator in the XQuery and XPath queries. |
| Pat Case | 2008-11-10 | 5.2.3 Q3 Zero or More Character Infix Wildcard Query and 5.2.4 Q4 One or More Character Suffix Wildcard Query on Part of a Word | Added second parentheses at the end of the XQuery return statements for these queries. |
| Pat Case | 2008-11-29 | 14.2.2 Q2 Phrase Query Ignoring Content of Descendant Element Specified by XPath Expression | Removed extraneous ] from XQuery solution. |
| Pat Case | 2008-11-29 | 14.2.4 Q4 Distance Query Ignoring Content of Descendant Elements Level by Level | Added missing ) in XPath solution. |
| Pat Case | 2008-11-29 | 16.2.9 Q9 Query Using an XQuery Expression to Determine the Number of Words Allowed in a Window | Removed extraneous ) after with stemming in XPath solution. |
| Pat Case | 2008-11-29 | 12.2.5 Q5 Unordered Within a Paragraph Query | Added comment allowing no expected results. |
| Pat Case | 2008-11-29 | 13.2.1 Q1 Query on Element and Its Children | Corrected expected results to include all p elements in Book 2. |
| Pat Case | 2008-11-29 | 16.2.7 Q7 Full-Text Query with Date Comparison and Element Occurrence Count | Corrected query to return existing results. |
| Pat Case | 2008-11-29 | 15.2.2 Q2 Phrase and Distance Query in an Instance of an Element with Stemming | Added parentheses before ftand. |
| Pat Case | 2008-11-29 | 15.2.4 Q4 Window Query with Wildcards and Stemming Ignoring Content of a Descendant Element | Highlighted "comments"in expected results. |
| Pat Case | 2009-01-15 | 17.2.2 Q2 Query Returning Results with Top Scores | Corrected syntax in query return statement adding {}s. |
| Pat Case | 2009-01-15 | 13.2.4 Q4 Query on Element and Its Right Siblings | Corrected expected results to include all paragraphs. |
| Pat Case | 2009-01-15 | 17.2.2 Q2 Query Returning Results with Top Scores | Corrected sort order to ascending. |
| Pat Case | 2009-03-28 | 6.2.1 Q1 Query Stemming on Word Root | Removed highlighting on testers. |
| Pat Case | 2009-03-28 | 6.2.2 Q2 Query Stemming on Multiple Word Roots | Changed the operand usable to usability and the operand use to users. |
| Pat Case | 2009-03-28 | 15.2.2 Q2 Phrase and Distance Query in an Instance of an Element with Stemming | Changed the operand performance to performing and the operand review to reviewer. |
| Pat Case | 2009-03-28 | 15.2.3 Q3 Nested Distance Query with Wildcards, Stemming, and Thesaurus Support | Changed the operand iterations to iterating. |
| Michael Dyck | 2009-04-15 | 15.2.2 Q2 Phrase and Distance Query in an Instance of an Element with Stemming | Fix typo: missing right-bracket |
| Michael Dyck | 2009-04-15 | 15.2.3 Q3 Nested Distance Query with Wildcards, Stemming, and Thesaurus Support | Fix syntax error: missing parens. Also, malformed wildcard syntax. |
| Michael Dyck | 2009-04-15 | 16.2.7 Q7 Full-Text Query with Date Comparison and Element Occurrence Count | Fix syntax error: malformed WhereClause. |
| Pat Case | 2009-04-16 | 15.2.5 Q5 Query on Different Elements in Different Sub-Trees with Conditional Return | Corrected the return statement. |
| Pat Case | 2009-04-16 | 16.2.9 Q9 Query Using an XQuery Expression to Determine the Number of Words Allowed in a Window | Corrected query to return the desired result. Updated the Comments to address the revised query. |
| Pat Case | 2009-05-20 | 17.2.6 Q6 Query with Weight Declaration | Moved a closing paren from after to before the weight expression. Added 2nd set of parens. |
| Pat Case | 2009-06-09 | 15.2.3 Q3 Nested Distance Query with Wildcards, Stemming, and Thesaurus Support | Inserted comment noting that results depended on whether the wildcard or thesaurus match option was processed first. |
| Pat Case | 2009-09-11 | Changed syntax for Match Options | Changed "language" to "using language", changed "with wildcards" to "using wildcards", changed "with thesaurus at" to "using thesaurus at", changed "with stemming" to "using stemming", changed "with stop words" to "using stop words", changed "without stop words" to "using no stop words", changed "case insensitive" to "using case insensitive", changed "uppercase" to "using uppercase", changed "diacritics sensitive" to "using diacritics sensitive", changed "diacritics insensitive" to "using diacritics insensitive". |
| Pat Case | 2009-09-22 | Changed ftcontains to contains text | Changed ftcontains to contains text throughout the document. |
| Pat Case | 2009-10-13 | 9.2.4 Q4 Query on Word with Upper Case and Lower Case Characters | Changed "case insensitive" to "using case insensitive" in the XPath query. |
| Pat Case | 2009-10-13 | 14.2.3 Q3 Phrase Query Ignoring Content of Descendant Element Specified by Full-Text Query | Corrected the XQuery query to match the test suite. |
| Pat Case | 2009-11-10 | Introduction Item 3 | Corrected the the spelling of wildcard. |
| Pat Case | 2009-11-22 | 17.2.6 Query with weight declaration | Added curly braces around the weight. |
| Pat Case | 12-09-2009 | 14.2.3 Q3 Phrase Query Ignoring Content of Descendant Element Specified by Full-Text Query | Changed the path in the for clause in the XQuery and XPath solutions to provide context for the ignore paths. |
| Pat Case | 01-12-2010 | 14.2.1 Q1 Distance Query Ignoring Content of All Descendant Elements | Added a predicate to the let clause and got rid of unused variable in the XQuery solution. |
| Pat Case | 01-12-2010 | 14.2.4 Q4 Distance Query Ignoring Content of Descendant Elements Level by Level | Replaced the XQuery solution and added /. to the XPath solution. |
| Pat Case | 01-12-2010 | 15.2.4 Q4 Window Query with Wildcards and Stemming Ignoring Content of a Descendant Element | Replaced the "." in the ignore path with the $co variable to provide context, added parens around the ftor expressions, changed the ftnot expression to use the XQuery not, restored the expected result to Book 2. |
| Pat Case | 01-12-2010 | 17.2.6 Q6 Query with Weight Declaration | Added predicate to first let clause to return elements instead of a Boolean, specified descending, made weight greater than 1, added where $booktext clause. |
| Pat Case | 01-20-2010 | 17.2.1 Q1 Query Returning Scores | Removed comma in the return statement.. |
| Pat Case | 01-20-2010 | 14.2.2 Q2 Phrase Query Ignoring Content of Descendant Element Specified by XPath Expression | Added a predicate to the let clause and a where clause in the XQuery solution. Replaced the XPath solution. |