FileDocCategorySizeDatePackage
EJBQLCall.javaAPI DocGlassfish v2 API7510Tue May 22 16:54:50 BST 2007oracle.toplink.essentials.queryframework

EJBQLCall

public class EJBQLCall extends Object implements Call, Serializable
Purpose: Used as an abstraction of a database invocation. A call is an EJBQL string.

Fields Summary
protected DatabaseQuery
query
protected String
ejbqlString
protected boolean
isParsed
Constructors Summary
public EJBQLCall()
PUBLIC Create a new EJBQLCall.

        super();
    
public EJBQLCall(String ejbqlString)
PUBLIC Create a new EJBQLCall with an ejbqlString

        this();
        this.ejbqlString = ejbqlString;
    
Methods Summary
public oracle.toplink.essentials.internal.queryframework.DatabaseQueryMechanismbuildNewQueryMechanism(oracle.toplink.essentials.queryframework.DatabaseQuery query)
INTERNAL: Return the appropriate mechanism, with the call added as necessary.

        return new EJBQLCallQueryMechanism(query, this);
    
public oracle.toplink.essentials.internal.queryframework.DatabaseQueryMechanismbuildQueryMechanism(oracle.toplink.essentials.queryframework.DatabaseQuery query, oracle.toplink.essentials.internal.queryframework.DatabaseQueryMechanism mechanism)
INTERNAL: Return the appropriate mechanism, with the call added as necessary.

        return buildNewQueryMechanism(query);
    
public java.lang.Objectclone()

        try {
            return super.clone();
        } catch (CloneNotSupportedException cnse) {
            return null;
        }
    
public java.lang.StringgetCallString()
INTERNAL: Return the string for the call

        return getEjbqlString();
    
public java.lang.StringgetEjbqlString()
INTERNAL: Return the EJBQL string for this call

        return ejbqlString;
    
private booleangetIsParsed()
INTERNAL Return the isParsed state

        return isParsed;
    
public java.lang.StringgetLogString(oracle.toplink.essentials.internal.databaseaccess.Accessor accessor)
INTERNAL: Return the SQL string for this call. Always return null since this is an EJBQL call

        return getSQLString();
    
public oracle.toplink.essentials.queryframework.DatabaseQuerygetQuery()
Back reference to query, unfortunately required for events.

        return query;
    
public java.lang.StringgetSQLString()
INTERNAL: Return the SQL string for this call. Always return null since this is an EJBQL call

        return null;
    
public booleanisEJBQLCall()
INTERNAL: Yes this is an EJBQLCall

        return true;
    
public booleanisFinished()
Return whether all the results of the call have been returned.

        //never used, but required for implementing Call.
        return true;
    
public booleanisParsed()
INTERNAL Is this query Parsed

        return getIsParsed();
    
public voidpopulateQuery(oracle.toplink.essentials.internal.sessions.AbstractSession session)
Populate the query using the information retrieved from parsing the EJBQL.

        if (!isParsed()) {
			//bug4324564: moved code to EJBQLParserFactory.populateQuery -CD
            (new EJBQLParserFactory()).populateQuery(getEjbqlString(), (ObjectLevelReadQuery)getQuery(), session);
            // Make sure we don't parse and prepare again.
            this.setIsParsed(true);
        }
    
public java.sql.PreparedStatementprepareStatement(oracle.toplink.essentials.internal.databaseaccess.DatabaseAccessor accessor, oracle.toplink.essentials.internal.sessions.AbstractRecord translationRow, oracle.toplink.essentials.internal.sessions.AbstractSession session)
INTERNAL: Prepare the JDBC statement, this may be parameterize or a call statement. If caching statements this must check for the pre-prepared statement and re-bind to it.

        return null;
    
public voidsetEjbqlString(java.lang.String newEjbqlString)
INTERNAL: Set the EJBQL string for this call

        ejbqlString = newEjbqlString;
    
public voidsetIsParsed(boolean newIsParsed)
INTERNAL Set the isParsed state

        isParsed = newIsParsed;
    
public voidsetQuery(oracle.toplink.essentials.queryframework.DatabaseQuery query)
INTERNAL: Back reference to query, unfortunately required for events.

        this.query = query;
    
public voidtranslate(oracle.toplink.essentials.internal.sessions.AbstractRecord translationRow, oracle.toplink.essentials.internal.sessions.AbstractRecord modifyRow, oracle.toplink.essentials.internal.sessions.AbstractSession session)
INTERNAL: translate method comment.