/*!
* 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) 2002-2013 Pentaho Corporation.. All rights reserved.
*/
package org.pentaho.reporting.engine.classic.extensions.datasources.mondrian;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import javax.swing.table.AbstractTableModel;
import mondrian.olap.Axis;
import mondrian.olap.Cell;
import mondrian.olap.Dimension;
import mondrian.olap.Member;
import mondrian.olap.Position;
import mondrian.olap.Result;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.pentaho.reporting.engine.classic.core.MetaAttributeNames;
import org.pentaho.reporting.engine.classic.core.MetaTableModel;
import org.pentaho.reporting.engine.classic.core.util.CloseableTableModel;
import org.pentaho.reporting.engine.classic.core.util.IntList;
import org.pentaho.reporting.engine.classic.core.wizard.DataAttributes;
import org.pentaho.reporting.engine.classic.core.wizard.DefaultConceptQueryMapper;
import org.pentaho.reporting.engine.classic.core.wizard.DefaultDataAttributes;
import org.pentaho.reporting.engine.classic.core.wizard.EmptyDataAttributes;
import org.pentaho.reporting.engine.classic.extensions.datasources.mondrian.util.ResultSetProcessingLib;
import org.pentaho.reporting.libraries.base.util.ArgumentNullException;
/**
* This tablemodel performs some preprocessing to get multi-dimensional resultset (with row and column headers) into a
* classical table-structure. The query must be a two-dimensional query or the whole process will break.
* <p/>
* This class exists for legacy reasons to provide existing reports the same view on MDX data as implemented in the
* Pentaho-Platform and the Report-Designer. It can also be somewhat useful if you have a requirement to produce banded
* reporting over a MDX data source.
*
* @author : Thomas Morgner
*/
@SuppressWarnings({"UnnecessaryUnboxing"})
public class BandedMDXTableModel extends AbstractTableModel implements CloseableTableModel, MetaTableModel
{
private static final Log logger = LogFactory.getLog(DenormalizedMDXTableModel.class);
private Result resultSet;
private int rowCount;
private int columnCount;
private int[] axesSize;
private IntList columnToAxisPosition;
private List<Member> columnToMemberMapping;
private List<String> columnNames;
@Deprecated
public BandedMDXTableModel(final Result resultSet, final int rowLimit)
{
this(resultSet, rowLimit, false);
}
public BandedMDXTableModel(final Result resultSet, final int rowLimit,
final boolean membersOnAxisSorted)
{
ArgumentNullException.validate("resultSet", resultSet);
this.resultSet = resultSet;
// rowcount is the product of all axis-sizes. If an axis contains more than one member, then
// Mondrian already performs the crossjoin for us.
// column count is the sum of the maximum of all hierachy levels of all axis.
final Axis[] axes = this.resultSet.getAxes();
this.axesSize = ResultSetProcessingLib.computeItemsPerAxis(axes);
this.rowCount = computeRowCount(axesSize);
final int[] axesMembers = ResultSetProcessingLib.computeTotalColumnsPerAxis(axes, 1, membersOnAxisSorted);
this.columnCount = computeColumnCount(axesMembers, this.axesSize);
this.columnToAxisPosition = ResultSetProcessingLib.computeColumnToAxisMapping(axes, axesMembers, columnCount, 1);
this.columnToMemberMapping = Collections.unmodifiableList
(ResultSetProcessingLib.computeColumnToMemberMapping(axes, axesMembers, 1, membersOnAxisSorted));
this.columnNames = computeColumnNames(axes, columnToMemberMapping);
if (rowLimit > 0)
{
rowCount = Math.min(rowLimit, rowCount);
}
}
protected int computeColumnCount(final int[] axesMembers, final int[] axesSize)
{
if (axesSize.length == 0)
{
return 1;
}
int columnCount = axesSize[0];
for (int i = 1; i < axesMembers.length; i++)
{
columnCount += axesMembers[i];
}
return columnCount;
}
protected int computeRowCount(final int[] axesSize)
{
if (axesSize.length > 1)
{
int rowCount = axesSize[1];
for (int i = 2; i < axesSize.length; i++)
{
final int size = axesSize[i];
rowCount *= size;
}
return rowCount;
}
else
{
// special case of having only members on the column axis (but not on row or higher)
// or having no member on any axis at all
return 1;
}
}
protected List<String> computeColumnNames(final Axis[] axes,
final List<Member> columnToMemberMapper)
{
ArrayList<String> columnNames = new ArrayList<String>();
for (final Member member : columnToMemberMapper)
{
columnNames.add(member.getLevel().getUniqueName());
}
if (axes.length > 0)
{
// now create the column names for the column-axis
final Axis axis = axes[0];
final List<Position> positions = axis.getPositions();
for (int i = 0; i < positions.size(); i++)
{
final Position position = positions.get(i);
columnNames.add(ResultSetProcessingLib.computeUniqueColumnName(position));
}
}
else
{
columnNames.add("Measure");
}
return Collections.unmodifiableList(columnNames);
}
public int getRowCount()
{
return rowCount;
}
public int getColumnCount()
{
return columnCount;
}
/**
* Returns a default name for the column using spreadsheet conventions: A, B, C, ... Z, AA, AB, etc. If
* <code>column</code> cannot be found, returns an empty string.
*
* @param column the column being queried
* @return a string containing the default name of <code>column</code>
*/
public String getColumnName(final int column)
{
return columnNames.get(column);
}
public Object getValueAt(final int rowIndex,
final int columnIndex)
{
if (columnIndex >= columnNames.size())
{
throw new IndexOutOfBoundsException();
}
if (isMeasureColumn(columnIndex))
{
final int[] cellKey = computeCellKey(rowIndex, columnIndex);
final Cell cell = resultSet.getCell(cellKey);
if (cell.isNull())
{
return null;
}
return cell.getValue();
}
final int[] cellKey = computeCellKey(rowIndex, columnIndex);
Member candidateMember = getCandidateMembers(columnIndex, cellKey);
if (candidateMember != null)
{
return candidateMember.getName();
}
return null;
}
public Class<?> getColumnClass(final int columnIndex)
{
if (getRowCount() == 0)
{
return Object.class;
}
try
{
final Object targetClassObj = getValueAt(0, columnIndex);
if (targetClassObj == null)
{
return Object.class;
}
else
{
return targetClassObj.getClass();
}
}
catch (Exception e)
{
return Object.class;
}
}
private int[] computeCellKey(final int rowIndex, final int columnIndex)
{
final int[] cellKey = new int[axesSize.length];
if (axesSize.length == 0)
{
return cellKey;
}
final int correctedColIndex;
if (axesSize.length > 0)
{
final int startOfColumnIndex = columnCount - axesSize[0];
if (columnIndex < startOfColumnIndex)
{
// this is a query for a axis-header
correctedColIndex = -1;
}
else
{
correctedColIndex = columnIndex - startOfColumnIndex;
}
}
else
{
correctedColIndex = 0;
}
cellKey[0] = correctedColIndex;
int tmpRowIdx = rowIndex;
for (int i = 1; i < axesSize.length; i++)
{
final int axisSize = axesSize[i];
if (axisSize == 0)
{
cellKey[i] = 0;
}
else
{
final int pos = tmpRowIdx % axisSize;
cellKey[i] = pos;
tmpRowIdx = tmpRowIdx / axisSize;
}
}
return cellKey;
}
private Member getCandidateMembers(final int columnIndex,
final int[] cellKey)
{
final int axisIndex = columnToAxisPosition.get(columnIndex);
final Axis[] axes = resultSet.getAxes();
final Axis axis = axes[axisIndex];
final List<Position> positionList = axis.getPositions();
if (positionList.isEmpty())
{
return null;
}
final int posIndex = cellKey[axisIndex];
final Position position = positionList.get(posIndex);
final Member memberByName = findMemberByName(position, columnIndex);
if (memberByName != null)
{
return memberByName;
}
return findRootMember(position, columnIndex);
}
private Member findRootMember(final List<Member> position, final int columnIndex)
{
final Dimension dimension = columnToMemberMapping.get(columnIndex).getDimension();
for (int i = 0; i < position.size(); i++)
{
final Member member = position.get(i);
if (dimension.equals(member.getDimension()))
{
if (member.getParentMember() == null)
{
return member;
}
}
}
return null;
}
private Member findMemberByName(final List<Member> position, final int columnIndex)
{
final Dimension dimension = columnToMemberMapping.get(columnIndex).getDimension();
for (int i = 0; i < position.size(); i++)
{
final Member member = position.get(i);
if (dimension.equals(member.getDimension()))
{
Member match = searchContextMemberOfParents(member, columnIndex);
if (match != null)
{
return match;
}
}
}
return null;
}
private Member searchContextMemberOfParents(final Member member, final int columnIndex)
{
String columnName = getColumnName(columnIndex);
Member candidate = member;
while (candidate != null)
{
if (candidate.getLevel().getUniqueName().equals(columnName))
{
return candidate;
}
candidate = candidate.getParentMember();
}
return null;
}
public void close()
{
resultSet.close();
}
/**
* Returns the meta-attribute as Java-Object. The object type that is expected by the report engine is defined in the
* TableMetaData property set. It is the responsibility of the implementor to map the native meta-data model into a
* model suitable for reporting.
* <p/>
* Meta-data models that only describe meta-data for columns can ignore the row-parameter.
*
* @param rowIndex the row of the cell for which the meta-data is queried.
* @param columnIndex the index of the column for which the meta-data is queried.
* @return the meta-data object.
*/
public DataAttributes getCellDataAttributes(final int rowIndex, final int columnIndex)
{
if (columnIndex >= columnNames.size())
{
throw new IndexOutOfBoundsException();
}
if (isMeasureColumn(columnIndex))
{
final int[] cellKey = computeCellKey(rowIndex, columnIndex);
final Cell cell = resultSet.getCell(cellKey);
return new MDXMetaDataCellAttributes(EmptyDataAttributes.INSTANCE, cell);
}
final int[] cellKey = computeCellKey(rowIndex, columnIndex);
Member contextMember = getCandidateMembers(columnIndex, cellKey);
if (contextMember != null)
{
return new MDXMetaDataMemberAttributes(EmptyDataAttributes.INSTANCE, contextMember);
}
return EmptyDataAttributes.INSTANCE;
}
private boolean isMeasureColumn(final int columnIndex)
{
if (columnIndex >= columnToMemberMapping.size())
{
return true;
}
return false;
}
public boolean isCellDataAttributesSupported()
{
return true;
}
public DataAttributes getColumnAttributes(final int column)
{
return EmptyDataAttributes.INSTANCE;
}
/**
* Returns table-wide attributes. This usually contain hints about the data-source used to query the data as well as
* hints on the sort-order of the data.
*
* @return the table attributes.
*/
public DataAttributes getTableAttributes()
{
final DefaultDataAttributes dataAttributes = new DefaultDataAttributes();
dataAttributes.setMetaAttribute(MetaAttributeNames.Core.NAMESPACE,
MetaAttributeNames.Core.CROSSTAB_MODE, DefaultConceptQueryMapper.INSTANCE, MetaAttributeNames.Core.CROSSTAB_VALUE_NORMALIZED);
return dataAttributes;
}
}