/*
* JBoss, Home of Professional Open Source.
* Copyright 2008, Red Hat Middleware LLC, and individual contributors
* as indicated by the @author tags. See the copyright.txt file in the
* distribution for a full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.jboss.ejb.plugins.cmp.jdbc.metadata;
import java.lang.reflect.Method;
import org.w3c.dom.Element;
import org.jboss.deployment.DeploymentException;
import org.jboss.metadata.MetaData;
/**
* Immutable class which contains information about an JBossQL query.
*
* @author <a href="mailto:dain@daingroup.com">Dain Sundstrom</a>
* @version $Revision: 81030 $
*/
public final class JDBCJBossQLQueryMetaData implements JDBCQueryMetaData
{
/**
* The method to which this query is bound.
*/
private final Method method;
/**
* The ejb-ql fro the query.
*/
private final String jbossQL;
/**
* Should the query return Local or Remote beans.
*/
private final boolean resultTypeMappingLocal;
/**
* Read ahead meta data.
*/
private final JDBCReadAheadMetaData readAhead;
private final Class compiler;
private final boolean lazyResultSetLoading;
/**
* Constructs a JDBCJBossQLQueryMetaData with JBossQL declared in the
* jboss-ql elemnt and is invoked by the specified method.
*/
public JDBCJBossQLQueryMetaData(JDBCJBossQLQueryMetaData defaults,
JDBCReadAheadMetaData readAhead,
Class qlCompiler,
boolean lazyResultSetLoading)
throws DeploymentException
{
this.method = defaults.getMethod();
this.readAhead = readAhead;
this.jbossQL = defaults.getJBossQL();
this.resultTypeMappingLocal = defaults.isResultTypeMappingLocal();
this.compiler = qlCompiler;
this.lazyResultSetLoading = lazyResultSetLoading;
}
/**
* Constructs a JDBCJBossQLQueryMetaData with JBossQL declared in the
* jboss-ql elemnt and is invoked by the specified method.
*/
public JDBCJBossQLQueryMetaData(boolean resultTypeMappingLocal,
Element element,
Method method,
JDBCReadAheadMetaData readAhead,
Class compiler,
boolean lazyResultSetLoading)
throws DeploymentException
{
this.method = method;
this.readAhead = readAhead;
jbossQL = MetaData.getElementContent(element);
if(jbossQL == null || jbossQL.trim().length() == 0)
{
throw new DeploymentException("jboss-ql element is empty");
}
this.resultTypeMappingLocal = resultTypeMappingLocal;
this.compiler = compiler;
this.lazyResultSetLoading = lazyResultSetLoading;
}
// javadoc in parent class
public Method getMethod()
{
return method;
}
public Class getQLCompilerClass()
{
return compiler;
}
/**
* Gets the JBossQL query which will be invoked.
*
* @return the ejb ql String for this query
*/
public String getJBossQL()
{
return jbossQL;
}
// javadoc in parent class
public boolean isResultTypeMappingLocal()
{
return resultTypeMappingLocal;
}
/**
* Gets the read ahead metadata for the query.
*
* @return the read ahead metadata for the query.
*/
public JDBCReadAheadMetaData getReadAhead()
{
return readAhead;
}
public boolean isLazyResultSetLoading()
{
return lazyResultSetLoading;
}
/**
* Compares this JDBCJBossQLQueryMetaData against the specified object.
* Returns true if the objects are the same. Two JDBCJBossQLQueryMetaData
* are the same if they are both invoked by the same method.
*
* @param o the reference object with which to compare
* @return true if this object is the same as the object argument;
* false otherwise
*/
public boolean equals(Object o)
{
if(o instanceof JDBCJBossQLQueryMetaData)
{
return ((JDBCJBossQLQueryMetaData) o).method.equals(method);
}
return false;
}
/**
* Returns a hashcode for this JDBCJBossQLQueryMetaData. The hashcode is
* computed by the method which invokes this query.
*
* @return a hash code value for this object
*/
public int hashCode()
{
return method.hashCode();
}
/**
* Returns a string describing this JDBCJBossQLQueryMetaData. The exact
* details of the representation are unspecified and subject to change, but
* the following may be regarded as typical:
* <p/>
* "[JDBCJBossQLQueryMetaData: method=public org.foo.User
* findByName(java.lang.String)]"
*
* @return a string representation of the object
*/
public String toString()
{
return "[JDBCJBossQLQueryMetaData : method=" + method + "]";
}
}