org.biopax.paxtools.controller
Enum SimpleEditorMap

java.lang.Object
  java.lang.Enum<SimpleEditorMap>
      org.biopax.paxtools.controller.SimpleEditorMap

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SimpleEditorMap>, EditorMap

public enum SimpleEditorMap
extends java.lang.Enum<SimpleEditorMap>
implements EditorMap

Provides a simple editor map for a level with a given factory.

Author:

Emek Demir

Enum Constant Summary

L1

L2

L3

Method Summary

static SimpleEditorMap	get(BioPAXLevel level)
<D extends BioPAXElement> PropertyEditor<? super D,?>	getEditorForProperty(java.lang.String property, java.lang.Class<D> javaClass) This method returns the editor intended to handle property named property of a class (javaClass).
java.util.Set<PropertyEditor>	getEditorsForProperty(java.lang.String property) This method returns the set of editors intended to handle property named property.
java.util.Set<PropertyEditor>	getEditorsOf(BioPAXElement bpe) This method returns the set of editors whose domain contains the class of given BioPAX element.
java.util.Set<PropertyEditor>	getEditorsOf(java.lang.Class<? extends BioPAXElement> domain)
java.util.Set<ObjectPropertyEditor>	getInverseEditorsOf(BioPAXElement bpe)
java.util.Set<ObjectPropertyEditor>	getInverseEditorsOf(java.lang.Class<? extends BioPAXElement> domain)
<E extends BioPAXElement> java.util.Set<java.lang.Class<E>>	getKnownSubClassesOf(java.lang.Class<E> javaClass) Returns a set of sub classes of a given class.
BioPAXLevel	getLevel() Returns the BioPAX level for which editor map is created.
<D extends BioPAXElement> java.util.Set<PropertyEditor<? extends D,?>>	getSubclassEditorsForProperty(java.lang.String property, java.lang.Class<D> domain) This method returns the set of editors intended to handle property named property.
static SimpleEditorMap	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SimpleEditorMap[]	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

L1

public static final SimpleEditorMap L1

L2

public static final SimpleEditorMap L2

L3

public static final SimpleEditorMap L3

Method Detail

values

public static SimpleEditorMap[] 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 (SimpleEditorMap c : SimpleEditorMap.values())
    System.out.println(c);

Returns:

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

valueOf

public static SimpleEditorMap 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

get

public static SimpleEditorMap get(BioPAXLevel level)

getEditorForProperty

public <D extends BioPAXElement> PropertyEditor<? super D,?> getEditorForProperty(java.lang.String property,
                                                                                  java.lang.Class<D> javaClass)

Description copied from interface: EditorMap

This method returns the editor intended to handle property named property of a class (javaClass). This editor can then be used to modify the property of an element of class javaClass. To put in other words, this methods returns the editor of which domain includes javaClass, and the editor that can handle the property.

Specified by:

getEditorForProperty in interface EditorMap

Parameters:

property - name of the property for which editor will be called

javaClass - class of the element

Returns:

null if there is no such editor

getEditorsForProperty

public java.util.Set<PropertyEditor> getEditorsForProperty(java.lang.String property)

Description copied from interface: EditorMap

This method returns the set of editors intended to handle property named property. This editor can then be used to modify the property of an element which is in editor's domain list. In other words, this methods returns the set of the editors that can handle the property. Editors are not filtered for a specific domain class.

Specified by:

getEditorsForProperty in interface EditorMap

Parameters:

property - name of the property for which editor will be called

Returns:

empty set if there are no such editors

getSubclassEditorsForProperty

public <D extends BioPAXElement> java.util.Set<PropertyEditor<? extends D,?>> getSubclassEditorsForProperty(java.lang.String property,
                                                                                                            java.lang.Class<D> domain)

Description copied from interface: EditorMap

This method returns the set of editors intended to handle property named property. This editor can then be used to modify the property of an element which is in editor's domain list. In other words, this methods returns the set of the editors that can handle the property. Editors are not filtered for a specific domain class.

Specified by:

getSubclassEditorsForProperty in interface EditorMap

Parameters:

property - name of the property for which editor will be called

Returns:

empty set if there are no such editors

getEditorsOf

public java.util.Set<PropertyEditor> getEditorsOf(BioPAXElement bpe)

Description copied from interface: EditorMap

This method returns the set of editors whose domain contains the class of given BioPAX element.

Specified by:

getEditorsOf in interface EditorMap

Parameters:

bpe - BioPAX element for which the avaliable editors will be returned

Returns:

empty set if there are no such editors

getInverseEditorsOf

public java.util.Set<ObjectPropertyEditor> getInverseEditorsOf(BioPAXElement bpe)

Specified by:

getInverseEditorsOf in interface EditorMap

getKnownSubClassesOf

public <E extends BioPAXElement> java.util.Set<java.lang.Class<E>> getKnownSubClassesOf(java.lang.Class<E> javaClass)

Description copied from interface: EditorMap

Returns a set of sub classes of a given class. This method can be used for class filtering methods.

Specified by:

getKnownSubClassesOf in interface EditorMap

Parameters:

javaClass - the class whose subclasses will be returned

Returns:

an empty set if there are no such editors

getLevel

public BioPAXLevel getLevel()

Description copied from interface: EditorMap

Returns the BioPAX level for which editor map is created. Different BioPAX levels have different editor maps.

Specified by:

getLevel in interface EditorMap

Returns:

BioPAX Level

getEditorsOf

public java.util.Set<PropertyEditor> getEditorsOf(java.lang.Class<? extends BioPAXElement> domain)

Specified by:

getEditorsOf in interface EditorMap

getInverseEditorsOf

public java.util.Set<ObjectPropertyEditor> getInverseEditorsOf(java.lang.Class<? extends BioPAXElement> domain)

Specified by:

getInverseEditorsOf in interface EditorMap