All Superinterfaces:: Component, Item

@OVLExtensible
public interface Compartment
extends Component

Represents a compartment in the metabolic network diagram. This Java interface represents a Compartment in OVL. It contain all methods available in OVL. The static fields in this interface declaration are public non-static instance fields in OVL. They can be read and written from OVL code.

Author:: Dr. Peter Droste, Omix Visualization

Method Summary

Modifier and Type	Method	Description
`double`	`blur()`	The item's blur.
`default Brush`	`brush()`	Deprecated.
`default List<? extends Comment>`	`comments()`	Deprecated.
`Font`	`font()`	The item's text label font.
`default Comment`	`getComment(String identifier)`	Deprecated.
`Metabolite`	`getMetabolite(String name)`	Returns the metabolite node of the given name if available in the compartment, otherwise null.
`String`	`getName()`	Returns the name of the item.
`Set<? extends PublicIdentifier>`	`getPublicIdentifiers()`	Returns the components public identifiers
`Compartment`	`getSubCompartment(String name)`	Returns a sub compartment of the given name if available in the compartment, otherwise null.
`boolean`	`hidden()`	Visibility of the network component.
`List<? extends Metabolite>`	`metabolites()`	Returns an unchangeable `List` of all metabolites that occur in this compartment.
`Model`	`model()`	Returns the model this item belongs to.
`default Model`	`network()`	Deprecated.
`Compartment`	`outside()`	Returns the outside compartment if available otherwise null.
`Paint`	`paint()`	The fill brush of the item's shape.
`Shape`	`shape()`	The fill brush of the item's shape.
`Color`	`strokeColor()`	The color for the stroke of the item's shape.
`StrokeStyle`	`strokeStyle()`	The paint style for the stroke of the item's shape.
`double`	`strokeWidth()`	The stroke width of the item's shape.
`List<? extends Compartment>`	`subCompartments()`	Returns an unchangeable `List` of all sub compartments.
`List<String>`	`synonyms()`	Returns the synonyms of the item.
`double`	`textBlur()`	The blur of the item's text.
`Brush`	`textBrush()`	The fill brush of the item's text label.
`Shadow`	`textShadow()`	The shadow of the item's text.
`Color`	`textStrokeColor()`	The color for the stroke of the item's text label.
`double`	`textStrokeWidth()`	The stroke width of the item's text label.
`double`	`textTransparency()`	The transparency of the item's text.
`double`	`transparency()`	The item's transparency.

Methods inherited from interface omix.lang.model.Component

customPropertyNames, getCustomProperty, getIdentifier, id, onload, setCustomProperty, setTmpCustomProperty

Method Details
- getName
  
  String getName()
  
  Returns the name of the item.
  
  Returns:
  
  name
- synonyms
  
  @OVLField List<String> synonyms()
  
  Returns the synonyms of the item.
  
  Returns:
  
  synonyms
  
  Since:
  
  Omix 1.9.0
- getPublicIdentifiers
  
  Set<? extends PublicIdentifier> getPublicIdentifiers()
  
  Returns the components public identifiers
  
  Returns:
  
  set of public identifiers
  
  Since:
  
  Omix 1.9.0
- network
  
  @Deprecated(since="Omix 2.0") @ReplacedBy("model()") default Model network()
  
  Deprecated.
  
  Returns the network this item belongs to.
  
  Returns:
  
  network
- model
  
  Model model()
  
  Returns the model this item belongs to.
  
  Returns:
  
  model
- strokeColor
  
  @OVLField @OVLFallbackField Color strokeColor()
  
  The color for the stroke of the item's shape.
- textStrokeColor
  
  @OVLField @OVLFallbackField Color textStrokeColor()
  
  The color for the stroke of the item's text label.
- textBrush
  
  @OVLField @OVLFallbackField Brush textBrush()
  
  The fill brush of the item's text label.
  
  Since:
  
  Omix 1.8.0
- paint
  
  @OVLField @OVLFallbackField Paint paint()
  
  The fill brush of the item's shape.
  
  Since:
  
  Omix 1.8.0
- brush
  
  @OVLField @OVLFallbackField @Deprecated default Brush brush()
  
  Deprecated.
  
  The fill brush of the item's shape.
  
  Since:
  
  Omix 1.8.0
- shape
  
  @OVLField Shape shape()
  
  The fill brush of the item's shape.
  
  Since:
  
  Omix 1.9.10
- textShadow
  
  @OVLField @OVLFallbackField Shadow textShadow()
  
  The shadow of the item's text.
  
  Since:
  
  Omix 1.5.13
- textBlur
  
  @OVLField @OVLFallbackField double textBlur()
  
  The blur of the item's text.
  
  Since:
  
  Omix 1.5.13
- textTransparency
  
  @OVLField @OVLFallbackField double textTransparency()
  
  The transparency of the item's text.
  
  Since:
  
  Omix 1.5.13
- blur
  
  @OVLField @OVLFallbackField double blur()
  
  The item's blur.
  
  Since:
  
  Omix 1.5.13
- transparency
  
  @OVLField @OVLFallbackField double transparency()
  
  The item's transparency.
  
  Since:
  
  Omix 1.5.13
- strokeStyle
  
  @OVLField @OVLFallbackField StrokeStyle strokeStyle()
  
  The paint style for the stroke of the item's shape.
- strokeWidth
  
  @OVLField @OVLFallbackField double strokeWidth()
  
  The stroke width of the item's shape.
- textStrokeWidth
  
  @OVLField @OVLFallbackField double textStrokeWidth()
  
  The stroke width of the item's text label.
- font
  
  @OVLField @OVLFallbackField Font font()
  
  The item's text label font.
- hidden
  
  @OVLField boolean hidden()
  
  Visibility of the network component.
  
  Returns:
  
  hidden
- subCompartments
  
  List<? extends Compartment> subCompartments()
  
  Returns an unchangeable List of all sub compartments.
  
  Returns:
  
  sub compartments
- outside
  
  Compartment outside()
  
  Returns the outside compartment if available otherwise null.
  
  Returns:
  
  outside compartment
- metabolites
  
  List<? extends Metabolite> metabolites()
  
  Returns an unchangeable List of all metabolites that occur in this compartment.
  
  Returns:
  
  all metabolites
- getMetabolite
  
  Metabolite getMetabolite(String name)
  
  Returns the metabolite node of the given name if available in the compartment, otherwise null.
  
  Parameters:
  
  name - of metabolite node
  
  Returns:
  
  found metabolite node
- getSubCompartment
  
  Compartment getSubCompartment(String name)
  
  Returns a sub compartment of the given name if available in the compartment, otherwise null.
  
  Parameters:
  
  name - of sub compartment
  
  Returns:
  
  found sub compartment
- getComment
  
  @Deprecated default Comment getComment(String identifier)
  
  Deprecated.
  
  Returns the item's comment with the given identifier if available, otherwise null.
  
  Parameters:
  
  identifier - of the comment item
  
  Returns:
  
  found comment item
- comments
  
  @Deprecated default List<? extends Comment> comments()
  
  Deprecated.
  
  Returns an unchangeable List of all item's comments.
  
  Returns:
  
  list of comments

Interface Compartment

Method Summary

Methods inherited from interface omix.lang.model.Component

Method Details