{"id":691,"date":"2010-06-29T06:35:56","date_gmt":"2010-06-29T04:35:56","guid":{"rendered":"http:\/\/www.tutego.de\/blog\/javainsel\/2010\/06\/simple-openoffice-templating-with-the-odf-toolkit\/"},"modified":"2010-06-29T06:35:56","modified_gmt":"2010-06-29T04:35:56","slug":"simple-openoffice-templating-with-the-odf-toolkit","status":"publish","type":"post","link":"https:\/\/www.tutego.de\/blog\/javainsel\/2010\/06\/simple-openoffice-templating-with-the-odf-toolkit\/","title":{"rendered":"Simple OpenOffice templating with the ODF toolkit"},"content":{"rendered":"

To open an OpenOffice text document and access the text you first have to download odfdom-0.8.5-binaries.zip (Homepage of ODF TOOLKIT<\/a>) and add odfdom.jar to your classpath together with a recent Xerces implementation like xercesImpl-2.9.0.jar. Then you can start with Java:<\/p>\n

File file = new File( "C:\/Users\/Christian\/Desktop\/TEMPLATE.odt" );
OdfTextDocument odf = (OdfTextDocument) OdfTextDocument.loadDocument( file );
OdfOfficeText contentRoot = odf.getContentRoot();<\/p>\n

The OdfOfficeText gives access to the XML-structure of the document. If you print it out<\/p>\n

System.out.println( contentRoot );<\/p>\n

it looks like this:<\/p>\n

<office:text>
    <office:forms form:apply-design-mode="false"
        form:automatic-focus="false"><\/office:forms>
    <text:variable-decls><\/p>\n

\u2026<\/p>\n

    <\/text:p>
<\/office:text><\/p>\n

With regular XML-DOM operations you can now modify the document.<\/p>\n

To use a template you have to a) find a certain element you want to fill b) modify it and c) save the document.<\/p>\n

a) For templates you can use user variables. If you set a variable it looks like this in XML:<\/p>\n

<text:variable-set office:value-type="string" text:name="COURSETITLE">COURSETITLE<\/text:variable-set> <\/p>\n

(Date and other formats look different!)<\/p>\n

b) After your found the XML element either by hand or XPath, you can modify an entry with setNodeValue() or different method if the value is stored in attributes.<\/p>\n

c) Save the modified document with odf.save( file );<\/p>\n

A simple but complete example to read a document, set variables and write the modified ODT:<\/p>\n

import java.io.File;
import java.util.*;
import org.odftoolkit.odfdom.doc.OdfTextDocument;
import org.odftoolkit.odfdom.doc.office.OdfOfficeText;
import org.w3c.dom.*; <\/p>\n

public class OdtTemplate
{
  private OdfTextDocument odf;
  private Map<String, String> map = new HashMap<String, String>(); <\/p>\n

  public static void main( String[] args ) throws Exception
  {
    File file1 = new File( "C:\/Users\/Christian\/Desktop\/TEMPLATE.odt" );
    File file2 = new File( "C:\/Users\/Christian\/Desktop\/result.odt" ); <\/p>\n

    OdtTemplate template = new OdtTemplate();
    template.readOdt( file1 );
    template.setVariable( "COURSETITLE", "Donuts backen f\u00fcr Kernkraftfahrer" );
    template.setVariable( "COURSECODE", "DONUT" );
    template.setVariable( "CREATOR", "ull" );
    template.saveOdt( file2 );
  } <\/p>\n

  public void readOdt( File file ) throws Exception
  {
    odf = (OdfTextDocument) OdfTextDocument.loadDocument( file );
  } <\/p>\n

  public void setVariable( String key, String value )
  {
    map.put( key, value );
  } <\/p>\n

  public void saveOdt( File file ) throws Exception
  {
    OdfOfficeText contentRoot = odf.getContentRoot();
    iteratorOverEveryVariableSet( contentRoot.getChildNodes() );
    odf.save( file );
  } <\/p>\n

  private void iteratorOverEveryVariableSet( NodeList childNodes )
  {
    for ( int i = 0; i < childNodes.getLength(); i++ )
    {
      Node item = childNodes.item( i ); <\/p>\n

      if ( item instanceof NodeList )
        iteratorOverEveryVariableSet( item.getChildNodes() ); <\/p>\n

      if ( item.getNodeName().equals( "text:variable-set" ) )
      {
        String nodeValue = item.getAttributes().getNamedItem( "text:name" ).getNodeValue();
        item.getChildNodes().item( 0 ).setNodeValue( map.get( nodeValue ) );
      }
    }
  }
}<\/p>\n","protected":false},"excerpt":{"rendered":"

To open an OpenOffice text document and access the text you first have to download odfdom-0.8.5-binaries.zip (Homepage of ODF TOOLKIT) and add odfdom.jar to your classpath together with a recent Xerces implementation like xercesImpl-2.9.0.jar. Then you can start with Java: File file = new File( "C:\/Users\/Christian\/Desktop\/TEMPLATE.odt" ); OdfTextDocument odf = (OdfTextDocument) OdfTextDocument.loadDocument( file ); OdfOfficeText […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_jetpack_memberships_contains_paid_content":false,"footnotes":"","_links_to":"","_links_to_target":""},"categories":[4],"tags":[],"class_list":["post-691","post","type-post","status-publish","format-standard","hentry","category-open-source"],"jetpack_featured_media_url":"","jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/www.tutego.de\/blog\/javainsel\/wp-json\/wp\/v2\/posts\/691","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.tutego.de\/blog\/javainsel\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.tutego.de\/blog\/javainsel\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.tutego.de\/blog\/javainsel\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.tutego.de\/blog\/javainsel\/wp-json\/wp\/v2\/comments?post=691"}],"version-history":[{"count":0,"href":"https:\/\/www.tutego.de\/blog\/javainsel\/wp-json\/wp\/v2\/posts\/691\/revisions"}],"wp:attachment":[{"href":"https:\/\/www.tutego.de\/blog\/javainsel\/wp-json\/wp\/v2\/media?parent=691"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.tutego.de\/blog\/javainsel\/wp-json\/wp\/v2\/categories?post=691"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.tutego.de\/blog\/javainsel\/wp-json\/wp\/v2\/tags?post=691"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}