|
|
| (120 intermediate revisions by 6 users not shown) |
| Line 1: |
Line 1: |
| − | =OpenDocument API - ODFDOM=
| + | The OpenDocument API has a new home. Please visit |
| | + | http://odftoolkit.org/projects/odfdom/pages/Home |
| | | | |
| − | ODFDOM is the name of the upcoming free OpenDocument framework sponsered by Sun Microsystems Inc.
| + | You should register at the ODF Toolkit project and subscribe yourself to the mailing lists of the projects you are interested in. |
| | | | |
| − | It is the succesor of [[AODL]] and [[Odf4j]], designed together with their architects to provide the ODF developer community an easy lightwork programming API, meant to be portable to any object-oriented language.
| + | See you soon, |
| − |
| + | Svante |
| − | The first pre-version of the Java 5 reference implementation of ODFDOM is planned to be made public under LGPL3 in May 2008.
| + | [[Category:ODFToolkit]] |
| − | | + | |
| − | =Overview=
| + | |
| − | | + | |
| − | The ODFDOM project's objective is to provide an API for easily reading, writing and manipulating ODF documents. ODFDOM implements a layered approach through which documents are accessed.
| + | |
| − | * The ODF Package / Physical Layer - provides direct access to the resources that are stored in the ODF package, such as XML streams, images or embedded objects.
| + | |
| − | * The ODF Typed DOM / XML Layer - provides classes for all XML elements. XML attributes are mapped to class attributes. It is a typed DOM as every ODF XML element is represented by a different class, generated from the ODF RelaxNG schema. This level is concerned with the representation of the content of the standardized XML streams of the underlying package using the language independent W3C DOM API. This layer easily provides the ODF developer with all informations about the ODF XML structure.
| + | |
| − | * The ODF Document / Convenient Layer - represents components consisting of multiple underlying XML elements. This level is concerned with usability aids, which are not specified by the ODF standard.
| + | |
| − | * The Customized ODF Document / Extendable Layer - not part of the delivered API, but part of the design. This level is concerned with user defined customizations.
| + | |
| − | | + | |
| − | [[Image:ODFDOM-Layered-Model.png]] | + | |
| − | | + | |
| − | ODFDOM is part of the [http://odftoolkit.openoffice.org odftoolkit project]. Development is discussed on the [http://odftoolkit.openoffice.org/servlets/SummarizeList?listName=dev dev@odftoolkit.openoffice.org mailing list].
| + | |
| − | | + | |
| − | =The ODFDOM Layers=
| + | |
| − | | + | |
| − | ==The Package / Physical Layer==
| + | |
| − | | + | |
| − | At this level, a document is represented as a package of named resources. All resources can be accessed as streams.
| + | |
| − | Resources that are XML can additionally be accessed as DOM documents. For standardized file streams explicit methods are being provided.
| + | |
| − | | + | |
| − | [[Image:ODF_Package.jpg]]
| + | |
| − | '''Note:'''
| + | |
| − | All file streams aside of the /Pictures directory are specified by the ODF standard.
| + | |
| − | | + | |
| − | The main requirements for this layer are
| + | |
| − | * Zip/unzip the file streams of the package
| + | |
| − | * Enlist all file streams in the /META-INF/manifest.xml (otherwise OOo won't save the file streams)
| + | |
| − | * Begin the package with an unzipped 'mimetype' file stream
| + | |
| − | | + | |
| − | All sources of the Package/Physical layer are organized beyond org.openoffice.odf.pkg.*
| + | |
| − | | + | |
| − | The following example illustrates how to add a graphic to the package level
| + | |
| − | (not shown by OOo, as not referenced by content.xml):
| + | |
| − | <pre>
| + | |
| − | import org.openoffice.odf.pkg.OdfPackage;
| + | |
| − | [...]
| + | |
| − | | + | |
| − | // loads the ODF document package from the path
| + | |
| − | OdfPackage pkg = OdfPackage.load("/home/myDocuments/myVacation.odt");
| + | |
| − | | + | |
| − | | + | |
| − | // loads the image from the URL and inserts the image in the package, adapting the manifest
| + | |
| − | pkg.insert("http://myweb.org/images/myHoliday.png", "/Pictures/myHoliday.png");
| + | |
| − | </pre>
| + | |
| − | | + | |
| − | ==The Typed DOM / XML Layer==
| + | |
| − | | + | |
| − | At this level, only the by ODF standardized XML file streams of the document are accessible via the W3C DOM API.
| + | |
| − | | + | |
| − | For instance the XML of an ODF table
| + | |
| − | | + | |
| − | [[Image:fruitTable_code.jpg]]
| + | |
| − | | + | |
| − | Would be mapped to a W3C derived ODF DOM class structure:
| + | |
| − | | + | |
| − | [[Image:table_fruits_diagramm.jpg]]
| + | |
| − | | + | |
| − | '''Note:''' In the OpenDocument ISO standard the ODF elements are reused among all document types. The above XML is similar usable for a Text and Spreadsheet document.
| + | |
| − | | + | |
| − | All sources of the typed DOM/XML layer are organized beyond org.openoffice.odf.dom.*
| + | |
| − | | + | |
| − | Its sources are all generated from the RelaxNG schema using the following naming conventions:
| + | |
| − | * The Class name is equal to the element name using 'Odf' as an Prefix and 'Element' as Suffix.
| + | |
| − | * Elements are stored beyond a sub-package equal to their Namespace used by the OOo.
| + | |
| − | | + | |
| − | For instance, the frame element 'draw:frame' would be generated as class
| + | |
| − | org.openoffice.odf.dom.draw.OdfFrameElement
| + | |
| − | | + | |
| − | Note: Java dependent helper classes, which are not part of the official API, but for convenient part of the module are delivered beyond org.openoffice.odf.java.*
| + | |
| − | | + | |
| − | The following example illustrates how to add a graphic to the ODF document, that it is viewable:
| + | |
| − | <pre>
| + | |
| − | import javax.xml.xpath.XPath;
| + | |
| − | import javax.xml.xpath.XPathConstants;
| + | |
| − | import javax.xml.xpath.XPathFactory;
| + | |
| − | import org.openoffice.odf.doc.OdfDocument;
| + | |
| − | import org.openoffice.odf.dom.text.OdfParagraphElement;
| + | |
| − | import org.openoffice.odf.java.OdfNamespaceContext;
| + | |
| − | import org.w3c.dom.Document;
| + | |
| − | [...]
| + | |
| − | | + | |
| − | // loads the ODF document from the path
| + | |
| − | OdfDocument odfDoc = OdfDocument.load("/home/myDocuments/myVacation.odt");
| + | |
| − | | + | |
| − | // get the ODF content as DOM tree representation
| + | |
| − | Document odfContent = odfDocument.getContent();
| + | |
| − | | + | |
| − | // XPath initialization ''(JDK5 functionality)''
| + | |
| − | XPath xpath = XPathFactory.newInstance().newXPath();
| + | |
| − | xpath.setNamespaceContext(new OdfNamespaceContext());
| + | |
| − | | + | |
| − | // receiving the first Paragraph "//text:p[1]" ''(JDK5 functionality)''
| + | |
| − | OdfParagraphElement para = (OdfParagraphElement) xpath.evaluate("//text:p[1]", odfContent, XPathConstants.NODE);
| + | |
| − | | + | |
| − | // adding an image - expecting the user to know that
| + | |
| − | // an image consists always of a 'draw:image' and a 'draw:frame' parent
| + | |
| − | para.createDrawFrame().createDrawImage("http://myweb.org/images/myHoliday.png", "/Pictures/myHoliday.png");
| + | |
| − | </pre>
| + | |
You should register at the ODF Toolkit project and subscribe yourself to the mailing lists of the projects you are interested in.
