001: /*
002: * JBoss, Home of Professional Open Source.
003: * Copyright 2006, Red Hat Middleware LLC, and individual contributors
004: * as indicated by the @author tags. See the copyright.txt file in the
005: * distribution for a full listing of individual contributors.
006: *
007: * This is free software; you can redistribute it and/or modify it
008: * under the terms of the GNU Lesser General Public License as
009: * published by the Free Software Foundation; either version 2.1 of
010: * the License, or (at your option) any later version.
011: *
012: * This software is distributed in the hope that it will be useful,
013: * but WITHOUT ANY WARRANTY; without even the implied warranty of
014: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
015: * Lesser General Public License for more details.
016: *
017: * You should have received a copy of the GNU Lesser General Public
018: * License along with this software; if not, write to the Free
019: * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
020: * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
021: */
022: package org.jboss.ejb.plugins.cmp.jdbc.metadata;
023:
024: import java.lang.reflect.Method;
025:
026: /**
027: * This immutable class contains information about an automatically generated
028: * query. This class is a place holder used to make an automaticlly generated
029: * query look more like a user specified query. This class only contains a
030: * referance to the method used to invoke this query.
031: *
032: * @author <a href="mailto:dain@daingroup.com">Dain Sundstrom</a>
033: * @author <a href="sebastien.alborini@m4x.org">Sebastien Alborini</a>
034: * @version $Revision: 57209 $
035: */
036: public final class JDBCAutomaticQueryMetaData implements
037: JDBCQueryMetaData {
038: /**
039: * A referance to the method which invokes this query.
040: */
041: private final Method method;
042:
043: /**
044: * Read ahead meta data.
045: */
046: private final JDBCReadAheadMetaData readAhead;
047:
048: private final Class compiler;
049:
050: private final boolean lazyResultSetLoading;
051:
052: /**
053: * Constructs a JDBCAutomaticQueryMetaData which is invoked by the specified
054: * method.
055: *
056: * @param method the method which invokes this query
057: * @readAhead Read ahead meta data.
058: */
059: public JDBCAutomaticQueryMetaData(Method method,
060: JDBCReadAheadMetaData readAhead, Class qlCompiler,
061: boolean lazyResultSetLoading) {
062: this .method = method;
063: this .readAhead = readAhead;
064: this .compiler = qlCompiler;
065: this .lazyResultSetLoading = lazyResultSetLoading;
066: }
067:
068: public Method getMethod() {
069: return method;
070: }
071:
072: public boolean isResultTypeMappingLocal() {
073: return false;
074: }
075:
076: /**
077: * Gets the read ahead metadata for the query.
078: *
079: * @return the read ahead metadata for the query.
080: */
081: public JDBCReadAheadMetaData getReadAhead() {
082: return readAhead;
083: }
084:
085: public Class getQLCompilerClass() {
086: return compiler;
087: }
088:
089: public boolean isLazyResultSetLoading() {
090: return lazyResultSetLoading;
091: }
092:
093: /**
094: * Compares this JDBCAutomaticQueryMetaData against the specified object. Returns
095: * true if the objects are the same. Two JDBCAutomaticQueryMetaData are the same
096: * if they are both invoked by the same method.
097: *
098: * @param o the reference object with which to compare
099: * @return true if this object is the same as the object argument; false otherwise
100: */
101: public boolean equals(Object o) {
102: if (o instanceof JDBCAutomaticQueryMetaData) {
103: return ((JDBCAutomaticQueryMetaData) o).method
104: .equals(method);
105: }
106: return false;
107: }
108:
109: /**
110: * Returns a hashcode for this JDBCAutomaticQueryMetaData. The hashcode is computed
111: * by the method which invokes this query.
112: *
113: * @return a hash code value for this object
114: */
115: public int hashCode() {
116: return method.hashCode();
117: }
118:
119: /**
120: * Returns a string describing this JDBCAutomaticQueryMetaData. The exact details
121: * of the representation are unspecified and subject to change, but the following
122: * may be regarded as typical:
123: * <p/>
124: * "[JDBCAutomaticQueryMetaData: method=public org.foo.User findByName(java.lang.String)]"
125: *
126: * @return a string representation of the object
127: */
128: public String toString() {
129: return "[JDBCAutomaticQueryMetaData : method=" + method + "]";
130: }
131: }
|