EJBQLCompiledExpression


1   /*****************************************************************
2    *   Licensed to the Apache Software Foundation (ASF) under one
3    *  or more contributor license agreements.  See the NOTICE file
4    *  distributed with this work for additional information
5    *  regarding copyright ownership.  The ASF licenses this file
6    *  to you under the Apache License, Version 2.0 (the
7    *  "License"); you may not use this file except in compliance
8    *  with the License.  You may obtain a copy of the License at
9    *
10   *    http://www.apache.org/licenses/LICENSE-2.0
11   *
12   *  Unless required by applicable law or agreed to in writing,
13   *  software distributed under the License is distributed on an
14   *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   *  KIND, either express or implied.  See the License for the
16   *  specific language governing permissions and limitations
17   *  under the License.
18   ****************************************************************/
19  package org.apache.cayenne.ejbql;
20  
21  import org.apache.cayenne.map.ObjRelationship;
22  import org.apache.cayenne.query.SQLResultSetMapping;
23  import org.apache.cayenne.reflect.ClassDescriptor;
24  
25  /**
26   * Represents an EJB QL expression "compiled" in the context of a certain mapping.
27   * 
28   * @author Andrus Adamchik
29   * @since 3.0
30   */
31  public interface EJBQLCompiledExpression {
32  
33      /**
34       * Returns a tree representation of an EJBQL expression.
35       */
36      EJBQLExpression getExpression();
37  
38      /**
39       * Returns a descriptor of the root of this expression such as entity being fetched or
40       * updated.
41       */
42      ClassDescriptor getRootDescriptor();
43  
44      /**
45       * Returns a ClassDescriptor for the id variable.
46       */
47      ClassDescriptor getEntityDescriptor(String   identifier);
48  
49      /**
50       * Returns a relationship that joins identifier with a parent entity. Returns null if
51       * the identifier corresponds to one of the query roots.
52       */
53      ObjRelationship getIncomingRelationship(String   identifier);
54  
55      /**
56       * Returns EJB QL source of the compiled expression if available.
57       */
58      String   getSource();
59  
60      /**
61       * Returns a mapping of the result set columns, or null if this is not a select
62       * expression.
63       */
64      SQLResultSetMapping getResultSetMapping();
65  }
66
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags