/*
 * Copyright (c) 2005-2016 Vincent Vandenschrick. All rights reserved.
 *
 *  This file is part of the Jspresso framework.
 *
 *  Jspresso 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 3 of the License, or
 *  (at your option) any later version.
 *
 *  Jspresso 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 Jspresso.  If not, see <http://www.gnu.org/licenses/>.
 */
package org.jspresso.framework.application.printing.frontend.action;

import java.util.Map;

import org.jspresso.framework.action.IActionHandler;
import org.jspresso.framework.application.printing.model.IReport;
import org.jspresso.framework.application.printing.model.descriptor.IReportDescriptor;
import org.jspresso.framework.model.entity.IEntity;

/**
 * This action generates and displays a report that is statically configured
 * through the {@code reportDescriptor} parameter. The report context is
 * augmented with the identifier of the entity that is selected in the view were
 * the action is installed, under the key {@code ENTITY_ID}.
 *
 * @author Vincent Vandenschrick
 * @param <E>
 *          the actual gui component type used.
 * @param <F>
 *          the actual icon type used.
 * @param <G>
 *          the actual action type used.
 */
public class StaticReportAction<E, F, G> extends AbstractReportAction<E, F, G> {

  private IReportDescriptor reportDescriptor;

  /**
   * Configures the report to execute.
   *
   * @param reportDescriptor
   *          the reportDescriptor to set.
   */
  public void setReportDescriptor(IReportDescriptor reportDescriptor) {
    this.reportDescriptor = reportDescriptor;
  }

  /**
   * {@inheritDoc}
   */
  @Override
  protected Map<String, Object> getInitialReportContext(
      IActionHandler actionHandler, Map<String, Object> context) {
    Map<String, Object> initialReportContext = super.getInitialReportContext(
        actionHandler, context);
    Object model = getSelectedModel(context);
    if (model instanceof IEntity) {
      initialReportContext.put(IReportDescriptor.ENTITY_ID,
          ((IEntity) model).getId());
    }
    return initialReportContext;
  }

  /**
   * Gets the report to execute out of the model connector.
   * <p>
   * {@inheritDoc}
   */
  @Override
  protected IReport getReportToExecute(IActionHandler actionHandler,
      Map<String, Object> context) {
    IReport report = getReportFactory().createReportInstance(reportDescriptor,
        getTranslationProvider(context), getLocale(context));
    return report;
  }
}