Technique for encapsulating a query definition

• US 7,152,062 B1
• Filed: 11/21/2000
• Issued: 12/19/2006
• Est. Priority Date: 11/21/2000
• Status: Expired due to Term

• Current Assignee: Open Text Holdings, Inc. (Open Text Corporation)
• Original Assignee: Actuate Corporation (Open Text Corporation)
• Inventors: Heitzeberg, Joseph, Draper, Denise L.
• Primary Examiner(s): ROBINSON, GRETA LEE
• Application Number:
  US09/718,228
• Time in Patent Office: 2,219 Days
• Field of Search: 707/3, 707/4, 707/100, 707/103.R, 707/101, 707/103.X, 707/103.Y, 707/103.Z, 707/10, 715/513
• US Class Current: 1/1
• CPC Class Codes: G06F 16/832 Query formulation
• CPC Class Codes: G06F 16/84 Mapping; Conversion
• CPC Class Codes: Y10S 707/99934 Query formulation, input preparation, or translation
• CPC Class Codes: Y10S 707/99942 Manipulating data structure, e.g. compression, compaction, compilation
• CPC Class Codes: Y10S 707/99944 Object-oriented database structure

Abstract

A method and system for querying data sources. The query system provides a query definition for defining queries in a uniform manner. The query definition includes a query specification, a data source identifier, and optionally, one or more results transforms. The query definition may be stored as a data structure on computer-readable media, such as a CD-ROM. The query specification includes query text and parameters. The query text specifies the query expression that is to be applied to the identified data source to generate the results. The parameters specify portions of the query text that can be changed by a user before a query is executed.

Claims

1. A computer-readable medium containing a data structure defining a query definition, the data structure including:

a query specification including query text and parameters, the parameters having values that may be set by a user before or when the query definition is executed;

a results transform that transforms results of executing the query specification into a canonical format; and

a data source identifier that identifies a data source to be used when the query specification is executed;

wherein the data structure encapsulates the query definition.

2. The computer-readable medium of claim 1 wherein the results transform is an XSL transform.

3. The computer-readable medium of claim 1 wherein the data structure is represented in XML format.

4. The computer-readable medium of claim 1 wherein the data structure conforms with the following data type definition of XML:

<

