Enum StaticProperty

java.lang.Object
java.lang.Enum<StaticProperty>
org.pathvisio.libgpml.prop.StaticProperty
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<StaticProperty>, java.lang.constant.Constable, Property

public enum StaticProperty
extends java.lang.Enum<StaticProperty>
implements Property
Static properties for ObjectTypes, linked in PathwayObject.
Author:
unknown, finterly
  • Enum Constant Details

  • Field Details

    • tag

      private java.lang.String tag
    • name

      private java.lang.String name
    • type

      private StaticPropertyType type
    • isCoordinate

      private boolean isCoordinate
    • isAdvanced

      private boolean isAdvanced
    • hidden

      private boolean hidden
    • order

      private int order
    • tagMapping

      private static java.util.Map<java.lang.String,​StaticProperty> tagMapping
  • Constructor Details

    • StaticProperty

      private StaticProperty​(java.lang.String aTag, java.lang.String aName, StaticPropertyType aType, int anOrder, boolean aIsCoordinate, boolean aIsAdvanced, boolean isHidden)
    • StaticProperty

      private StaticProperty​(java.lang.String aTag, java.lang.String aDesc, StaticPropertyType aType, int anOrder)
  • Method Details

    • values

      public static StaticProperty[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared
    • valueOf

      public static StaticProperty valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
      java.lang.NullPointerException - if the argument is null
    • tag

      public java.lang.String tag()
      Returns:
      Name of GPML attribute related to this property.
    • isCoordinateChange

      public boolean isCoordinateChange()
      Returns:
      true if this property causes coordinate changes.
    • isAdvanced

      public boolean isAdvanced()
      Returns:
      true if this attribute should be hidden unless the "Show advanced properties" preference is set to true
    • isHidden

      public boolean isHidden()
      Returns:
      true if this is attribute should not be shown in property table
    • setHidden

      public void setHidden​(boolean hide)
    • getOrder

      public int getOrder()
      Returns:
      Logical sort order for display in Property table. Related properties sort together
    • getByTag

      public static StaticProperty getByTag​(java.lang.String value)
    • initTagMapping

      private static java.util.Map<java.lang.String,​StaticProperty> initTagMapping()
    • getId

      public java.lang.String getId()
      Description copied from interface: Property
      Returns the Id for this property. Ids must be unique.
      Specified by:
      getId in interface Property
      Returns:
      the id for this property.
    • getName

      public java.lang.String getName()
      inheritDoc
      Specified by:
      getName in interface Property
      Returns:
      the name.
    • getDescription

      public java.lang.String getDescription()
      inheritDoc Used to be desc()
      Specified by:
      getDescription in interface Property
      Returns:
      description. May return null.
    • getType

      public PropertyType getType()
      Used to be type() which returned StaticPropertyType
      Specified by:
      getType in interface Property
      Returns:
      type the data type of this property
    • isCollection

      public boolean isCollection()
      Description copied from interface: Property
      Gets whether this property has accepts values.
      Specified by:
      isCollection in interface Property
      Returns:
      true if this property accepts values.