org.biopax.paxtools.pattern.miner

Enum SIFEnum

java.lang.Object

java.lang.Enum<SIFEnum>

org.biopax.paxtools.pattern.miner.SIFEnum

All Implemented Interfaces:

Serializable, Comparable<SIFEnum>, SIFType

public enum SIFEnum
extends Enum<SIFEnum>
implements SIFType

Enum for representing supported SIF edge types.

Author:

Ozgun Babur

Enum Constant Summary

Enum Constants

Enum Constant and Description
CATALYSIS_PRECEDES
CHEMICAL_AFFECTS
CONSUMPTION_CONTROLLED_BY
CONTROLS_EXPRESSION_OF
CONTROLS_PHOSPHORYLATION_OF
CONTROLS_PRODUCTION_OF
CONTROLS_STATE_CHANGE_OF
CONTROLS_TRANSPORT_OF
CONTROLS_TRANSPORT_OF_CHEMICAL
IN_COMPLEX_WITH
INTERACTS_WITH
NEIGHBOR_OF
REACTS_WITH
USED_TO_PRODUCE

Method Summary

Modifier and Type	Method and Description
String	getDescription() Gets the description of the SIF type.
List<Class<? extends SIFMiner>>	getMiners() Gets the list of SIFMiner classes that can search this type of SIF edge in a BioPAX model.
String	getTag() Tag of a SIF type is derived from the enum name.
boolean	isDirected() Asks if the edge is directed.
static SIFEnum	typeOf(String tag)
static SIFEnum	valueOf(String name) Returns the enum constant of this type with the specified name.
static SIFEnum[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CONTROLS_STATE_CHANGE_OF

public static final SIFEnum CONTROLS_STATE_CHANGE_OF

CONTROLS_TRANSPORT_OF

public static final SIFEnum CONTROLS_TRANSPORT_OF

CONTROLS_PHOSPHORYLATION_OF

public static final SIFEnum CONTROLS_PHOSPHORYLATION_OF

CONTROLS_EXPRESSION_OF

public static final SIFEnum CONTROLS_EXPRESSION_OF

CATALYSIS_PRECEDES

public static final SIFEnum CATALYSIS_PRECEDES

IN_COMPLEX_WITH

public static final SIFEnum IN_COMPLEX_WITH

INTERACTS_WITH

public static final SIFEnum INTERACTS_WITH

NEIGHBOR_OF

public static final SIFEnum NEIGHBOR_OF

CONSUMPTION_CONTROLLED_BY

public static final SIFEnum CONSUMPTION_CONTROLLED_BY

CONTROLS_PRODUCTION_OF

public static final SIFEnum CONTROLS_PRODUCTION_OF

CONTROLS_TRANSPORT_OF_CHEMICAL

public static final SIFEnum CONTROLS_TRANSPORT_OF_CHEMICAL

CHEMICAL_AFFECTS

public static final SIFEnum CHEMICAL_AFFECTS

REACTS_WITH

public static final SIFEnum REACTS_WITH

USED_TO_PRODUCE

public static final SIFEnum USED_TO_PRODUCE

Method Detail

values

public static SIFEnum[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SIFEnum c : SIFEnum.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SIFEnum valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getTag

public String getTag()

Tag of a SIF type is derived from the enum name.

Specified by:

getTag in interface SIFType

Returns:

tag

isDirected

public boolean isDirected()

Asks if the edge is directed.

Specified by:

isDirected in interface SIFType

Returns:

true if directed

getDescription

public String getDescription()

Gets the description of the SIF type.

Specified by:

getDescription in interface SIFType

Returns:

description

getMiners

public List<Class<? extends SIFMiner>> getMiners()

Description copied from interface: SIFType

Gets the list of SIFMiner classes that can search this type of SIF edge in a BioPAX model.

Specified by:

getMiners in interface SIFType

Returns:

SIF miners

typeOf

public static SIFEnum typeOf(String tag)