org.apache.openjpa.meta

Class MultiQueryMetaData

java.lang.Object

org.apache.openjpa.meta.QueryMetaData

org.apache.openjpa.meta.MultiQueryMetaData

All Implemented Interfaces:

Serializable, SourceTracker, Commentable, MetaDataModes

public class MultiQueryMetaData
extends QueryMetaData

Extends QueryMetaData to allow multiple result class or mapping names.
Designed for mapping the results from a Stored Procudure that can produce more than one ResultSet, each being mapped with a different mapping specification.

Author:

Pinaki Poddar

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MultiQueryMetaData.Parameter A parameter

Field Summary

Fields inherited from interface org.apache.openjpa.meta.MetaDataModes

MODE_ALL, MODE_ANN_MAPPING, MODE_MAPPING, MODE_MAPPING_INIT, MODE_META, MODE_NONE, MODE_QUERY

Fields inherited from interface org.apache.openjpa.lib.meta.SourceTracker

SRC_ANNOTATIONS, SRC_OTHER, SRC_XML

Fields inherited from interface org.apache.openjpa.lib.xml.Commentable

EMPTY_COMMENTS

Constructor Summary

Constructors

Constructor and Description
MultiQueryMetaData(Class<?> scope, String logicalName, String procedureName, boolean isTemporary) Create this meta data given a scope of definition, a logical identifier, a procedure name and whether its usage is temporary.

Method Summary

Modifier and Type	Method and Description
void	addComponent(Class<?> resultClass)
void	addComponent(String mappingName)
QueryMetaData	getComponent(int i) Gets the component metadata at the given part index.
int	getComponentCount() Gets the number of component metadata contained in this metada.
List<QueryMetaData>	getComponents()
int	getParameterCount()
List<MultiQueryMetaData.Parameter>	getParameters()
String	getProcedureName()
boolean	isEphimeral() Affirms if this metadata is ephimeral.
void	registerParameter(MultiQueryMetaData.Parameter p) Registers the given parameter.
void	setResultSetMappingName(String name)
void	setResultType(Class cls) The query result class, or null if none.

Methods inherited from class org.apache.openjpa.meta.QueryMetaData

addHint, getCandidateType, getColNumber, getComments, getDefiningType, getHintKeys, getHintValues, getLanguage, getLineNumber, getName, getParamTypes, getQueryString, getResourceName, getResultSetMappingName, getResultType, getSourceFile, getSourceMode, getSourceName, getSourceScope, getSourceType, isReadOnly, setCandidateType, setColNumber, setComments, setDefiningType, setFrom, setInto, setLanguage, setLineNumber, setParamTypes, setQueryString, setReadOnly, setSource, setSourceMode, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MultiQueryMetaData

public MultiQueryMetaData(Class<?> scope,
                          String logicalName,
                          String procedureName,
                          boolean isTemporary)

Create this meta data given a scope of definition, a logical identifier, a procedure name and whether its usage is temporary.

Parameters:

scope - defining scope

logicalName - name as an identifier

procedureName - name of the database procedure

Method Detail

getProcedureName

public String getProcedureName()

getComponents

public List<QueryMetaData> getComponents()

isEphimeral

public boolean isEphimeral()

Affirms if this metadata is ephimeral. Ephimenral metadata is removed from the repository after usage.

Returns:

setResultSetMappingName

public void setResultSetMappingName(String name)

Overrides:

setResultSetMappingName in class QueryMetaData

setResultType

public void setResultType(Class cls)

Description copied from class: QueryMetaData

The query result class, or null if none.

Overrides:

setResultType in class QueryMetaData

addComponent

public void addComponent(Class<?> resultClass)

addComponent

public void addComponent(String mappingName)

getComponent

public QueryMetaData getComponent(int i)

Gets the component metadata at the given part index.

Parameters:

i - a valid integer index

Returns:

getComponentCount

public int getComponentCount()

Gets the number of component metadata contained in this metada.

registerParameter

public void registerParameter(MultiQueryMetaData.Parameter p)

Registers the given parameter.

Parameters:

p -

getParameters

public List<MultiQueryMetaData.Parameter> getParameters()

getParameterCount

public int getParameterCount()