Package org.apache.cayenne.query
Class RelationshipQuery
java.lang.Object
org.apache.cayenne.query.IndirectQuery
org.apache.cayenne.query.RelationshipQuery
- All Implemented Interfaces:
- Serializable,- Query
public class RelationshipQuery extends IndirectQuery
A query that selects objects related to a given object via a mapped relationship.
 RelationshipQuery is used by Cayenne internally to resolve relationships, and is rarely
 executed by the application directly, although this of course is possible too.
- Since:
- 1.2
- See Also:
- Serialized Form
- 
Field SummaryFields Modifier and Type Field Description protected ArcPropertyarcprotected QueryMetadatametadataprotected EntityResolvermetadataResolverprotected ObjectIdobjectIdprotected booleanrefreshingprotected StringrelationshipNameprotected intstatementFetchSizeFields inherited from class org.apache.cayenne.query.IndirectQuerydataMap, lastResolver, name, replacementQuery
- 
Constructor SummaryConstructors Constructor Description RelationshipQuery(ObjectId objectID, String relationshipName)Creates a RelationshipQuery.RelationshipQuery(ObjectId objectID, String relationshipName, boolean refreshing)Creates a RelationshipQuery.
- 
Method SummaryModifier and Type Method Description protected QuerycreateReplacementQuery(EntityResolver resolver)Creates a substitute query.QueryMetadatagetMetaData(EntityResolver resolver)Returns query metadata object.ObjectIdgetObjectId()ObjRelationshipgetRelationship(EntityResolver resolver)Returns a non-null relationship object for this query.StringgetRelationshipName()intgetStatementFetchSize()booleanisRefreshing()voidsetStatementFetchSize(int size)Sets statement's fetch size (0 for no default size)StringtoString()Overrides toString() outputting a short string with query class and relationship name.Methods inherited from class org.apache.cayenne.query.IndirectQuerycreateSQLAction, getReplacementQuery, route
- 
Field Details- 
objectId
- 
relationshipName
- 
refreshingprotected boolean refreshing
- 
statementFetchSizeprotected int statementFetchSize
- 
metadataResolver
- 
metadata
- 
arc
 
- 
- 
Constructor Details- 
RelationshipQueryCreates a RelationshipQuery. Same as new RelationshipQuery(objectID, relationshipName, true).- Parameters:
- objectID- ObjectId of a root object of the relationship.
- relationshipName- The name of the relationship.
 
- 
RelationshipQueryCreates a RelationshipQuery.- Parameters:
- objectID- ObjectId of a root object of the relationship.
- relationshipName- The name of the relationship.
- refreshing- whether objects should be refreshed
 
 
- 
- 
Method Details- 
getMetaDataReturns query metadata object.- Specified by:
- getMetaDatain interface- Query
- Overrides:
- getMetaDatain class- IndirectQuery
 
- 
getObjectId
- 
isRefreshingpublic boolean isRefreshing()
- 
getRelationshipName
- 
createReplacementQueryDescription copied from class:IndirectQueryCreates a substitute query. An implementor is free to provide an arbitrary replacement query.- Specified by:
- createReplacementQueryin class- IndirectQuery
 
- 
getRelationshipReturns a non-null relationship object for this query.
- 
setStatementFetchSizepublic void setStatementFetchSize(int size)Sets statement's fetch size (0 for no default size)- Since:
- 3.0
 
- 
getStatementFetchSizepublic int getStatementFetchSize()- Returns:
- statement's fetch size
- Since:
- 3.0
 
- 
toStringOverrides toString() outputting a short string with query class and relationship name.
 
-