Package ca.spatial.reportwriter

Class PivotFieldParams

java.lang.Object

ca.spatial.reportwriter.PivotFieldParams

public class PivotFieldParams
extends Object

This class supports setting parameters and options on fields in a pivot table

Method Summary

Modifier and Type	Method	Description
PivotFieldParams	andMode(boolean state)	Specify if multiple filters should be and'ed together.
PivotFieldParams	customSubtotals(String[] customSubtotals)	Set the list of summaries that will be used if the summary type is set to "custom".
PivotFieldParams	customSubtotalsForColumn(String[] customSubtotalsForColumn)
PivotFieldParams	customSubtotalsForRow(String[] customSubtotalsForRow)
PivotFieldParams	dataFieldFilterOnSummary(boolean state)
PivotFieldParams	filter(boolean[] values)
PivotFieldParams	filter(double[] values)
PivotFieldParams	filter(float[] values)
PivotFieldParams	filter(int[] values)
PivotFieldParams	filter(com.jidesoft.filter.Filter filter)
PivotFieldParams	filter(Object[] values)
PivotFieldParams	filterBaseValues(Object[] baseValues)
PivotFieldParams	filterField(String filterField)
String	getName()	Get the name of the field that will supply the data
String	getTitle()	Get the title of this field, as it show up in the report
PivotFieldParams	grandTotalSummaryType(String grandTotalSummaryType)
PivotFieldParams	hideOriginalData(boolean state)
PivotFieldParams	runningSummary()
PivotFieldParams	runningSummary(String type, String baseOn, String rangeIn, String compareTo)
PivotFieldParams	separateSubtotalSettings(boolean state)
PivotFieldParams	sortByAscending(boolean state)
PivotFieldParams	sortByColumnKeys(Object[] values)
PivotFieldParams	sortByDataFieldModelIndex(int sortByDataFieldModelIndex)
PivotFieldParams	sortByRowKeys(Object[] values)
PivotFieldParams	sortBySummaryType(String sortBySummaryType)
PivotFieldParams	sortOrder(String sortOrder)
PivotFieldParams	statisticsCalculationType(String statisticsCalculationType)
PivotFieldParams	subtotalLocation(String subtotalLocation)
PivotFieldParams	subtotalSummaryType(String subtotalSummaryType)
PivotFieldParams	subtotalType(String subtotalType)
PivotFieldParams	subtotalTypeForColumn(String subtotalTypeForColumn)
PivotFieldParams	subtotalTypeForRow(String subtotalTypeForRow)
PivotFieldParams	summaryType(String summaryType)
PivotFieldParams	title(String title)
String	toString()
PivotFieldParams	valueFilters(com.jidesoft.filter.Filter[] valueFilters)
PivotFieldParams	weightColumn(String weightColumn)

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

getName

public String getName()

Get the name of the field that will supply the data

getTitle

public String getTitle()

Get the title of this field, as it show up in the report

andMode

public PivotFieldParams andMode(boolean state)

Specify if multiple filters should be and'ed together. If false the the fields will be or'ed together.

customSubtotals

public PivotFieldParams customSubtotals(String[] customSubtotals)

Set the list of summaries that will be used if the summary type is set to "custom".

customSubtotalsForRow

public PivotFieldParams customSubtotalsForRow(String[] customSubtotalsForRow)

customSubtotalsForColumn

public PivotFieldParams customSubtotalsForColumn(String[] customSubtotalsForColumn)

dataFieldFilterOnSummary

public PivotFieldParams dataFieldFilterOnSummary(boolean state)

filter

public PivotFieldParams filter(com.jidesoft.filter.Filter filter)

filter

public PivotFieldParams filter(int[] values)

filter

public PivotFieldParams filter(float[] values)

filter

public PivotFieldParams filter(double[] values)

filter

public PivotFieldParams filter(boolean[] values)

filter

public PivotFieldParams filter(Object[] values)

grandTotalSummaryType

public PivotFieldParams grandTotalSummaryType(String grandTotalSummaryType)

hideOriginalData

public PivotFieldParams hideOriginalData(boolean state)

runningSummary

public PivotFieldParams runningSummary()

separateSubtotalSettings

public PivotFieldParams separateSubtotalSettings(boolean state)

sortByAscending

public PivotFieldParams sortByAscending(boolean state)

sortByDataFieldModelIndex

public PivotFieldParams sortByDataFieldModelIndex(int sortByDataFieldModelIndex)

sortByColumnKeys

public PivotFieldParams sortByColumnKeys(Object[] values)

sortByRowKeys

public PivotFieldParams sortByRowKeys(Object[] values)

sortBySummaryType

public PivotFieldParams sortBySummaryType(String sortBySummaryType)

sortOrder

public PivotFieldParams sortOrder(String sortOrder)

statisticsCalculationType

public PivotFieldParams statisticsCalculationType(String statisticsCalculationType)

subtotalLocation

public PivotFieldParams subtotalLocation(String subtotalLocation)

subtotalSummaryType

public PivotFieldParams subtotalSummaryType(String subtotalSummaryType)

subtotalType

public PivotFieldParams subtotalType(String subtotalType)

subtotalTypeForColumn

public PivotFieldParams subtotalTypeForColumn(String subtotalTypeForColumn)

subtotalTypeForRow

public PivotFieldParams subtotalTypeForRow(String subtotalTypeForRow)

summaryType

public PivotFieldParams summaryType(String summaryType)

title

public PivotFieldParams title(String title)

filterField

public PivotFieldParams filterField(String filterField)

filterBaseValues

public PivotFieldParams filterBaseValues(Object[] baseValues)

valueFilters

public PivotFieldParams valueFilters(com.jidesoft.filter.Filter[] valueFilters)

runningSummary

public PivotFieldParams runningSummary(String type,
 String baseOn,
 String rangeIn,
 String compareTo)

weightColumn

public PivotFieldParams weightColumn(String weightColumn)

toString

public String toString()

Overrides:

toString in class Object