!DOCTYPE lens [ <

!ELEMENT query (#PCDATA) REQUIRED>

<

!ELEMENT params (param+)>

<

!ELEMENT param (allowedvalues | props)*>

<

!ATTLIST param name CDATA REQUIRED>

<

!ATTLIST param value CDATA REQUIRED>

<

!ELEMENT formats (format+) REQUIRED>

<

!ELEMENT format (#PCDATA)>

<

!ATTLIST format name CDATA REQUIRED>

<

!ELEMENT serverurl (#PCDATA) REQUIRED>

<

!ELEMENT sort (#PCDATA)>

<

!ATTLIST sort var CDATA REQUIRED>

<

!ATTLIST sort dir (ASC|DESC) REQUIRED>

]>

.

5. The computer-readable medium of claim 1 wherein the data structure includes a name.

6. The computer-readable medium of claim 1 wherein the data structure includes a description.

7. The computer-readable medium of claim 1 wherein the data structure includes a version.

8. The computer-readable medium of claim 1 wherein the data structure includes an author.

9. The computer-readable medium of claim 1 wherein the data structure includes a date last modified.

10. The computer-readable medium of claim 1 wherein the data structure can be used by different application programs.

11. The computer-readable medium as recited in claim 1, wherein the query definition can be executed via an API.

12. The computer-readable medium as recited in claim 11, wherein the API provides one or more functions for accessing the query definition.

13. The computer-readable medium as recited in claim 11, wherein the API provides at least one of a function for loading a query definition, a function for setting one or more values of one or more of the parameters of the query definition, and a function for executing the query definition.

14. The computer-readable medium as recited in claim 1, wherein each of the parameters includes an ignore attribute, the ignore attribute indicating whether the parameter is to be used in the query.

15. The computer-readable medium as recited in claim 1, wherein one or more of the parameters has one or more associated allowed values.

16. The computer-readable medium as recited in claim 1, further comprising:

a sort indicator indicating a manner in which the results of executing the query are to be sorted.

17. The computer-readable medium as recited in claim 1, wherein the canonical format includes at least one of a value, table, and markup tags.

18. The computer-readable medium as recited in claim 17, wherein the value has at least one of a color, style, size, font, and dynamic attribute, the dynamic attribute indicating whether the value is dynamically generated by executing the query specification.

19. The computer-readable medium as recited in claim 1, wherein the canonical format includes a sort tag indicating a variable or parameter according to which the results are to be sorted.

20. The computer-readable medium as recited in claim 19, wherein the results are to be sorted according to the variable or parameter when a specified value is selected or specified by a user for the variable or parameter.

21. The computer-readable medium as recited in claim 1, wherein the canonical format includes a cross link, the cross link indicating one or more query definitions having a particular value for one or more of the parameters.

22. The computer-readable medium as recited in claim 1, wherein the canonical format comprises:

a table element having one or more row elements and one or more columns;

for each of the one or more row elements, one or more data elements, each data element corresponding to one of the one or more columns of the table element; and

each data element having one or more values or table elements with row elements and data elements.

23. A method in a computer-system for performing a query, the method comprising:

receiving an indication of a query definition encapsulated by a data structure, the query definition including a query specification and a results transform;

identifying a data source from the query specification;

requesting execution of the query specification with the identified data source to generate results in a raw format; and

transforming the generated results in the raw format to a canonical format using the results transform.

24. The method of claim 23 wherein the query definition includes an indication of the data source and the identifying of the data source includes retrieving the indication from the query definition.

25. The method of claim 23 wherein the query specification includes an indication of a parameter for the query specification and the method includes receiving a value for the parameter, wherein the requesting of the execution of the query specification indicates the value of the parameter.

26. The method of claim 23 wherein the query specification includes an indication of a parameter for the query specification and a value for the parameter.

27. The method of claim 26 including updating the value of the parameter in response to input from a user, wherein the value is stored with the query specification.

28. The method of claim 23 wherein the results transform is an XSL transform.

29. The method of claim 23 wherein the results transform includes instructions for display of the generated results.

30. The method of claim 23 wherein the data structure is represented by the following XML format:

<

!DOCTYPE FORMATTING [ <

!ELEMENT (table)>

<

!ELEMENT value #PCDATA>

<

!ATTLIST value color CDATA>

<

!ATTLIST value style (b|i|bi|p>

<

!ATTLIST value size CDATA>

<

!ATTLIST value face CDATA>

<

!ATTLIST value dynamic (true|false)>

<

!ELEMENT table (tr*)>

<

!ATTLIST table name CDATA #REQUIRED>

<

!ATTLIST table border CDATA>

<

!ATTLIST table cellpadding CDATA>

<

!ATTLIST table cellspacing CDATA>

<

!ATTLIST table bordercolor CDATA>

<

!ATTLIST table valign CDATA>

<

!ELEMENT tr (td*)>

<

!ELEMENT td (value | table)*>

<

!ATTLIST td id CDATA #REQUIRED>

<

!ATTLIST td colspan CDATA>

<

!ATTLIST td rowspan CDATA>

<

!ATTLIST td align CDATA>

<

!ATTLIST td valign CDATA>

<

!ELEMENT sort (#PCDATA)>

<

!ATTLIST sort var CDATA REQUIRED>

<

!ATTLIST sort dir (ASC|DESC) REQUIRED>

<

!ELEMENT markup (p | br)*>

<

!ELEMENT p>

<

!ELEMENT br>

<

!ELEMENT crosslink (#PCDATA)>

<

!ATTLIST crosslink lens CDATA REQUIRED>

<

!ATTLIST crosslink param CDATA REQUIRED>

<

!ATTLIST crosslink value CDATA REQUIRED>

<

!ATTLIST crosslink display CDATA>

]>

.

31. The method as recited in claim 23, wherein the identifying of the data source includes obtaining a data source identifier identifying the data source via an API.

32. The method as recited in claim 23, wherein the query definition can be executed via an API.

33. The method as recited in claim 32, wherein the API provides one or more functions for accessing the query definition.

34. The method as recited in claim 32, wherein the API provides at least one of a function for loading a query definition, a function for setting one or more values of one or more parameters of the query definition, and a function for executing the query definition.

35. The method as recited in claim 23, wherein each parameter of the query definition includes an ignore attribute, the ignore attribute indicating whether the parameter is to be used in the query.

36. The method as recited in claim 23, wherein one or more parameters of the query definition has one or more associated allowed values.

37. The method as recited in claim 23, wherein the query definition includes a sort indicator indicating a manner in which the results of executing the query are to be sorted.

38. The method as recited in claim 23, wherein the canonical format includes at least one of a value, table, and markup tags.

39. The method as recited in claim 38, wherein the value has at least one of a color, style, size, font, and dynamic attribute, the dynamic attribute indicating whether the value is dynamically generated by executing the query specification.

40. The method as recited in claim 23, wherein the canonical format includes a sort tag indicating a variable or parameter according to which the results are to be sorted.

41. The method as recited in claim 40, wherein the results are to be sorted according to the variable or parameter when a specified value is selected or specified by a user for the variable or parameter.

42. The method as recited in claim 23, wherein the canonical format includes a cross link, the cross link indicating one or more query definitions having a particular value for one or more parameters of the query definition.

43. The method as recited in claim 23, wherein the canonical format comprises:

a table element having one or more row elements and one or more columns;

for each of the one or more row elements, one or more data elements, each data element corresponding to one of the one or more columns of the table element; and

each data element having one or more values or table elements with row elements and data elements.

44. A computer-readable medium containing a data structure defining a query definition, the data structure comprising:

a query specification including query text that is an expression of a query; and

a data source identifier that identifies a data source to be used when the query specification is executed;

whereby the data structure encapsulates the query definition that can be used by a plurality of different application programs to define a query that is to be executed using the query specification and the data source identified by the data source identifier.

45. The computer-readable medium of claim 44 wherein the data structure further includes a results transform for transforming results of the execution of the query to a canonical format.

46. The computer-readable medium of claim 45 wherein the results transform is an XSL transform.

47. The computer readable medium of claim 44 wherein the data structure is represented in XML format.

48. The computer-readable medium of claim 44 wherein the query specification includes one or more parameters, each of the one or more parameters having one or more values that may be set by a user before or when the query is executed.

49. The computer-readable medium of claim 48 wherein the query specification includes one or more possible values for one or more of the parameters.

50. The computer-readable medium of claim 44 wherein the query specification includes one or more sort variables for ordering of the results of the query.

51. The computer-readable medium of claim 44 wherein execution of the query produces the same query results for each application program.

52. A computer-readable medium containing instructions for controlling computer systems to execute queries by a method comprising:

receiving a query definition that includes a query specification and a data source identifier, the query definition being encapsulated by a data structure that can be accessed by a plurality of different application programs; and

requesting execution of the query definition to generate results.

53. The computer-readable medium of claim 52 wherein the query definition includes a results transform, the method further including using the results transform to transform the generated results from a raw format to a canonical format.

54. The computer-readable medium of claim 53 wherein the results transform is an XSL transform.

55. The computer-readable medium of claim 52 including transforming the generated results from a raw format to a canonical format.

56. The computer-readable medium of claim 52 wherein the query definition is a lens file.

57. The computer-readable medium of claim 52 wherein the query definition is stored in a single file.

58. The computer-readable medium of claim 52 wherein the results are in a canonical format.

59. The computer-readable medium of claim 52 wherein the requesting of execution of the query includes invoking a function of a first interface that returns a second interface for retrieving the results a portion at a time.

60. The computer-readable medium of claim 59 wherein the first API is the ILens interface.

61. The computer-readable medium of claim 59 wherein the second interface is the IChunks interface.

62. A computer system for executing queries, the computer system comprising:

means for receiving a data structure encapsulating a query definition that includes a query specification and a data source identifier; and

means for requesting execution of the query definition to generate results using the query specification and a data source identified by the data source identifier.

63. The computer system of claim 62 wherein the query definition includes a results transform and including using the results transform to transform the generated results from a raw format to a canonical format.

64. The computer system of claim 63 wherein the results transform is an XSL transform.

65. The computer system of claim 62 including transforming the generated results from a raw format to a canonical format.

66. The computer system of claim 62 wherein the query definition is a lens file.

67. The computer system of claim 62 wherein the query definition is stored in a single file.

68. The computer system of claim 62 wherein the results are in a canonical format.