OfficeDocument.java

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.xwiki.officeimporter.document;

import java.util.Map;

/**
 * Represents an office document being imported.
 * 
 * @version $Id: 2efd8c6da290d3a31232b8e7b7f6736d6919f2ec $
 * @since 2.1M1
 */
public interface OfficeDocument
{
    /**
     * Returns the content of this office document. Content document type may vary depending on the implementation. For
     * an example, a particular implementation might return an html DOM object while another implementation might return
     * an XDOM.
     * 
     * @return content of this document.
     */
    Object getContentDocument();

    /**
     * Returns the content of this document as a string.
     * 
     * @return content of this document as a string.
     */
    String getContentAsString();

    /**
     * Returns all the artifacts for this office document. Artifacts are generated during the import operation if the
     * original office document contains embedded non-textual elements. Also, some office formats (like presentations)
     * result in multiple output files when converted into html. In this case all these output files will be considered
     * as artifacts.
     * 
     * @return a map containing artifacts for this document.
     */
    Map<String, byte[]> getArtifacts();
}