org.jboss.ejb.plugins.cmp.jdbc.metadata
Class JDBCQlQueryMetaData

java.lang.Object
  org.jboss.ejb.plugins.cmp.jdbc.metadata.JDBCQlQueryMetaData

All Implemented Interfaces:

JDBCQueryMetaData

public final class JDBCQlQueryMetaData
extends Object
implements JDBCQueryMetaData

Immutable class which contains information about an EJB QL query.

Version:

$Revision: 57209 $

Author:

Dain Sundstrom

Constructor Summary

JDBCQlQueryMetaData(JDBCQlQueryMetaData defaults, JDBCReadAheadMetaData readAhead, Class compiler, boolean lazyResultSetLoading)
Constructs a JDBCQlQueryMetaData with data from the jdbcQueryMetaData and additional data from the xml element

JDBCQlQueryMetaData(JDBCQlQueryMetaData jdbcQueryMetaData, Method method, JDBCReadAheadMetaData readAhead)
Constructs a JDBCQlQueryMetaData with data from the jdbcQueryMetaData and additional data from the xml element

JDBCQlQueryMetaData(QueryMetaData queryMetaData, Method method, Class qlCompiler, boolean lazyResultSetLoading)
Constructs a JDBCQlQueryMetaData which is defined by the queryMetaData and is invoked by the specified method.

Method Summary

boolean	equals(Object o) Compares this JDBCQlQueryMetaData against the specified object.
String	getEjbQl() Gets the EJB QL query which will be invoked.
Method	getMethod() Gets the method which invokes this query.
Class	getQLCompilerClass()
JDBCReadAheadMetaData	getReadAhead() Gets the read ahead metadata for the query.
int	hashCode() Returns a hashcode for this JDBCQlQueryMetaData.
boolean	isLazyResultSetLoading()
boolean	isResultTypeMappingLocal() Is the result set of ejbSelect is mapped to local ejb objects or remote ejb objects.
String	toString() Returns a string describing this JDBCQlQueryMetaData.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

JDBCQlQueryMetaData

public JDBCQlQueryMetaData(QueryMetaData queryMetaData,
                           Method method,
                           Class qlCompiler,
                           boolean lazyResultSetLoading)

Constructs a JDBCQlQueryMetaData which is defined by the queryMetaData and is invoked by the specified method.

Parameters:

queryMetaData - the metadata about this query which was loaded from the ejb-jar.xml file

method - the method which invokes this query

JDBCQlQueryMetaData

public JDBCQlQueryMetaData(JDBCQlQueryMetaData defaults,
                           JDBCReadAheadMetaData readAhead,
                           Class compiler,
                           boolean lazyResultSetLoading)

Constructs a JDBCQlQueryMetaData with data from the jdbcQueryMetaData and additional data from the xml element

JDBCQlQueryMetaData

public JDBCQlQueryMetaData(JDBCQlQueryMetaData jdbcQueryMetaData,
                           Method method,
                           JDBCReadAheadMetaData readAhead)

Constructs a JDBCQlQueryMetaData with data from the jdbcQueryMetaData and additional data from the xml element

Method Detail

getMethod

public Method getMethod()

Description copied from interface: JDBCQueryMetaData

Gets the method which invokes this query.

Specified by:

getMethod in interface JDBCQueryMetaData

Returns:

the Method object which invokes this query

getQLCompilerClass

public Class getQLCompilerClass()

Specified by:

getQLCompilerClass in interface JDBCQueryMetaData

Returns:

EJBQL compiler implementation

getEjbQl

public String getEjbQl()

Gets the EJB QL query which will be invoked.

Returns:

the ejb ql String for this query

isResultTypeMappingLocal

public boolean isResultTypeMappingLocal()

Description copied from interface: JDBCQueryMetaData

Is the result set of ejbSelect is mapped to local ejb objects or remote ejb objects.

Specified by:

isResultTypeMappingLocal in interface JDBCQueryMetaData

Returns:

true, if the result set is to be local objects

getReadAhead

public JDBCReadAheadMetaData getReadAhead()

Gets the read ahead metadata for the query.

Specified by:

getReadAhead in interface JDBCQueryMetaData

Returns:

the read ahead metadata for the query.

isLazyResultSetLoading

public boolean isLazyResultSetLoading()

Specified by:

isLazyResultSetLoading in interface JDBCQueryMetaData

equals

public boolean equals(Object o)

Compares this JDBCQlQueryMetaData against the specified object. Returns true if the objects are the same. Two JDBCQlQueryMetaData are the same if they are both invoked by the same method.

Overrides:

equals in class Object

Parameters:

o - the reference object with which to compare

Returns:

true if this object is the same as the object argument; false otherwise

hashCode

public int hashCode()

Returns a hashcode for this JDBCQlQueryMetaData. The hashcode is computed by the method which invokes this query.

Overrides:

hashCode in class Object

Returns:

a hash code value for this object

toString

public String toString()

Returns a string describing this JDBCQlQueryMetaData. The exact details of the representation are unspecified and subject to change, but the following may be regarded as typical:

"[JDBCQlQueryMetaData: method=public org.foo.User findByName(java.lang.String)]"

Overrides:

toString in class Object

Returns:

a string representation of the object