Class GeneSetValueObject

java.lang.Object

ubic.gemma.model.common.IdentifiableValueObject<GeneSet>

ubic.gemma.model.genome.gene.GeneSetValueObject

All Implemented Interfaces:

Serializable, Securable, SecureValueObject, Identifiable

Direct Known Subclasses:

DatabaseBackedGeneSetValueObject, SessionBoundGeneSetValueObject

public class GeneSetValueObject
extends IdentifiableValueObject<GeneSet>
implements SecureValueObject

Represents a Gene group gene set

Author:

kelsey

See Also:

• Serialized Form

Field Summary

Fields inherited from class IdentifiableValueObject

id

Constructor Summary

Constructors

Constructor	Description
GeneSetValueObject()	default constructor to satisfy java bean contract
GeneSetValueObject(Long id)	Create a lightweight wrapper that can be used for security filtering
GeneSetValueObject(GeneSet geneSet, Taxon taxon, Long size)

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
boolean	getCurrentUserIsOwner()
String	getDescription()
Collection<Long>	getGeneIds()	Gene IDs part of this gene set.
boolean	getIsPublic()	Indicate if the object is public.
boolean	getIsShared()	Indicate if the object is shared.
String	getName()
Class<? extends Securable>	getSecurableClass()
Long	getSize()
TaxonValueObject	getTaxon()
Long	getTaxonId()
String	getTaxonName()
boolean	getUserCanWrite()	Indicate if the current user can modify this object.
boolean	getUserOwned()	Indicate if the current user owns the object.
int	hashCode()
void	setDescription(String description)
void	setGeneIds(Collection<Long> geneIds)	Gene IDs part of this gene set.
void	setIsPublic(boolean isPublic)
void	setIsShared(boolean isShared)
void	setName(String name)
void	setSize(long size)
void	setTaxon(TaxonValueObject taxon)
void	setUserCanWrite(boolean userCanWrite)
void	setUserOwned(boolean userOwned)
String	toString()

Methods inherited from class IdentifiableValueObject

getId, setId

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Securable

getId

Constructor Details

GeneSetValueObject

public GeneSetValueObject()

default constructor to satisfy java bean contract

GeneSetValueObject

public GeneSetValueObject(Long id)

Create a lightweight wrapper that can be used for security filtering

Parameters:

id - id

GeneSetValueObject

public GeneSetValueObject(GeneSet geneSet,
 @Nullable
 Taxon taxon,
 @Nullable
 Long size)

Method Details

getTaxonId

public Long getTaxonId()

getTaxonName

public String getTaxonName()

getSize

public Long getSize()

Returns:

the number of members in the group

setSize

public void setSize(long size)

getCurrentUserIsOwner

public boolean getCurrentUserIsOwner()

getUserOwned

public boolean getUserOwned()

Description copied from interface: SecureValueObject

Indicate if the current user owns the object.

Specified by:

getUserOwned in interface SecureValueObject

getUserCanWrite

public boolean getUserCanWrite()

Description copied from interface: SecureValueObject

Indicate if the current user can modify this object.

Specified by:

getUserCanWrite in interface SecureValueObject

setUserCanWrite

public void setUserCanWrite(boolean userCanWrite)

Specified by:

setUserCanWrite in interface SecureValueObject

getIsPublic

public boolean getIsPublic()

Description copied from interface: SecureValueObject

Indicate if the object is public.

Specified by:

getIsPublic in interface SecureValueObject

setIsPublic

public void setIsPublic(boolean isPublic)

Specified by:

setIsPublic in interface SecureValueObject

getIsShared

public boolean getIsShared()

Description copied from interface: SecureValueObject

Indicate if the object is shared.

Specified by:

getIsShared in interface SecureValueObject

setIsShared

public void setIsShared(boolean isShared)

Specified by:

setIsShared in interface SecureValueObject

getSecurableClass

public Class<? extends Securable> getSecurableClass()

Specified by:

getSecurableClass in interface SecureValueObject

Returns:

the securable Class of the represented entity.

toString

public String toString()

Overrides:

toString in class IdentifiableValueObject<GeneSet>

getName

public String getName()

getDescription

public String getDescription()

getGeneIds

@Nullable
public Collection<Long> getGeneIds()

Gene IDs part of this gene set.

getTaxon

@Nullable
public TaxonValueObject getTaxon()

setName

public void setName(String name)

setDescription

public void setDescription(String description)

setGeneIds

public void setGeneIds(@Nullable
 Collection<Long> geneIds)

Gene IDs part of this gene set.

setTaxon

public void setTaxon(@Nullable
 TaxonValueObject taxon)

setUserOwned

public void setUserOwned(boolean userOwned)

Specified by:

setUserOwned in interface SecureValueObject

equals

public boolean equals(Object o)

Overrides:

equals in class IdentifiableValueObject<GeneSet>

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class IdentifiableValueObject<GeneSet>

hashCode

public int hashCode()

Overrides:

hashCode in class IdentifiableValueObject<GeneSet>