297 lines
11 KiB
Python
Executable file
297 lines
11 KiB
Python
Executable file
#
|
|
# Copyright (c) 2012 Helmut Merz helmutm@cy55.de
|
|
#
|
|
# This program is free software; you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation; either version 2 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# 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 General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with this program; if not, write to the Free Software
|
|
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
|
#
|
|
|
|
"""
|
|
Report result sets and related classes.
|
|
"""
|
|
|
|
from copy import copy
|
|
from zope.cachedescriptors.property import Lazy
|
|
|
|
from cybertools.composer.interfaces import IInstance
|
|
from cybertools.composer.report.base import BaseQueryCriteria
|
|
from cybertools.util.jeep import Jeep
|
|
|
|
from loops.common import normalizeName
|
|
|
|
|
|
class BaseRow(object):
|
|
|
|
def __init__(self, context, parent):
|
|
self.context = context
|
|
self.parent = parent
|
|
self.data = {}
|
|
self.sequenceNumber = 0
|
|
self.groupNumbers = dict()
|
|
self.groupSequenceNumber = 0
|
|
self.cssClass = 'row'
|
|
|
|
def getRawValue(self, attr):
|
|
return self.data.get(attr)
|
|
|
|
|
|
class TotalsRow(BaseRow):
|
|
|
|
pass
|
|
|
|
|
|
class Row(BaseRow):
|
|
|
|
attributeHandlers = {}
|
|
cssClass = u''
|
|
rowId = u''
|
|
subTotalRowIds = []
|
|
|
|
def getRawValue(self, attr):
|
|
return self.attributeHandlers.get(
|
|
attr, self.getContextAttr)(self, attr)
|
|
|
|
@staticmethod
|
|
def getContextAttr(obj, attr):
|
|
return getattr(obj.context, attr)
|
|
|
|
def getGroupFields(self):
|
|
return [self.getRawValue(f.name) for f in
|
|
self.parent.context.fields if 'group' in f.executionSteps]
|
|
|
|
@Lazy
|
|
def displayedColumns(self):
|
|
return self.parent.context.getActiveOutputFields()
|
|
|
|
@Lazy
|
|
def allColumns(self):
|
|
return self.parent.context.getAllFields()
|
|
|
|
def useRowProperty(self, attr):
|
|
return getattr(self, attr)
|
|
|
|
|
|
class GroupHeaderRow(BaseRow):
|
|
|
|
sourceField = ''
|
|
|
|
def getRawValue(self, attr):
|
|
return self.data.get(attr, u'')
|
|
|
|
@Lazy
|
|
def displayedColumns(self):
|
|
fields = self.parent.context.getActiveOutputFields()
|
|
for col in self.headerColumns:
|
|
for idx, f in enumerate(fields):
|
|
if f.name == col.name:
|
|
fields[idx] = col
|
|
return fields
|
|
|
|
|
|
class SubTotalsRow(BaseRow):
|
|
|
|
def getRawValue(self, attr):
|
|
return self.data.get(attr, u'')
|
|
|
|
@Lazy
|
|
def displayedColumns(self):
|
|
fields = self.parent.context.getActiveOutputFields()
|
|
if not self.subTotalsGroupColumns:
|
|
return fields
|
|
for col in self.subTotalsGroupColumns:
|
|
for idx, f in enumerate(fields):
|
|
if f.name == col.name:
|
|
fields[idx] = col
|
|
return fields
|
|
|
|
|
|
class ResultSet(object):
|
|
|
|
def __init__(self, context, data,
|
|
rowFactory=Row, headerRowFactory=GroupHeaderRow,
|
|
sortCriteria=None, queryCriteria=BaseQueryCriteria(),
|
|
limits=None):
|
|
self.context = context # the report or report instance
|
|
self.data = data
|
|
self.rowFactory = rowFactory
|
|
self.headerRowFactory = headerRowFactory
|
|
self.sortCriteria = sortCriteria
|
|
self.queryCriteria = queryCriteria
|
|
self.limits = limits
|
|
self.totals = TotalsRow(None, self)
|
|
|
|
def getHeaderRow(self, row, columns):
|
|
headerRow = self.headerRowFactory(None, self)
|
|
headerRow.cssClass = 'headerRow'
|
|
headerRow.headerColumns = []
|
|
for c in columns:
|
|
if c.output:
|
|
headerRow.data[c.output] = c.getRawValue(row)
|
|
headerRow.sourceField = c.name
|
|
headerColumn = copy(c)
|
|
headerColumn.__name__ = c.output
|
|
headerColumn.cssClass = c.cssClass
|
|
headerRow.headerColumns.append(headerColumn)
|
|
if headerColumn.groupHeaderColspan is not None:
|
|
colNames = [col.name for col in self.displayedColumns]
|
|
nextColumns = [col for col in self.displayedColumns
|
|
if colNames.index(col.name) > colNames.index(c.output)]
|
|
for i in range(headerColumn.groupHeaderColspan - 1):
|
|
nextColumn = copy(nextColumns[i])
|
|
nextColumn.groupHeaderHidden = True
|
|
headerRow.headerColumns.append(nextColumn)
|
|
return headerRow
|
|
|
|
def getSubTotalsRow(self, gf, row, columns, values):
|
|
if not gf.name in ','.join([','.join(c.totals) for c in columns]).split(','):
|
|
return None
|
|
subTotalsRow = SubTotalsRow(None, self)
|
|
subTotalsRow.subTotalsGroupColumns = []
|
|
rowId = '%s-%s' % (gf.name, normalizeName(gf.getRawValue(row)))
|
|
rowId = rowId.replace('.', '_')
|
|
subTotalsRow.cssClass = 'subTotalsRow ' + rowId
|
|
for idx, c in enumerate(columns):
|
|
subTotalsRow.data[c.name] = values[idx]
|
|
if gf in self.subTotalsGroupColumns:
|
|
if gf.totalsDescription is None:
|
|
display = gf.getDisplayValue(row)
|
|
if isinstance(display, dict):
|
|
display = display.get('title')
|
|
subTotalsRow.data[gf.output] = u'SUMME: ' + display
|
|
else:
|
|
v = gf.totalsDescription.getDisplayValue(row)
|
|
if isinstance(v, dict):
|
|
v = v.get('title', '')
|
|
if v is None:
|
|
v = u''
|
|
subTotalsRow.data[gf.totalsDescription.output] = v
|
|
if gf.groupHeaderColspan is not None:
|
|
colNames = [col.name for col in self.displayedColumns]
|
|
for col in self.displayedColumns:
|
|
sCol = copy(col)
|
|
if colNames.index(col.name) > colNames.index(gf.output):
|
|
if colNames.index(col.name) < colNames.index(gf.output) + gf.groupHeaderColspan:
|
|
sCol.groupHeaderHidden = True
|
|
if col.name == gf.output:
|
|
sCol.groupHeaderColspan = gf.groupHeaderColspan
|
|
subTotalsRow.subTotalsGroupColumns.append(sCol)
|
|
return subTotalsRow
|
|
|
|
def getResult(self):
|
|
result = [self.rowFactory(item, self) for item in self.data]
|
|
result = [row for row in result if self.queryCriteria.check(row)]
|
|
if self.sortCriteria:
|
|
result.sort(key=lambda x:
|
|
[f.getSortValue(x) for f in self.sortCriteria])
|
|
if self.groupColumns:
|
|
res = []
|
|
groupValues = [None for f in self.groupColumns]
|
|
subTotals = [[0.0 for f in stc] for stc in self.subTotalsColumns]
|
|
lastRow = None
|
|
for row in result:
|
|
subTotalsRows = []
|
|
headerRows = []
|
|
for idx, f in enumerate(self.groupColumns):
|
|
value = f.getRawValue(row)
|
|
if value != groupValues[idx]:
|
|
# TODO: loop through all lower-level fields
|
|
# for j, f in enumerate(self.groupColumns)[idx:]:
|
|
# # use idx+j for correct indexing
|
|
groupValues[idx] = value
|
|
headerRows.append(self.getHeaderRow(row, (f,) + f.outputWith))
|
|
if lastRow is not None and f.getDisplayValue(lastRow):
|
|
subTr = self.getSubTotalsRow(f, lastRow,
|
|
self.subTotalsColumns[idx], subTotals[idx])
|
|
if subTr is not None:
|
|
subTotalsRows.append(subTr)
|
|
subTotals[idx] = [0.0 for f in self.subTotalsColumns[idx]]
|
|
for subTotalsRow in reversed(subTotalsRows):
|
|
res.append(subTotalsRow)
|
|
for headerRow in headerRows:
|
|
res.append(headerRow)
|
|
res.append(row)
|
|
for idx, sc in enumerate(self.subTotalsColumns):
|
|
for idx2, f in enumerate(sc):
|
|
subTotals[idx][idx2] += f.getValue(row,
|
|
ignoreTotals=True)
|
|
lastRow = row
|
|
if lastRow is not None:
|
|
subTotalsRows = []
|
|
for idx, f in enumerate(self.groupColumns):
|
|
if f.getDisplayValue(lastRow):
|
|
subTr = self.getSubTotalsRow(f, lastRow,
|
|
self.subTotalsColumns[idx], subTotals[idx])
|
|
if subTr is not None:
|
|
subTotalsRows.append(subTr)
|
|
for subTotalsRow in reversed(subTotalsRows):
|
|
res.append(subTotalsRow)
|
|
result = res
|
|
if self.limits:
|
|
start, stop = self.limits
|
|
result = result[start:stop]
|
|
number = 0
|
|
groupNumbers = dict()
|
|
groupSequenceNumber = 0
|
|
for idx, row in enumerate(result):
|
|
if not isinstance(row, (GroupHeaderRow, SubTotalsRow)):
|
|
row.sequenceNumber = number + 1
|
|
number += 1
|
|
row.groupNumbers = copy(groupNumbers)
|
|
row.groupSequenceNumber = copy(groupSequenceNumber)
|
|
groupSequenceNumber = groupSequenceNumber + 1
|
|
for idx, f in enumerate(self.groupColumns):
|
|
name = f.name
|
|
value = normalizeName(f.getRawValue(row))
|
|
if isinstance(value, basestring):
|
|
value = value.replace('.', '_')
|
|
row.subTotalRowIds = copy(row.subTotalRowIds) +\
|
|
['%s-%s' % (name, value)]
|
|
elif isinstance(row, GroupHeaderRow):
|
|
sourceField = row.sourceField
|
|
groupNumbers[sourceField] = \
|
|
groupNumbers.get(sourceField, 0) + 1
|
|
groupSequenceNumber = 0
|
|
return result
|
|
|
|
@Lazy
|
|
def result(self):
|
|
return self.getResult()
|
|
|
|
def __iter__(self):
|
|
return iter(self.result)
|
|
|
|
def first(self):
|
|
if len(self.result) > 0:
|
|
return self.result[0]
|
|
return self.rowFactory(None, self)
|
|
|
|
@Lazy
|
|
def displayedColumns(self):
|
|
return Jeep(self.context.getActiveOutputFields())
|
|
|
|
@Lazy
|
|
def groupColumns(self):
|
|
return self.context.getGroupFields()
|
|
|
|
@Lazy
|
|
def subTotalsColumns(self):
|
|
return self.context.getSubTotalsFields()
|
|
|
|
@Lazy
|
|
def subTotalsGroupColumns(self):
|
|
return self.context.getSubTotalsGroupFields()
|
|
|
|
|
|
def getOutputColumnsForField(self, f):
|
|
return self.context.getOutputFieldsForField(f)
|
|
|