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: import org.jboss.deployment.DeploymentException;
027:
028: /**
029: * Immutable class which contains information about an DynamicQL query.
030: *
031: * @author <a href="mailto:dain@daingroup.com">Dain Sundstrom</a>
032: * @version $Revision: 57209 $
033: */
034: public final class JDBCDynamicQLQueryMetaData implements
035: JDBCQueryMetaData {
036: /**
037: * The method to which this query is bound.
038: */
039: private final Method method;
040:
041: /**
042: * Should the query return Local or Remote beans.
043: */
044: private final boolean resultTypeMappingLocal;
045:
046: private final JDBCReadAheadMetaData readAhead;
047:
048: private final Class compiler;
049:
050: private final boolean lazyResultSetLoading;
051:
052: /**
053: * Constructs a JDBCDynamicQLQueryMetaData with DynamicQL declared in the
054: * jboss-ql elemnt and is invoked by the specified method.
055: *
056: * @param defaults the metadata about this query
057: */
058: public JDBCDynamicQLQueryMetaData(
059: JDBCDynamicQLQueryMetaData defaults,
060: JDBCReadAheadMetaData readAhead, Class qlCompiler,
061: boolean lazyResultSetLoading) throws DeploymentException {
062: this .method = defaults.getMethod();
063: this .readAhead = readAhead;
064: this .resultTypeMappingLocal = defaults
065: .isResultTypeMappingLocal();
066: compiler = qlCompiler;
067: this .lazyResultSetLoading = lazyResultSetLoading;
068: }
069:
070: /**
071: * Constructs a JDBCDynamicQLQueryMetaData with DynamicQL declared in the
072: * jboss-ql elemnt and is invoked by the specified method.
073: */
074: public JDBCDynamicQLQueryMetaData(boolean resultTypeMappingLocal,
075: Method method, JDBCReadAheadMetaData readAhead,
076: Class compiler, boolean lazyResultSetLoading)
077: throws DeploymentException {
078:
079: this .method = method;
080: this .readAhead = readAhead;
081: this .resultTypeMappingLocal = resultTypeMappingLocal;
082:
083: Class[] parameterTypes = method.getParameterTypes();
084: if (parameterTypes.length != 2
085: || !parameterTypes[0].equals(String.class)
086: || !parameterTypes[1].equals(Object[].class)) {
087: throw new DeploymentException(
088: "Dynamic-ql method must have two "
089: + "parameters of type String and Object[].");
090: }
091:
092: this .compiler = compiler;
093: this .lazyResultSetLoading = lazyResultSetLoading;
094: }
095:
096: // javadoc in parent class
097: public Method getMethod() {
098: return method;
099: }
100:
101: // javadoc in parent class
102: public boolean isResultTypeMappingLocal() {
103: return resultTypeMappingLocal;
104: }
105:
106: /**
107: * Gets the read ahead metadata for the query.
108: *
109: * @return the read ahead metadata for the query.
110: */
111: public JDBCReadAheadMetaData getReadAhead() {
112: return readAhead;
113: }
114:
115: public Class getQLCompilerClass() {
116: return compiler;
117: }
118:
119: public boolean isLazyResultSetLoading() {
120: return lazyResultSetLoading;
121: }
122:
123: /**
124: * Compares this JDBCDynamicQLQueryMetaData against the specified object.
125: * Returns true if the objects are the same. Two JDBCDynamicQLQueryMetaData
126: * are the same if they are both invoked by the same method.
127: *
128: * @param o the reference object with which to compare
129: * @return true if this object is the same as the object argument;
130: * false otherwise
131: */
132: public boolean equals(Object o) {
133: if (o instanceof JDBCDynamicQLQueryMetaData) {
134: return ((JDBCDynamicQLQueryMetaData) o).method
135: .equals(method);
136: }
137: return false;
138: }
139:
140: /**
141: * Returns a hashcode for this JDBCDynamicQLQueryMetaData. The hashcode is
142: * computed by the method which invokes this query.
143: *
144: * @return a hash code value for this object
145: */
146: public int hashCode() {
147: return method.hashCode();
148: }
149:
150: /**
151: * Returns a string describing this JDBCDynamicQLQueryMetaData. The exact
152: * details of the representation are unspecified and subject to change, but
153: * the following may be regarded as typical:
154: * <p/>
155: * "[JDBCDynamicQLQueryMetaData: method=public org.foo.User
156: * findByName(java.lang.String)]"
157: *
158: * @return a string representation of the object
159: */
160: public String toString() {
161: return "[JDBCDynamicQLQueryMetaData : method=" + method + "]";
162: }
163: }
|