Package org.intermine.model

Interface InterMineObject

All Superinterfaces:

FastPathObject, InterMineFastPathObject

All Known Implementing Classes:

Item, PermanentToken, ProxyReference, SavedBag, SavedQuery, SavedTemplateQuery, Tag, TemplateSummary, UserProfile

public interface InterMineObject
extends InterMineFastPathObject

A root interface for all objects that can be stored in a InterMine database.

Author:

Matthew Wakeling, Andrew Varley

Method Summary

Modifier and Type	Method	Description
java.lang.Class<?>	getElementType(java.lang.String fieldName)	Returns the element type of a collection by name.
java.lang.Integer	getId()	Getter for the ID field - ensures that every object in the database has an ID.
StringConstructor	getoBJECT()	Returns the NotXml serialised version of this object.
void	setId(java.lang.Integer id)	Setter for the ID field.
void	setoBJECT(java.lang.String[] notXml, ObjectStore os)	Sets the values of the fields to the values in the given split NotXml.
void	setoBJECT(java.lang.String notXml, ObjectStore os)	Sets the values of the fields to the values in the given NotXml.

Methods inherited from interface org.intermine.model.FastPathObject

getFieldProxy, getFieldType, getFieldValue, setFieldValue

Method Detail

getId

java.lang.Integer getId()

Getter for the ID field - ensures that every object in the database has an ID.

Specified by:

getId in interface InterMineFastPathObject

Returns:

an Integer

setId

void setId(java.lang.Integer id)

Setter for the ID field.

Specified by:

setId in interface InterMineFastPathObject

Parameters:

id - an Integer

getoBJECT

StringConstructor getoBJECT()

Returns the NotXml serialised version of this object.

Specified by:

getoBJECT in interface InterMineFastPathObject

Returns:

a StringConstructor containing the NotXml

setoBJECT

void setoBJECT(java.lang.String notXml,
               ObjectStore os)

Sets the values of the fields to the values in the given NotXml.

Parameters:

notXml - a String containing NotXml for this class

os - an ObjectStore from which to create proxies

setoBJECT

void setoBJECT(java.lang.String[] notXml,
               ObjectStore os)

Sets the values of the fields to the values in the given split NotXml.

Parameters:

notXml - a String array containing the NotXml split with the delimiter

os - an ObjectStore from which to create proxies

getElementType

java.lang.Class<?> getElementType(java.lang.String fieldName)

Returns the element type of a collection by name.

Specified by:

getElementType in interface InterMineFastPathObject

Parameters:

fieldName - the name of the collection

Returns:

the type of the elements of the collection