EDIT

/**

 * Copyright (C) 2007 EDIT

 * http://www.e-taxonomy.eu

 * The contents of this file are subject to the Mozilla Public License Version 1.1

 * See LICENSE.TXT at the top of this package for the full license terms.

 */

package eu.etaxonomy.cdm.print;

import java.io.File;

import java.util.List;

import java.util.UUID;

import org.jdom.Element;

import eu.etaxonomy.cdm.api.application.CdmApplicationController;

/**

 * This class holds the complete configuration for the print publishing process.

 * All aspects of the process are defined here.

 * @author n.hoffmann

 * @since Aug 3, 2010

 */

public class PublishConfigurator implements Serializable {

	private static final long serialVersionUID = 4896190792717383839L;

	private boolean doSynonymy = true;

	private boolean doDescriptions = true;

	private boolean doPolytomousKey = true;

	private UUID featureTreeUuid;

	/**

	 * Creates a new instance connected to the given application controller.

	 * @param applicationConfiguration

	 * @return

	 */

	/**

	 * Creates a new instance, ready to be connected to a CDM Community Stores

	 * access point.

	 * @return

	 */

	public static PublishConfigurator NewRemoteInstance() {

	/**

	 * Returns the CDM Community Stores access point connected to this

	 * configuration.

	 * @return the access points url or null if this configurator is configured

	 *         to be local.

	 */

	/**

	 * Returns a list of taxon node elements that should be processed by the

	 * print publisher.

	 * @return a list of elements

	 */

	public List<Element> getSelectedTaxonNodeElements() {

	/**

	 * Set the list of taxon node elements that should be processed by the print

	 * publisher.

	 * @see {@link #getSelectedTaxonNodeElements()}

	 * @param selectedTaxonNodeElements

	 */

	/**

	 * Add a taxon node element to list of taxon nodes that will be processed by

	 * the print publisher.

	 * @see {@link #getSelectedTaxonNodeElements()}

	 * @param selectedTaxonNodeElement

	 */

	/**

	 * Whether to export descriptions.

	 * @return

	 */

	public boolean isDoDescriptions() {

	/**

	 * Whether to export images

	 * @return

	 */

	public boolean isDoImages() {

	/**

	 * The folder, the produced output will be written to.

	 * @return the exportFile

	 */

	public File getExportFolder() {

	/**

	 * Returns a list of output modules. The print publisher will export into

	 * the formats defined by these output modules

	 * @see {@link IPublishOutputModule} and implementations thereof

	 * @return the outputModules

	 */

	/**

	 * Adds an output modules to this configurators list of output modules.

	 * @see {@link IPublishOutputModule} and implementations thereof

	 * @param module

	 */

	/**

	 * Whether this configurator is connected to a remote CDM Community Store

	 * @return

	 */

	public boolean isRemote() {

	/**

	 * Whether this configurator is connected to a local application controller.

	 * @return

	 */

	public boolean isLocal() {

	 * Returns a {@link RemoteXMLEntityFactory} if <code>this</code> is a remote

	 * instance or a {@link LocalXMLEntityFactory} if <code>this</code> is a

	 * local instance

	 * @return an {@link IXMLEntityFactory}

	 */

	public IXMLEntityFactory getFactory() {

	/**

	 * FIXME this is a dummy implementation

	 * @return

	 */

	public int calculateNumberOfNodes() {

	 * Whether taxonomically included taxa for the

	 * {@linkplain #getSelectedTaxonNodeElements() selected taxon nodes} should

	 * be exported recursively.

	 * @return <code>true</code> if this is desired

	 */

	public boolean isDoPublishEntireBranches() {

	/**

	 * Whether the synonymy should be exported.

	 * @return <code>true</code> if this is desired

	 */

	public boolean isDoSynonymy() {

	/**

	 * The {@linkplain CdmApplicationController application controller}

	 * associated with this instance

	 * @return the {@link CdmApplicationController} or null if <code>this</code>

	 *         is a {@linkplain #isRemote() remote} instance

	 */

	/**

	 * The feature tree configures which features and in which order and nesting

	 * will be exported by the application

	 * @return the featureTrees uuid

	 */

	public UUID getFeatureTreeUuid() {