Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS (src)    NEXT CLASS (src) FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.jboss.metadata
Class QueryMetaData

java.lang.Object
  extended byorg.jboss.metadata.MetaData (src) 
      extended byorg.jboss.metadata.QueryMetaData
All Implemented Interfaces:
java.lang.Cloneable, XmlLoadable (src)
public class QueryMetaData
extends MetaData (src)

Contains information about ejb-ql queries.

Field Summary
static java.lang.String LOCAL
           
static java.lang.String REMOTE
           
 
Fields inherited from class org.jboss.metadata.MetaData (src)
log, TX_MANDATORY, TX_NEVER, TX_NOT_SUPPORTED, TX_REQUIRED, TX_REQUIRES_NEW, TX_SUPPORTS, TX_UNKNOWN
 
Constructor Summary
QueryMetaData()
           
 
Method Summary
 java.lang.String getDescription()
          Gets the user description of the query.
 java.lang.String getEjbQl()
          Gets the ejb-ql for this query.
 java.lang.String getMethodName()
          Gets the name of the query for which this metadata applies.
 java.util.Iterator getMethodParams()
          Gets an iterator over the parameters of the query method.
 java.lang.String getResultTypeMapping()
          Gets the interface type of returned ejb objects.
 void importEjbJarXml(org.w3c.dom.Element element)
          Loads the data from the query xml element.
 
Methods inherited from class org.jboss.metadata.MetaData (src)
clone, getChildrenByTagName, getElementAttribute, getElementContent, getElementContent, getFirstElementContent, getOptionalChild, getOptionalChild, getOptionalChildBooleanContent, getOptionalChildBooleanContent, getOptionalChildContent, getOptionalChildContent, getUniqueChild, getUniqueChildContent, importJbossXml, importXml, jdk13Enabled
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

REMOTE

public static final java.lang.String REMOTE
See Also:
Constant Field Values (src)

LOCAL

public static final java.lang.String LOCAL
See Also:
Constant Field Values (src)
Constructor Detail

QueryMetaData

public QueryMetaData()
Method Detail

getDescription

public java.lang.String getDescription()
Gets the user description of the query.

Returns:
the users description of the query

getMethodName

public java.lang.String getMethodName()
Gets the name of the query for which this metadata applies.

Returns:
the name of the query method

getMethodParams

public java.util.Iterator getMethodParams()
Gets an iterator over the parameters of the query method.

Returns:
an iterator over the parameters of the query method.

getResultTypeMapping

public java.lang.String getResultTypeMapping()
Gets the interface type of returned ejb objects. This will be Local or Remote, and the default is Local.

Returns:
the type the the interface returned for ejb objects

getEjbQl

public java.lang.String getEjbQl()
Gets the ejb-ql for this query.

Returns:
the ejb-ql for this query

importEjbJarXml

public void importEjbJarXml(org.w3c.dom.Element element)
                     throws DeploymentException (src)
Loads the data from the query xml element.

Overrides:
importEjbJarXml in class MetaData (src)
Parameters:
element - the query xml element from the ejb-jar.xml file
Throws:
DeploymentException (src) - if the query element is malformed
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS (src)    NEXT CLASS (src) FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD