|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.openjpa.meta.QueryMetaData
public class QueryMetaData
Holds metadata about named queries.
Information stored in this instance gets transfered to
new Query
instances.
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 |
Constructor Summary | |
---|---|
protected |
QueryMetaData(java.lang.String name)
Construct with the given name. |
Method Summary | |
---|---|
void |
addHint(java.lang.String key,
java.lang.Object value)
Add a query hint. |
java.lang.Class |
getCandidateType()
The query candidate class, or null if none. |
java.lang.String[] |
getComments()
|
java.lang.Class |
getDefiningType()
The class that defines this query, or null if none. |
java.lang.String[] |
getHintKeys()
Query hints. |
java.lang.Object[] |
getHintValues()
Query hints. |
java.lang.String |
getLanguage()
Return the query language. |
java.lang.String |
getName()
Return the name for this query. |
java.lang.String |
getQueryString()
The full query string, or null if none. |
java.lang.String |
getResourceName()
|
java.lang.Class |
getResultType()
The query result class, or null if none. |
java.io.File |
getSourceFile()
|
int |
getSourceMode()
The source mode of this query. |
java.lang.Object |
getSourceScope()
|
int |
getSourceType()
|
boolean |
isReadOnly()
Whether the query has been marked read-only. |
void |
setCandidateType(java.lang.Class cls)
The query result class, or null if none. |
void |
setComments(java.lang.String[] comments)
|
void |
setDefiningType(java.lang.Class cls)
The class that defines this query, or null if none. |
void |
setFrom(Query query)
Initialize this instance from the values held in the specified Query . |
void |
setInto(Query query)
Set query template information into the given concrete query instance. |
void |
setLanguage(java.lang.String language)
Set the language for this query. |
void |
setQueryString(java.lang.String query)
The full query string, or null if none. |
void |
setReadOnly(boolean readOnly)
Whether the query has been marked read-only. |
void |
setResultType(java.lang.Class cls)
The query result class, or null if none. |
void |
setSource(java.io.File file,
java.lang.Object scope,
int srcType)
|
void |
setSourceMode(int mode)
The source mode of this query. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
protected QueryMetaData(java.lang.String name)
Method Detail |
---|
public java.lang.String getName()
public java.lang.Class getDefiningType()
public void setDefiningType(java.lang.Class cls)
public boolean isReadOnly()
public void setReadOnly(boolean readOnly)
public java.lang.Class getCandidateType()
public void setCandidateType(java.lang.Class cls)
public java.lang.Class getResultType()
public void setResultType(java.lang.Class cls)
public java.lang.String getLanguage()
public void setLanguage(java.lang.String language)
public java.lang.String getQueryString()
public void setQueryString(java.lang.String query)
public java.lang.String[] getHintKeys()
public java.lang.Object[] getHintValues()
public void addHint(java.lang.String key, java.lang.Object value)
public void setInto(Query query)
public void setFrom(Query query)
Query
.
public int getSourceMode()
public void setSourceMode(int mode)
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String[] getComments()
getComments
in interface org.apache.openjpa.lib.xml.Commentable
public void setComments(java.lang.String[] comments)
setComments
in interface org.apache.openjpa.lib.xml.Commentable
public java.io.File getSourceFile()
getSourceFile
in interface org.apache.openjpa.lib.meta.SourceTracker
public java.lang.Object getSourceScope()
getSourceScope
in interface org.apache.openjpa.lib.meta.SourceTracker
public int getSourceType()
getSourceType
in interface org.apache.openjpa.lib.meta.SourceTracker
public void setSource(java.io.File file, java.lang.Object scope, int srcType)
public java.lang.String getResourceName()
getResourceName
in interface org.apache.openjpa.lib.meta.SourceTracker
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |