/*
* This program is free software; you can redistribute it and/or modify it under the
* terms of the GNU Lesser General Public License, version 2.1 as published by the Free Software
* Foundation.
*
* You should have received a copy of the GNU Lesser General Public License along with this
* program; if not, you can obtain a copy at http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html
* or from the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*
* This program 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.
*
* Copyright (c) 2001 - 2009 Object Refinery Ltd, Pentaho Corporation and Contributors.. All rights reserved.
*/
package org.pentaho.reporting.engine.classic.core.states.process;
import org.pentaho.reporting.engine.classic.core.Group;
import org.pentaho.reporting.engine.classic.core.ReportProcessingException;
import org.pentaho.reporting.engine.classic.core.event.ReportEvent;
import org.pentaho.reporting.engine.classic.core.states.ReportState;
import org.pentaho.reporting.engine.classic.core.states.datarow.DefaultFlowController;
/**
* This delays the actual test on whether the current detail-group should be finished until the subreports have been
* processed. The subreports can influence this test by declaring output-parameters.
*
* @author Thomas Morgner
*/
public class JoinEndCrosstabHandler implements AdvanceHandler
{
public static final AdvanceHandler HANDLER = new JoinEndCrosstabHandler();
private JoinEndCrosstabHandler()
{
}
public int getEventCode()
{
return ReportEvent.GROUP_FINISHED | ProcessState.ARTIFICIAL_EVENT_CODE | ReportEvent.CROSSTABBING;
}
public ProcessState advance(final ProcessState state) throws ReportProcessingException
{
final ProcessState next = state.deriveForAdvance();
final DefaultFlowController flowController = next.getFlowController().endCrosstabMode();
next.setFlowController(flowController);
return next;
}
public ProcessState commit(final ProcessState next) throws ReportProcessingException
{
next.leaveGroup();
final DefaultFlowController fc = next.getFlowController();
final boolean advanceRequested = fc.isAdvanceRequested();
final boolean advanceable = fc.getMasterRow().isAdvanceable();
if (isRootGroup(next))
{
// there is no parent group. So if there is more data, print the next header for this group,
// else print the report-footer and finish the report processing.
if (advanceRequested && advanceable)
{
final DefaultFlowController cfc = fc.performCommit();
next.setFlowController(cfc);
next.setAdvanceHandler(BeginCrosstabHandler.HANDLER);
return next;
}
else
{
next.setAdvanceHandler(ReportFooterHandler.HANDLER);
return next;
}
}
if (advanceRequested == false || advanceable == false)
{
// This happens for empty - reports. Empty-Reports are never advanceable, therefore we can
// reach an non-advance state where inner group-footers are printed.
next.setAdvanceHandler(EndGroupHandler.HANDLER);
return next;
}
// This group is not the outer-most group ..
final Group group = next.getReport().getGroup(next.getCurrentGroupIndex());
final DefaultFlowController cfc = fc.performCommit();
if (ProcessState.isLastItemInGroup(group, fc.getMasterRow(), cfc.getMasterRow()))
{
// continue with an other EndGroup-State ...
next.setAdvanceHandler(EndGroupHandler.HANDLER);
return next;
}
else
{
// The parent group is not finished, so finalize the createRollbackInformation.
// more data in parent group, print the next header
next.setFlowController(cfc);
next.setAdvanceHandler(BeginCrosstabHandler.HANDLER);
return next;
}
}
public boolean isFinish()
{
return false;
}
/**
* Checks whether there are more groups active.
*
* @return true if this is the last (outer-most) group.
*/
private boolean isRootGroup(final ProcessState state)
{
return state.getCurrentGroupIndex() == ReportState.BEFORE_FIRST_GROUP;
}
public boolean isRestoreHandler()
{
return false;
}
}