org.apache.openjpa.jdbc.meta
Class QueryResultMapping

java.lang.Object
  extended by org.apache.openjpa.jdbc.meta.QueryResultMapping
All Implemented Interfaces:
org.apache.openjpa.lib.meta.SourceTracker, org.apache.openjpa.lib.xml.Commentable, org.apache.openjpa.meta.MetaDataModes

public class QueryResultMapping
extends java.lang.Object
implements org.apache.openjpa.meta.MetaDataModes, org.apache.openjpa.lib.meta.SourceTracker, org.apache.openjpa.lib.xml.Commentable

Mapping of a query result set to scalar and/or persistence-capable object-level values.

Author:
Pinaki Poddar, Abe White

Nested Class Summary
 class QueryResultMapping.PCResult
          A persistence-capable result.
 
Field Summary
 
Fields inherited from interface org.apache.openjpa.meta.MetaDataModes
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
 
Method Summary
 void addColumnResult(java.lang.Object id)
          Add the id of a mapped column in the query result.
 QueryResultMapping.PCResult addPCResult(java.lang.Class candidate)
          Add a mapped persistence-capable result with the given candidate type.
 java.lang.Object[] getColumnResults()
          Ids of mapped scalar columns in the result.
 java.lang.String[] getComments()
           
 java.lang.Class getDefiningType()
          The class that defines this query result, or null if none.
 int getListingIndex()
          Relative order of result mapping in metadata.
 java.lang.String getName()
          Return the name for this query result.
 QueryResultMapping.PCResult[] getPCResults()
          Return the mapped persistence-capable types in the query result.
 java.lang.String getResourceName()
           
 java.io.File getSourceFile()
           
 int getSourceMode()
          The source mode of this query result.
 java.lang.Object getSourceScope()
           
 int getSourceType()
           
 void setComments(java.lang.String[] comments)
           
 void setDefiningType(java.lang.Class cls)
          The class that defines this query result, or null if none.
 void setListingIndex(int idx)
          Relative order of result mapping in metadata.
 void setSource(java.io.File file, java.lang.Object scope, int srcType)
           
 void setSourceMode(int mode)
          The source mode of this query result.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getName

public java.lang.String getName()
Return the name for this query result.


getDefiningType

public java.lang.Class getDefiningType()
The class that defines this query result, or null if none.


setDefiningType

public void setDefiningType(java.lang.Class cls)
The class that defines this query result, or null if none.


getColumnResults

public java.lang.Object[] getColumnResults()
Ids of mapped scalar columns in the result. These will typically be column names.

See Also:
Result

addColumnResult

public void addColumnResult(java.lang.Object id)
Add the id of a mapped column in the query result. This will typically be a column name.

See Also:
Result

getPCResults

public QueryResultMapping.PCResult[] getPCResults()
Return the mapped persistence-capable types in the query result.


addPCResult

public QueryResultMapping.PCResult addPCResult(java.lang.Class candidate)
Add a mapped persistence-capable result with the given candidate type.


getSourceMode

public int getSourceMode()
The source mode of this query result.


setSourceMode

public void setSourceMode(int mode)
The source mode of this query result.


getListingIndex

public int getListingIndex()
Relative order of result mapping in metadata.


setListingIndex

public void setListingIndex(int idx)
Relative order of result mapping in metadata.


toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

getComments

public java.lang.String[] getComments()
Specified by:
getComments in interface org.apache.openjpa.lib.xml.Commentable

setComments

public void setComments(java.lang.String[] comments)
Specified by:
setComments in interface org.apache.openjpa.lib.xml.Commentable

getSourceFile

public java.io.File getSourceFile()
Specified by:
getSourceFile in interface org.apache.openjpa.lib.meta.SourceTracker

getSourceScope

public java.lang.Object getSourceScope()
Specified by:
getSourceScope in interface org.apache.openjpa.lib.meta.SourceTracker

getSourceType

public int getSourceType()
Specified by:
getSourceType in interface org.apache.openjpa.lib.meta.SourceTracker

setSource

public void setSource(java.io.File file,
                      java.lang.Object scope,
                      int srcType)

getResourceName

public java.lang.String getResourceName()
Specified by:
getResourceName in interface org.apache.openjpa.lib.meta.SourceTracker


Copyright © 2006 Apache Software Foundation. All Rights Reserved.