org.jbei.ice.lib.entry

Class EntryLinks

java.lang.Object

org.jbei.ice.lib.entry.HasEntry

org.jbei.ice.lib.entry.EntryLinks

public class EntryLinks
extends HasEntry

Represents a main part and the hierarchical links that it is involved in. The specified user must have read privileges on the main part. Some of the actions/methods in this class require write privileges

Author:

Hector Plahar

Field Summary

Fields inherited from class org.jbei.ice.lib.entry.HasEntry

accountDAO, entryDAO

Constructor Summary

Constructors

Constructor and Description
EntryLinks(String userId, String partId)

Method Summary

Modifier and Type	Method and Description
protected boolean	addChildEntry(Entry child) Adds specified entry as a child of the entry associated with this
boolean	addLink(PartData partData, LinkType type) Adds a link for the specified entry (or creates a new entry) of the type specified
protected boolean	addParentEntry(Entry parent)
List<PartData>	get(LinkType type) Retrieves entry links that are parents or children depending on specified type
List<PartData>	getChildren() Retrieves the list of children this entry, that the user has read permissions
List<PartData>	getParents() Retrieves list of this entry's parents that user has read access to
boolean	removeLink(long partToRemove, LinkType linkType) Removes link specified entry id based on the specified type

Methods inherited from class org.jbei.ice.lib.entry.HasEntry

getEntry

Methods inherited from class java.lang.Object

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

Constructor Detail

EntryLinks

public EntryLinks(String userId,
                  String partId)

Method Detail

addLink

public boolean addLink(PartData partData,
                       LinkType type)

Adds a link for the specified entry (or creates a new entry) of the type specified

Parameters:

partData - data for entry to be linked. If the id does not point to an existing entry, a new one will be created and linked to this entry

type - type of link to create. If CHILD (default) is specified, then the entry in the parameter is added as a child in the hierarchy; if PARENT is specified, then the entry is add as a parent in the hierarchy.

Returns:

true, if the two entries are successfully linked. false, if the specified hierarchy is not compatible with the types of the link specified e.g. an plasmid cannot be added as a PARENT of a strain

Throws:

PermissionException - if the user does not have write permissions on at least one of the entries being linked

removeLink

public boolean removeLink(long partToRemove,
                          LinkType linkType)

Removes link specified entry id based on the specified type

Parameters:

partToRemove - unique identifier for part to remove

linkType - type of relationship that exists

Returns:

true, if entry is removed successfully.

addChildEntry

protected boolean addChildEntry(Entry child)

Adds specified entry as a child of the entry associated with this

Parameters:

child - entry to be added as the child entry

Returns:

true if added successfully, false otherwise

addParentEntry

protected boolean addParentEntry(Entry parent)

getChildren

public List<PartData> getChildren()

Retrieves the list of children this entry, that the user has read permissions

Returns:

list of retrieved entries

getParents

public List<PartData> getParents()

Retrieves list of this entry's parents that user has read access to

Returns:

list of parents of entry

get

public List<PartData> get(LinkType type)

Retrieves entry links that are parents or children depending on specified type

Parameters:

type - specified type of links to return

Returns:

list of links that match specified type. These are filtered based on user permissions