Module omix.api

Package omix.plugin.diagram

Interface AbstractModelItem

All Superinterfaces:

AbstractItem, ReadOnlyInterface

All Known Subinterfaces:

AbstractBioNodeItem, AbstractBioNodeItem, AbstractEdgeItem, AbstractEdgeItem, AbstractModelItem, AbstractNodeItem, AbstractNodeItem, CompartmentItem, CompartmentItem, EffectorEdgeItem, EffectorEdgeItem, FluxEdgeItem, FluxEdgeItem, GraphicsBoxItem, GraphicsBoxItem, GraphicsEdgeItem, GraphicsEdgeItem, GraphicsNodeItem, GraphicsNodeItem, GraphicsPathItem, GraphicsPathItem, LinkEdgeItem, LinkEdgeItem, LinkItem, LinkItem, MetaboliteItem, MetaboliteItem, PathwayItem, PathwayItem, ReactionItem, ReactionItem

public interface AbstractModelItem
extends AbstractItem

Method Summary

Modifier and Type	Method	Description
default AccessoryItem	getAccessoryItem(String accessoryName)	Returns the accessory item of the submitted name defined in the namespace.
default <T extends AccessoryItem> T	getAccessoryItem(String accessoryName, Class<T> accessoryItemClass)
AccessoryItem	getAccessoryItem(String namespace, String accessoryName)	Returns the accessory item of the submitted name defined in the namespace.
default <T extends AccessoryItem> T	getAccessoryItem(String namespace, String accessoryName, Class<T> accessoryItemClass)
List<? extends AccessoryItem>	getAccessoryItems()	Returns all accessory items defined in the document embedded OVL script.
List<? extends AccessoryItem>	getAccessoryItems(String namespace)	Returns all accessory items defined in the given namespace.
List<? extends AccessoryItem>	getAllAccessoryItems()	Returns all accessory items defined in the document embedded OVL script and all namespaces.
Field	getField(String fieldName)	Returns the field of the submitted network object defined in the document embedded OVL script.
Field	getField(String namespace, String fieldName)	Returns the field of the submitted network object defined in the give namespace.
AbstractModelComponent	modelComponent()

Methods inherited from interface omix.plugin.diagram.AbstractItem

addChangeListener, addPropertyChangeListener, diagram, getIdentifier, removeChangeListener, removePropertyChangeListener

Method Details

modelComponent

AbstractModelComponent modelComponent()

getAccessoryItem

AccessoryItem getAccessoryItem(String namespace, String accessoryName) throws IllegalAccessException, NoSuchFieldException

Returns the accessory item of the submitted name defined in the namespace.

Parameters:

namespace -

accessoryName -

Returns:

accessory item

Throws:

IllegalAccessException - if accessory item is protected

NoSuchFieldException - if accessory item does not exist

getAccessoryItem

default <T extends AccessoryItem> T getAccessoryItem(String namespace, String accessoryName, Class<T> accessoryItemClass) throws IllegalAccessException, NoSuchFieldException

Throws:

IllegalAccessException

NoSuchFieldException

getAccessoryItem

default AccessoryItem getAccessoryItem(String accessoryName) throws IllegalAccessException, NoSuchFieldException

Returns the accessory item of the submitted name defined in the namespace.

Parameters:

accessoryName -

Returns:

accessory item

Throws:

IllegalAccessException - if accessory is protected

NoSuchFieldException - if accessory does not exist

getAccessoryItem

default <T extends AccessoryItem> T getAccessoryItem(String accessoryName, Class<T> accessoryItemClass) throws IllegalAccessException, NoSuchFieldException

Throws:

IllegalAccessException

NoSuchFieldException

getAllAccessoryItems

List<? extends AccessoryItem> getAllAccessoryItems()

Returns all accessory items defined in the document embedded OVL script and all namespaces.

Returns:

unmodifiable list of accessory items

getAccessoryItems

List<? extends AccessoryItem> getAccessoryItems()

Returns all accessory items defined in the document embedded OVL script.

Returns:

unmodifiable list of accessory items

Throws:

IllegalArgumentException - if object is not a network item

getAccessoryItems

List<? extends AccessoryItem> getAccessoryItems(String namespace)

Returns all accessory items defined in the given namespace.

Parameters:

namespace -

Returns:

unmodifiable list of accessory items

Throws:

IllegalArgumentException - if object is not a network item

getField

Field getField(String fieldName) throws IllegalAccessException, NoSuchFieldException

Returns the field of the submitted network object defined in the document embedded OVL script.

Parameters:

fieldName -

Returns:

reference object representing the field

Throws:

IllegalAccessException - if field is protected

NoSuchFieldException - if field does not exist

getField

Field getField(String namespace, String fieldName) throws IllegalAccessException, NoSuchFieldException

Returns the field of the submitted network object defined in the give namespace.

Parameters:

namespace -

fieldName -

Returns:

reference object representing the field

Throws:

IllegalAccessException - if field is protected

NoSuchFieldException - if field does not exist