Package org.biopax.paxtools.model

Enum Class BioPAXLevel

java.lang.Object

java.lang.Enum<BioPAXLevel>

org.biopax.paxtools.model.BioPAXLevel

All Implemented Interfaces:

Serializable, Comparable<BioPAXLevel>, Constable

public enum BioPAXLevel
extends Enum<BioPAXLevel>

Enumeration type for BioPAX levels.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
L2
L3

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BP_PREFIX	This is the prefix used for all biopax releases.

Method Summary

Modifier and Type	Method	Description
BioPAXFactory	getDefaultFactory()	This method returns the default factory for this level
String	getFilename()	This method returns the filename of the owl file
Class<? extends BioPAXElement>	getInterfaceForName(String localName)	Gets the BioPAX type (java interface) by name.
InputStream	getLevelFileAsStream()	This method loads the level file as resource and returns it as an input stream
static BioPAXLevel	getLevelFromNameSpace(String namespace)
String	getNameSpace()	This method returns the namespace defined for this level.
String	getPackageName()
boolean	hasElement(BioPAXElement element)
static boolean	isInBioPAXNameSpace(String nameSpace)	This method returns true if the given string starts with the BP_PREFIX
static BioPAXLevel	valueOf(String name)	Returns the enum constant of this class with the specified name.
static BioPAXLevel[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

L2

public static final BioPAXLevel L2

L3

public static final BioPAXLevel L3

Field Details

BP_PREFIX

public static final String BP_PREFIX

This is the prefix used for all biopax releases.

See Also:

• Constant Field Values

Method Details

values

public static BioPAXLevel[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static BioPAXLevel valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getFilename

public String getFilename()

This method returns the filename of the owl file

Returns:

the filename of the owl file

getDefaultFactory

public BioPAXFactory getDefaultFactory()

This method returns the default factory for this level

Returns:

he default factory for this level

getLevelFileAsStream

public InputStream getLevelFileAsStream()

This method loads the level file as resource and returns it as an input stream

Returns:

an input stream from the owl file.

getNameSpace

public String getNameSpace()

This method returns the namespace defined for this level.

Returns:

namespace defined for this level.

isInBioPAXNameSpace

public static boolean isInBioPAXNameSpace(String nameSpace)

This method returns true if the given string starts with the BP_PREFIX

Parameters:

nameSpace - to be checked

Returns:

rue if the given string starts with the BP_PREFIX

getLevelFromNameSpace

public static BioPAXLevel getLevelFromNameSpace(String namespace)

getPackageName

public String getPackageName()

hasElement

public boolean hasElement(BioPAXElement element)

getInterfaceForName

public Class<? extends BioPAXElement> getInterfaceForName(String localName)

Gets the BioPAX type (java interface) by name.

Parameters:

localName - a BioPAX type name

Returns:

the BioPAX interface class

Throws:

IllegalBioPAXArgumentException - when there is no such type / class not found.