Package de.unirostock.sems.bives.cellml.parser

Class CellMLDocument

java.lang.Object

de.unirostock.sems.bives.ds.ModelDocument

de.unirostock.sems.bives.cellml.parser.CellMLDocument

public class CellMLDocument
extends de.unirostock.sems.bives.ds.ModelDocument

The Class CellMLDocument representing a document containing a CellML model.

Author:

Martin Scharm

Field Summary

Fields inherited from class de.unirostock.sems.bives.ds.ModelDocument

doc

Constructor Summary

Constructors

Constructor	Description
CellMLDocument(de.unirostock.sems.xmlutils.ds.TreeDocument doc)	Instantiates a new cell ml document.

Method Summary

Modifier and Type	Method	Description
void	associateRdfDescription(de.unirostock.sems.bives.ds.rdf.RDFDescription descr)	Associate an rdf description.
boolean	containsImports()	Does this model contain imports?
void	flatten()	Flatten flatten the model encoded in this document.
CellMLModel	getModel()	Gets the encoded model.
void	write(File dest)	Write the document to disk.

Methods inherited from class de.unirostock.sems.bives.ds.ModelDocument

getBaseUri, getTreeDocument

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CellMLDocument

public CellMLDocument(de.unirostock.sems.xmlutils.ds.TreeDocument doc)
               throws BivesCellMLParseException,
                      de.unirostock.sems.bives.exception.BivesDocumentConsistencyException,
                      de.unirostock.sems.bives.exception.BivesLogicalException,
                      IOException,
                      URISyntaxException,
                      de.unirostock.sems.bives.exception.BivesImportException

Instantiates a new cell ml document.

Parameters:

doc - the document encoding the model

Throws:

BivesCellMLParseException - the bives cell ml parse exception

de.unirostock.sems.bives.exception.BivesDocumentConsistencyException - the bives document consistency exception

de.unirostock.sems.bives.exception.BivesLogicalException - the bives logical exception

IOException - Signals that an I/O exception has occurred.

URISyntaxException - the uRI syntax exception

de.unirostock.sems.bives.exception.BivesImportException - the bives import exception

Method Detail

getModel

public CellMLModel getModel()

Gets the encoded model.

Returns:

the model

containsImports

public boolean containsImports()

Does this model contain imports?

Returns:

true, if it contains imports

flatten

public void flatten()
             throws de.unirostock.sems.bives.exception.BivesFlattenException,
                    de.unirostock.sems.bives.exception.BivesDocumentConsistencyException,
                    de.unirostock.sems.xmlutils.exception.XmlDocumentConsistencyException,
                    de.unirostock.sems.bives.exception.BivesLogicalException

Flatten flatten the model encoded in this document.

Specified by:

flatten in class de.unirostock.sems.bives.ds.ModelDocument

Throws:

de.unirostock.sems.bives.exception.BivesFlattenException - the bives flatten exception

de.unirostock.sems.bives.exception.BivesDocumentConsistencyException - the bives document consistency exception

de.unirostock.sems.xmlutils.exception.XmlDocumentConsistencyException - the xml document consistency exception

de.unirostock.sems.bives.exception.BivesLogicalException

write

public void write(File dest)
           throws IOException

Write the document to disk.

Parameters:

dest - the target file

Throws:

IOException - Signals that an I/O exception has occurred.

associateRdfDescription

public void associateRdfDescription(de.unirostock.sems.bives.ds.rdf.RDFDescription descr)

Associate an rdf description.

Parameters:

descr - the description