JDBCAutomaticQueryMetaData (JBoss Server API) - JBoss 4.0.1 sp1 server API Documentation 英文版文档

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

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

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

All Implemented Interfaces:: JDBCQueryMetaData

public final class JDBCAutomaticQueryMetaData
extends Object
implements JDBCQueryMetaData

This immutable class contains information about an automatically generated query. This class is a place holder used to make an automaticlly generated query look more like a user specified query. This class only contains a referance to the method used to invoke this query.

Version:: $Revision: 1.12 $
Author:: Dain Sundstrom, Sebastien Alborini

Constructor Summary

JDBCAutomaticQueryMetaData(Method method, JDBCReadAheadMetaData readAhead, Class qlCompiler, boolean lazyResultSetLoading)
          Constructs a JDBCAutomaticQueryMetaData which is invoked by the specified method.

Method Summary

boolean equals(Object o)
          Compares this JDBCAutomaticQueryMetaData against the specified object.

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 JDBCAutomaticQueryMetaData.

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 JDBCAutomaticQueryMetaData.

Methods inherited from class java.lang.Object

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

Constructor Detail

JDBCAutomaticQueryMetaData

public JDBCAutomaticQueryMetaData(Method method,
                                  JDBCReadAheadMetaData readAhead,
                                  Class qlCompiler,
                                  boolean lazyResultSetLoading)

Constructs a JDBCAutomaticQueryMetaData which is invoked by the specified method.
Parameters:: method - the method which invokes this query

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

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.

getQLCompilerClass

public Class getQLCompilerClass()

Specified by:: getQLCompilerClass in interface JDBCQueryMetaData

Returns:: EJBQL compiler implementation

isLazyResultSetLoading

public boolean isLazyResultSetLoading()

Specified by:: isLazyResultSetLoading in interface JDBCQueryMetaData

equals

public boolean equals(Object o)

Compares this JDBCAutomaticQueryMetaData against the specified object. Returns true if the objects are the same. Two JDBCAutomaticQueryMetaData 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 JDBCAutomaticQueryMetaData. The hashcode is computed by the method which invokes this query.

Returns:: a hash code value for this object

toString

public String toString()

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

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

Returns:: a string representation of the object