org.biopax.paxtools.controller
Interface EditorMap

All Known Implementing Classes:

EditorMapAdapter, SimpleEditorMap

public interface EditorMap

This class contains methods that eases to use editors for specific or a set of property. Using the methods of this class editors of a class, editors of a property, and editors of a property with the given domain can be obtained; and these editors/this editor can be used to modify object's properties. The functionallity of this class plays key roles on several other classes' functionallity; e.g. org.biopax.paxtools.io, org.biopax.paxtools.model,

Method Summary

<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.

Method Detail

getEditorForProperty

<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). 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.

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

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

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.

Parameters:

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

Returns:

empty set if there are no such editors

getSubclassEditorsForProperty

<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. 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.

Parameters:

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

Returns:

empty set if there are no such editors

getEditorsOf

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

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

Parameters:

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

Returns:

empty set if there are no such editors

getInverseEditorsOf

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

getKnownSubClassesOf

<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. This method can be used for class filtering methods.

Parameters:

javaClass - the class whose subclasses will be returned

Returns:

an empty set if there are no such editors

getLevel

BioPAXLevel getLevel()

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

Returns:

BioPAX Level

getEditorsOf

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

getInverseEditorsOf

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