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

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

All Implemented Interfaces:

JDBCQueryMetaData (src)

public final class JDBCDeclaredQueryMetaData

extends java.lang.Object

implements JDBCQueryMetaData (src)

Imutable class contains information about a declated query.

JDBCDeclaredQueryMetaData

public JDBCDeclaredQueryMetaData(JDBCDeclaredQueryMetaData (src)  defaults,
                                 JDBCReadAheadMetaData (src)  readAhead,
                                 java.lang.Class compiler,
                                 boolean lazyResultSetLoading)
                          throws DeploymentException (src) 

Constructs a JDBCDeclaredQueryMetaData which is defined by the declared-sql xml element and is invoked by the specified method. Inherits unspecified values from the defaults.

Parameters:

defaults - the default values to use

readAhead - the read-ahead properties for this query

JDBCDeclaredQueryMetaData

public JDBCDeclaredQueryMetaData(boolean isResultTypeMappingLocal,
                                 org.w3c.dom.Element queryElement,
                                 java.lang.reflect.Method method,
                                 JDBCReadAheadMetaData (src)  readAhead,
                                 java.lang.Class compiler,
                                 boolean lazyResultSetLoading)
                          throws DeploymentException (src) 

Constructs a JDBCDeclaredQueryMetaData which is defined by the declared-sql xml element and is invoked by the specified method.

Parameters:

queryElement - the xml Element which contains the metadata about this query

method - the method which invokes this query

readAhead - the read-ahead properties for this query

getMethod

public java.lang.reflect.Method getMethod()

Description copied from interface: JDBCQueryMetaData (src)

Gets the method which invokes this query.

Specified by:

getMethod in interface JDBCQueryMetaData (src)

Returns:

the Method object which invokes this query

isResultTypeMappingLocal

public boolean isResultTypeMappingLocal()

Description copied from interface: JDBCQueryMetaData (src)

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

Specified by:

isResultTypeMappingLocal in interface JDBCQueryMetaData (src)

Returns:

true, if the result set is to be local objects

getReadAhead

public JDBCReadAheadMetaData (src)  getReadAhead()

Gets the read ahead metadata for the query.

Specified by:

getReadAhead in interface JDBCQueryMetaData (src)

Returns:

the read ahead metadata for the query.

getQLCompilerClass

public java.lang.Class getQLCompilerClass()

Specified by:

getQLCompilerClass in interface JDBCQueryMetaData (src)

Returns:

EJBQL compiler implementation

getFrom

public java.lang.String getFrom()

Gets the sql FROM clause of this query.

Returns:

a String which contains the sql FROM clause

getWhere

public java.lang.String getWhere()

Gets the sql WHERE clause of this query.

Returns:

a String which contains the sql WHERE clause

getOrder

public java.lang.String getOrder()

Gets the sql ORDER BY clause of this query.

Returns:

a String which contains the sql ORDER BY clause

getOther

public java.lang.String getOther()

Gets other sql code which is appended to the end of the query. This is userful for supplying hints to the query engine.

Returns:

a String which contains additional sql code which is appended to the end of the query

isSelectDistinct

public boolean isSelectDistinct()

Should the select be DISTINCT?

Returns:

true if the select clause should contain distinct

getEJBName

public java.lang.String getEJBName()

The name of the ejb from which the field will be selected.

Returns:

the name of the ejb from which a field will be selected, or null if returning a whole ejb

getFieldName

public java.lang.String getFieldName()

The name of the cmp-field to be selected.

Returns:

the name of the cmp-field to be selected or null if returning a whole ejb

getAlias

public java.lang.String getAlias()

The alias that is used for the select table.

Returns:

the alias that is used for the table from which the entity or field is selected.

getAdditionalColumns

public java.lang.String getAdditionalColumns()

Additional columns that should be added to the select clause. For example, columns that are used in an order by clause.

Returns:

additional columns that should be added to the select clause

isLazyResultSetLoading

public boolean isLazyResultSetLoading()

Specified by:

isLazyResultSetLoading in interface JDBCQueryMetaData (src)

equals

public boolean equals(java.lang.Object o)

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

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 JDBCDeclaredQueryMetaData. The hashcode is computed by the method which invokes this query.

Returns:

a hash code value for this object

toString

public java.lang.String toString()

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

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

Returns:

a string representation of the object