|Publication number||US7587417 B2|
|Application number||US 11/393,044|
|Publication date||Sep 8, 2009|
|Filing date||Mar 30, 2006|
|Priority date||Jan 18, 2002|
|Also published as||US7454438, US20030163460, US20060173832, US20060173835, WO2003062987A1|
|Publication number||11393044, 393044, US 7587417 B2, US 7587417B2, US-B2-7587417, US7587417 B2, US7587417B2|
|Inventors||Matthew Shinn, Seth White, Robert Woollen|
|Original Assignee||Bea Systems, Inc.|
|Export Citation||BiBTeX, EndNote, RefMan|
|Patent Citations (24), Non-Patent Citations (3), Classifications (14), Legal Events (3)|
|External Links: USPTO, USPTO Assignment, Espacenet|
This application is a divisional application of U.S. patent application Ser. No. 10/341,107, entitled SYSTEMS AND METHODS FOR DYNAMIC QUERYING, inventors Matthew Shinn, Seth White, and Robert Woollen, filed Jan. 13, 2003, which claims priority to U.S. Provisional Patent Application No. 60/349,432, filed Jan. 18, 2002, entitled ASYSTEMS AND METHODS FOR DYNAMIC QUERYING, both of which are incorporated herein by reference.
A portion of the disclosure of this patent document contains material which is subject to copyright protection. The copyright owner has no objection to the facsimile reproduction by anyone of the patent document of the patent disclosure, as it appears in the Patent and Trademark Office patent file or records, but otherwise reserves all copyright rights whatsoever.
The present invention relates to executing queries against a database.
The Enterprise JavaBean (EJB) specification, published by Sun Microsystems, Inc. of Palo Alto, Calif., describes ways in which a user can execute queries against a database, as well as ways in which a user can communicate queries to an EJB container. Presently, the EJB 2.0 specification forces users to hard-code finder queries into a deployment descriptor for an EJB. A user develops a query before deploying the EJB. Once the EJB is deployed, the user is able to execute the query. A problem exists with this approach, however, in that it is necessary to redeploy the EJB every time the user wishes to run a new query.
Systems and methods in accordance with one embodiment of the present invention can allow a user to dynamically generate a query to be executed against a database. A properties object can be generated that holds settings for the query, which can be specified by a user at runtime. When the query is to be executed, the user or application can invoke an appropriate finder method. The server receiving the call from the finder method can extract the user-specified settings from the properties object and parse the finder method in order to generate a query statement. The server can then execute the query statement on the database and return the appropriate results. The generating of the properties object and the query statement can happen at runtime.
Other features, aspects, and objects of the invention can be obtained from a review of the specification, the figures, and the claims.
Systems and methods in accordance with one embodiment of the present invention can allow a user to define a query programmatically rather than defining the query statically. Static queries are defined, for example, by hard-coding the static query into the deployment descriptor for an EJB. Programmatic queries, or “dynamic queries”, allow users to construct and execute queries in their application code. This can provide several benefits over static queries which utilize static finder methods.
One such benefit is the ability to create and execute new queries without having to update and redeploy an EJB. When deploying an EJB with static queries, each query is read and parsed in order to generate the SQL to be sent to the database. Finder methods can be utilized in executing the query, which can be defined in the home interface of an entity bean. An example of a finder method is findByPrimaryKey( ), which can accept an instance of a primary key and return an instance of that entity type (or throw an exception). Additional finder methods can be defined in local home or remote home interfaces, with each finder method being associated with a query in the deployment descriptor. With dynamic queries, however, the query and corresponding SQL can be generated at runtime.
Another benefit is that the size of an EJB deployment descriptor is reduced. Since the finder queries can be created dynamically, they do not have to be statically defined in the deployment descriptor. For some applications this approach may be a little slower, but the added flexibility will outweigh the slight hit in performance for many users.
One system and method for implementing dynamic queries utilizes the generation of a class such as an ejbHome class. Such a class can be used to implement an extra interface with a method that can execute the query. As shown in
A method that can be used in accordance with the system of
One embodiment can be implemented through a simple API. To enable the use of dynamic queries, users can add an element to their deployment descriptor, such as:
<!ELEMENT enable-dynamic-queries (#PCDATA)>
The enable-dynamic-queries element can be a sub-element of a descriptor such as entity-descriptor. The value of enable-dynamic-queries can be either “true” or “false” in this embodiment. Invoking a dynamic query when dynamic queries have not been enabled can result in an exception being thrown, such as java.rmi.AccessException or javax.ejb.AccessLocalException, depending on whether it was invoked from a Remote or Local interface.
A generated implementation class, such as Homelmpl that can be used for all EJB 2.0 Container-Managed Persistence (CMP) beans, can implement a new interface such as QueryHome. A QueryHome interface can declare a single method, such as:
public Object executeQuery(String query, Properties props) throws FinderException, RemoteException;
There can also be a local version of QueryHome which may be referred to as QueryLocalHome. The only difference between the interfaces can be the “throws” clause of the executeQuery method. The QueryLocalHome iinterface can declare a single method:
public Object executeQuery(String query, Properties props) throws FinderException, EJBException;
The application code can make use of this interface as follows:
InitialContext ic = new InitialContext( ); FooHome fh = (FooHome)ic.lookup(“fooHome”)’ QueryHome qh = (QueryHome)fh; String query = “SELECT OBJECT(e) FROM EmployeeBean e WHERE e.name = ‘rob’ “; Properties props = new Properties( ); props.setProperty(DynamicQuery.MAX_ELEMENTS, “10”); Collection results = (Collection)qh.executeQuery(query, props);
All options that can currently be specified for a static finder can be set in a Properties object passed to the executeQuery method. The Properties key for all valid options can be defined in a DynamicQuery interface. A list of some valid entries is as follows:
The name of the field-group
whose fields are to be loaded
into the cache upon execution of
the query. Note that in order for
this to work, a finders-load-bean
or equivalent option may need to
be enabled for the EJB.
The max-elements attribute is
used to specify the maximum
number of elements that should
be returned by a multi-valued
query. This option can be similar
to the maxRows feature of
The include-updates tag is used
to specify that updates made
during the current transaction
must be reflected in the result of
Used to control whether the gen-
erated SQL ‘SELECT’ will con-
tain a ‘DISTINCT’ qualifier.
Use of the DISTINCT qualifier
will cause the RDBMS to return
Indicates the return type of the
executeQuery method. Legal
values include Collection,
ResultSet. The default value is
Indicates whether a new trans-
action should be started for the
execution of the DynamicQuery
Indicates the isolation level to be
used if a new transaction is
Indicates whether EJBObjects or
EJBLocalObjects should be re-
turned. The legal values are
Local and Remote. If the query
was executed on QueryHome,
EJBObjects will always be re-
turned. If the query was exe-
cuted on QueryLocalHome,
EJBLocalObjects will be re-
turned by default. A result-type-
mapping of Remote can be spe-
cified in this case if EJBObjects
Ideally, dynamic queries execute nearly as fast as static queries. Dynamic queries can invariably be somewhat slower since the queries can require parsing at runtime, whereas static queries are parsed during deployment. The speed of dynamic queries can be increased, such as by extending them to take query parameters and caching the parsed query String.
The foregoing description of preferred embodiments of the present invention has been provided for the purposes of illustration and description. It is not intended to be exhaustive or to limit the invention to the precise forms disclosed. Many modifications and variations will be apparent to one of ordinary skill in the relevant arts. The embodiments were chosen and described in order to best explain the principles of the invention and its practical application, thereby enabling others skilled in the art to understand the invention for various embodiments and with various modifications that are suited to the particular use contemplated. It is intended that the scope of the invention be defined by the claims and their equivalence.
|Cited Patent||Filing date||Publication date||Applicant||Title|
|US5499371||Mar 22, 1995||Mar 12, 1996||Persistence Software, Inc.||Method and apparatus for automatic generation of object oriented code for mapping relational data to objects|
|US6199195||Jul 8, 1999||Mar 6, 2001||Science Application International Corporation||Automatically generated objects within extensible object frameworks and links to enterprise resources|
|US6266666||Sep 8, 1998||Jul 24, 2001||Sybase, Inc.||Component transaction server for developing and deploying transaction- intensive business applications|
|US6308179||Aug 31, 1998||Oct 23, 2001||Xerox Corporation||User level controlled mechanism inter-positioned in a read/write path of a property-based document management system|
|US6442541||Jun 28, 1999||Aug 27, 2002||International Business Machines Corporation||Universal database adapters|
|US6466933||Sep 21, 1999||Oct 15, 2002||International Business Machines Corporation||Delayed delivery of query results or other data from a federated server to a federated client until such information is needed|
|US6505200||Jul 6, 2000||Jan 7, 2003||International Business Machines Corporation||Application-independent data synchronization technique|
|US6539396||Aug 31, 1999||Mar 25, 2003||Accenture Llp||Multi-object identifier system and method for information service pattern environment|
|US6571282||Aug 31, 1999||May 27, 2003||Accenture Llp||Block-based communication in a communication services patterns environment|
|US6640244||Aug 31, 1999||Oct 28, 2003||Accenture Llp||Request batcher in a transaction services patterns environment|
|US6687702||Sep 25, 2001||Feb 3, 2004||Sybass, Inc.||Methodology providing high-speed shared memory access between database middle tier and database server|
|US6694328||Jan 13, 2000||Feb 17, 2004||International Business Machines Corporation||Method for creating queries on version objects|
|US6748373||Sep 17, 2002||Jun 8, 2004||Bea Systems, Inc.||System and method for adaptively optimizing queries|
|US6760719||Sep 24, 1999||Jul 6, 2004||Unisys Corp.||Method and apparatus for high speed parallel accessing and execution of methods across multiple heterogeneous data sources|
|US6823329 *||Apr 2, 2002||Nov 23, 2004||Sybase, Inc.||Database system providing methodology for acceleration of queries involving functional expressions against columns having enumerated storage|
|US6836889||Jul 20, 2000||Dec 28, 2004||International Business Machines Corporation||Code wrapping to simplify access to and use of enterprise JAVA beans|
|US6971085 *||Aug 31, 2000||Nov 29, 2005||International Business Machines Corporation||Object oriented structured query language (OOSQL) support for enterprise java beans|
|US6985899 *||Nov 27, 2001||Jan 10, 2006||International Business Machines Corporation||Method and system for composing a query for a database and traversing the database|
|US6996565||Sep 4, 2002||Feb 7, 2006||Initiate Systems, Inc.||System and method for dynamically mapping dynamic multi-sourced persisted EJBs|
|US6999956||Nov 15, 2001||Feb 14, 2006||Ward Mullins||Dynamic object-driven database manipulation and mapping system|
|US7089230 *||Jun 7, 2002||Aug 8, 2006||International Business Machines Corporation||Method for efficient processing of multi-state attributes|
|US20030163460||Jan 13, 2003||Aug 28, 2003||Matthew Shinn||Systems and methods for dynamic querying|
|US20040111701 *||Dec 5, 2002||Jun 10, 2004||Cedric Beust||System and method for generating Enterprise Java Bean code|
|GB2339036A||Title not available|
|1||Crechert et al., "Performance and Scalability of EJB Application," Proceedings of the 17th ACM Conference on Object-Oriented Programming, Systems, Languages and Applications, Nov. 2002, vol. 37, Issue 11, ACM Press, pp. 246-250.|
|2||International Search Report for PCT/US03/01211 dated Apr. 14, 2003 (2 pages).|
|3||International Search Report for PCT/US03/04948 dated May 2, 2003 (3 pages).|
|U.S. Classification||1/1, 717/108, 719/310, 707/999.103, 707/999.003|
|International Classification||G06F17/30, G06F9/44, G06F7/00, G06F3/00, G06F9/45|
|Cooperative Classification||Y10S707/99944, Y10S707/99933, G06F17/30386|
|Jun 29, 2010||CC||Certificate of correction|
|Oct 15, 2010||AS||Assignment|
Free format text: ASSIGNMENT OF ASSIGNORS INTEREST;ASSIGNOR:BEA SYSTEMS, INC.;REEL/FRAME:025192/0244
Effective date: 20101008
Owner name: ORACLE INTERNATIONAL CORPORATION, CALIFORNIA
|Feb 6, 2013||FPAY||Fee payment|
Year of fee payment: 4