Package org.biopax.paxtools.io
Interface BioPAXIOHandler
- All Known Implementing Classes:
BioPAXIOHandlerAdapter,SimpleIOHandler
public interface BioPAXIOHandler
This interface defines IO related operations that can be performed on
BioPAX models.
-
Method Summary
Modifier and TypeMethodDescriptionThis method will read the OWL document given by the input stream and will convert it into an in memory BioPAX model.voidconvertToOWL(Model model, OutputStream outputStream) This method will write the model to the output stream.voidconvertToOWL(Model model, OutputStream outputStream, String... ids) This method will "excise" a new model from the given model that contains the objects with given ids and their dependents.voidfixReusedPEPs(boolean fixReusedPEPs) This option is only applicable two level 2 models.getLevel()booleanThis option is only applicable two level 2 models.voidsetEditorMap(EditorMap editorMap) voidsetFactory(BioPAXFactory factory)
-
Method Details
-
fixReusedPEPs
void fixReusedPEPs(boolean fixReusedPEPs) This option is only applicable two level 2 models. When enabled it will replicate illegally reused pysicalEntityParticipants in Level2 files.- Parameters:
fixReusedPEPs- true or false
-
convertFromOWL
This method will read the OWL document given by the input stream and will convert it into an in memory BioPAX model.- Parameters:
in- a BioPAX data input stream (RDF/XML format)- Returns:
- new BioPAX object Model
-
convertToOWL
This method will write the model to the output stream. Default encoding is RDF/XML.- Parameters:
model- a BioPAX modeloutputStream- output stream
-
isFixReusedPEPs
boolean isFixReusedPEPs()This option is only applicable two level 2 models. When enabled it will replicate illegally reused pysicalEntityParticipants in Level2 files.- Returns:
- true if this option is enabled.
-
getFactory
BioPAXFactory getFactory()- Returns:
- the factory that is used to create new BioPAX POJOs during a BioPAXIOHandler operation.
-
setFactory
- Parameters:
factory- used for creating objects
-
getEditorMap
EditorMap getEditorMap()- Returns:
- EditorMap used for this handler.
-
setEditorMap
- Parameters:
editorMap- used for this handler.
-
getLevel
BioPAXLevel getLevel()- Returns:
- The level of the model that is being read.
-
convertToOWL
This method will "excise" a new model from the given model that contains the objects with given ids and their dependents.- Parameters:
model- BioPAX object model to be exported to the output stream as RDF/XMLoutputStream- the streamids- optional list of absolute URIs of BioPAX objects - roots/seeds for extracting a sub-model to be exported
-