Module omix.api

Package omix.lang.model

Interface Component

All Superinterfaces:

Item

All Known Subinterfaces:

BioNode, Comment, Compartment, Edge, EffectorEdge, FluxEdge, GraphicsBox, GraphicsEdge, GraphicsItem, GraphicsNode, GraphicsPath, Link, LinkEdge, Metabolite, MetaboliteType, MetNode, Model, Node, Pathway, Reaction

public interface Component
extends Item

Superclass of all model components in OVL. All extensible component types are represented as Java interface sub-typing this type. This interface contains all methods available in OVL.

Since:

Omix 2.0.0

Author:

Dr. Peter Droste, Omix Visualization

Method Summary

Modifier and Type	Method	Description
List<String>	customPropertyNames()	Returns a name list of all available custom properties.
@IsVarType Object	getCustomProperty(String name)	Returns the value of the custom property or null if not available.
default String	getIdentifier()	Deprecated.
String	id()	Returns the ID of the model component.
void	onload()	Slot executed on load of component.
void	setCustomProperty(String name, @IsVarType Object value)	Adds a custom property to the model component.
void	setTmpCustomProperty(String name, @IsVarType Object value)	Adds a temporary custom property to the model component.

Method Details

getIdentifier

@Deprecated(since="Omix 2.0") @ReplacedBy("property \"id\"") default String getIdentifier()

Deprecated.

Returns the unique identifier of the item.

Specified by:

getIdentifier in interface Item

Returns:

name

id

@OVLField String id()

Returns the ID of the model component.

Specified by:

id in interface Item

Returns:

ID

Since:

Omix 2.0.0

setCustomProperty

void setCustomProperty(String name, @IsVarType Object value)

Adds a custom property to the model component. Each item can carry arbitrary values as custom property. The property content is stored to the document file as far as possible. If the value cannot be saved to file, the property is removed after relaunch. Custom properties can be accessed from all namespaces. Set null to remove property. Setting custom properties in OVL is undoable.

Specified by:

setCustomProperty in interface Item

Parameters:

name -

value -

See Also:

setTmpCustomProperty(String, Object), getCustomProperty(String), customPropertyNames()

setTmpCustomProperty

void setTmpCustomProperty(String name, @IsVarType Object value)

Adds a temporary custom property to the model component. Each item can carry arbitrary values as custom property. The property content is not stored to the document file. Instead, the property is removed after relaunch. Custom properties can be accessed from all namespaces. Set null to remove property. Setting custom properties in OVL is undoable.

Specified by:

setTmpCustomProperty in interface Item

Parameters:

name -

value -

See Also:

setCustomProperty(String, Object), getCustomProperty(String), customPropertyNames()

getCustomProperty

@IsVarType Object getCustomProperty(String name)

Returns the value of the custom property or null if not available.

Specified by:

getCustomProperty in interface Item

Parameters:

name -

Returns:

value

customPropertyNames

List<String> customPropertyNames()

Returns a name list of all available custom properties.

Specified by:

customPropertyNames in interface Item

Returns:

name list

onload

@OVLEvent void onload()

Slot executed on load of component.

Specified by:

onload in interface Item

Since:

Omix 2.0.0