org.jodconverter.DefaultConversionTask Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jodconverter-core Show documentation
Core JODConverter abstractions, used by JODConverter implementations, such as JODConverter Local or JODConverter Remote, used to convert office documents using LibreOffice or Apache OpenOffice.
There is a newer version: 4.4.8
Show newest version
/*
 * Copyright 2004 - 2012 Mirko Nasato and contributors
 *           2016 - 2017 Simon Braconnier and contributors
 *
 * This file is part of JODConverter - Java OpenDocument Converter.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.jodconverter;

import java.io.File;
import java.util.HashMap;
import java.util.Map;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import com.sun.star.lang.XComponent;

import org.jodconverter.document.DocumentFormat;
import org.jodconverter.filter.FilterChain;
import org.jodconverter.office.OfficeContext;
import org.jodconverter.office.OfficeException;

/** Represents the default behavior for a conversion task. */
public class DefaultConversionTask extends AbstractConversionTask {

  private static final Logger logger = LoggerFactory.getLogger(DefaultConversionTask.class);

  private final DocumentFormat inputFormat;
  private final DocumentFormat outputFormat;
  private Map defaultLoadProperties;
  private FilterChain filterChain;

  /**
   * Creates a new conversion task from a specified source to a specified target.
   *
   * @param inputFile source file.
   * @param outputFile target file.
   * @param inputFormat input format.
   * @param outputFormat output format.
   */
  public DefaultConversionTask(
      final File inputFile,
      final File outputFile,
      final DocumentFormat inputFormat,
      final DocumentFormat outputFormat) {
    super(inputFile, outputFile);

    this.inputFormat = inputFormat;
    this.outputFormat = outputFormat;
  }

  @Override
  public void execute(final OfficeContext context) throws OfficeException {

    logger.info("Executing default conversion task...");
    super.execute(context);
  }

  /**
   * Gets the default properties to be applied when the input document is loaded.
   *
   * @return the default properties to be applied when loading the document.
   */
  public Map getDefaultLoadProperties() {

    return defaultLoadProperties;
  }

  /**
   * Gets the filter chain to be applied when modifying the document.
   *
   * @return filterChain to use with this task.
   */
  public FilterChain getFilterChain() {

    return filterChain;
  }

  /**
   * Gets the input document format to convert.
   *
   * @return the input DocumentFormat.
   */
  public DocumentFormat getInputFormat() {
    return inputFormat;
  }

  @Override
  protected Map getLoadProperties() throws OfficeException {

    final Map loadProperties = new HashMap<>();
    if (defaultLoadProperties != null) {
      loadProperties.putAll(defaultLoadProperties);
    }
    if (inputFormat != null && inputFormat.getLoadProperties() != null) {
      loadProperties.putAll(inputFormat.getLoadProperties());
    }
    return loadProperties;
  }

  /**
   * Gets the output document format to convert.
   *
   * @return the output DocumentFormat.
   */
  public DocumentFormat getOutputFormat() {
    return outputFormat;
  }

  @Override
  protected Map getStoreProperties(final XComponent document) throws OfficeException {

    return outputFormat.getStoreProperties(OfficeDocumentUtils.getDocumentFamily(document));
  }

  // Don't allow override
  @Override
  protected final void modifyDocument(final OfficeContext context, final XComponent document)
      throws OfficeException {

    if (filterChain != null) {
      filterChain.doFilter(context, document);
    }
  }

  /**
   * Sets the default properties to be applied when the input document is loaded.
   *
   * @param defaultLoadProperties the default properties to ne applied when loading the document.
   */
  public void setDefaultLoadProperties(final Map defaultLoadProperties) {

    this.defaultLoadProperties = defaultLoadProperties;
  }

  /**
   * Sets the filter chain to be applied when modifying the document.
   *
   * @param filterChain filterChain to use with this task.
   */
  public void setFilterChain(final FilterChain filterChain) {

    this.filterChain = filterChain;
  }
}