Package org.intermine.objectstore.query

Class QueryCollectionReference

java.lang.Object

org.intermine.objectstore.query.QueryReference

org.intermine.objectstore.query.QueryCollectionReference

public class QueryCollectionReference
extends QueryReference

Represents a field of a QueryClass that is a collection

Author:

Mark Woodbridge, Richard Smith, Matthew Wakeling

Field Summary

Fields

Modifier and Type	Field	Description
protected QueryClassBag	qcb
protected InterMineObject	qcObj

Fields inherited from class org.intermine.objectstore.query.QueryReference

fieldName, qc, type

Constructor Summary

Constructors

Constructor	Description
QueryCollectionReference(InterMineObject qcObj, java.lang.String fieldName)	Constructs a QueryCollectionReference representing the specified field of an object
QueryCollectionReference(QueryClassBag qcb, java.lang.String fieldName)	Constructs a QueryCollectionReference representing the specified field of a QueryClassBag
QueryCollectionReference(QueryClass qc, java.lang.String fieldName)	Constructs a QueryCollectionReference representing the specified field of a QueryClass

Method Summary

Modifier and Type	Method	Description
QueryClassBag	getQcb()	Gets the QueryClassBag of this QueryReference.
InterMineObject	getQcObject()	Gets the InterMineObject of this QueryReference.
java.lang.Class<? extends FastPathObject>	getQcType()	Returns the type of the queryclass of this reference
java.lang.Class<? extends java.util.Collection<?>>	getType()	Gets the Java class of this QueryReference.

Methods inherited from class org.intermine.objectstore.query.QueryReference

getFieldName, getQueryClass

Methods inherited from class java.lang.Object

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

Field Detail

qcObj

protected InterMineObject qcObj

qcb

protected QueryClassBag qcb

Constructor Detail

QueryCollectionReference

public QueryCollectionReference(QueryClass qc,
                                java.lang.String fieldName)

Constructs a QueryCollectionReference representing the specified field of a QueryClass

Parameters:

qc - the QueryClass

fieldName - the name of the relevant field

Throws:

java.lang.NullPointerException - if the field name is null

java.lang.IllegalArgumentException - if the field is not a collection or does not exist

QueryCollectionReference

public QueryCollectionReference(QueryClassBag qcb,
                                java.lang.String fieldName)

Constructs a QueryCollectionReference representing the specified field of a QueryClassBag

Parameters:

qcb - the QueryClassBag

fieldName - the name of the relevant field

Throws:

java.lang.NullPointerException - if the field name is null

java.lang.IllegalArgumentException - if the field is not a collection or does not exist

QueryCollectionReference

public QueryCollectionReference(InterMineObject qcObj,
                                java.lang.String fieldName)

Constructs a QueryCollectionReference representing the specified field of an object

Parameters:

qcObj - the InterMineObject

fieldName - the name of the relevant field

Throws:

java.lang.NullPointerException - if the field name is null

java.lang.IllegalArgumentException - if the field is not a collection or does not exist

Method Detail

getType

public java.lang.Class<? extends java.util.Collection<?>> getType()

Gets the Java class of this QueryReference.

Overrides:

getType in class QueryReference

Returns:

the class name

getQcObject

public InterMineObject getQcObject()

Gets the InterMineObject of this QueryReference.

Returns:

an InterMineObject

getQcb

public QueryClassBag getQcb()

Gets the QueryClassBag of this QueryReference.

Returns:

a QueryClassBag

getQcType

public java.lang.Class<? extends FastPathObject> getQcType()

Returns the type of the queryclass of this reference

Overrides:

getQcType in class QueryReference

Returns:

a Class