jet.api

Class CTAggFieldInfo

java.lang.Object

jet.api.CTAggFieldInfo

Direct Known Subclasses:

CTSpecialFldInfo

public class CTAggFieldInfo
extends java.lang.Object

The class CTAggFieldInfo defines the information of aggregate field in crosstab. There are three kinds of aggregate field in a crosstab. An aggregate field could be presented as a set of query field(or a BV Detail filed) and the aggregate function, like Sum(Sales) which is indicated by a query field's mapping name or Sum(Orders.Salea) which is indicated by a BV Detail field's qualify display name; An aggregate field could be a BV aggregation field directly; An aggregate field also could be a proper crosstab formula. For example, creating a query based crosstab aggregate field: CTAggFieldInfo sum = new CTAggFieldInfo("Agg1","Sales", CTAggFieldInfo.SUM); Or creating a BV based crosstab aggregate field with a BV detail: CTAggFieldInfo sum = new CTAggFieldInfo("Agg1",null, CTAggFieldInfo.SUM); sum.setBlName("Orders Detail.Cost"); Or creating a BV based crosstab aggregate field with a BV aggregation: CTAggFieldInfo sum = new CTAggFieldInfo("Agg1",null, -1); sum.setBlName("Orders Detail.Total Sales"); sum.setAggregationType(CTAggFieldInfo.USE_AGGREGATION);

Field Summary

Fields

Modifier and Type	Field and Description
static int	AVERAGE The function type values.
static int	COUNT The function type values.
static int	DISTINCTCOUNT The function type values.
static int	DISTINCTSUM The function type values.
static int	MAXIMUM The function type values.
static int	MINIMUM The function type values.
static int	POPULATIONSTDDEV The function type values.
static int	POPULATIONVARIANCE The function type values.
static int	RUNNING_AVERAGE The function type values.
static int	RUNNING_COUNT The function type values.
static int	RUNNING_DISTINCTCOUNT The function type values.SUM
static int	RUNNING_MAXIMUM The function type values.
static int	RUNNING_MINIMUM The function type values.
static int	RUNNING_SUM The function type values.
static int	SQRSUM The function type values.
static int	STDDEV The function type values.
static int	SUM The function type values.
static int	USE_AGGREGATION The Aggregation type value.
static int	USE_CTF The Aggregation type value.
static int	USE_FIELDNAME_FUNCTION The Aggregation type value.
static int	VARIANCE The function type values.

Constructor Summary

Constructors

Constructor and Description
CTAggFieldInfo(java.lang.String name, java.lang.String mapping, int func) Constructor.
CTAggFieldInfo(java.lang.String name, java.lang.String mapping, int func, int index) Constructor.
CTAggFieldInfo(java.lang.String name, java.lang.String mapping, int func, int index, java.lang.String label) Constructor.

Method Summary

Modifier and Type	Method and Description
CTSpecialFldInfo	createCTSpecialFldInfo(java.lang.String label, int breakBy, int refer, int function, boolean isRowDirection) Creates a related comparison aggregate field's information.
int	getAggregationType() Gets the aggregate field's type.
java.lang.String	getBlName() Gets the BC/RC name or the BusinessView name of the aggregate field.
java.lang.String	getCTFName() Gets the crossstab formula name of the aggregate field.
java.util.Vector<java.lang.String>	getDistinctOn()
static int	getType(java.lang.String typeN) Gets the int value of the function context.
void	setAggregationType(int aggType) Sets the aggregate field's type.
void	setBlName(java.lang.String blName) Sets the BC/RC name or the BusinessView name of the aggregate field.
void	setCTFName(java.lang.String ctfName) Sets the crossstab formula name of the aggregate field.
void	setDistinctOn(java.util.Vector<java.lang.String> distinctOn)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

COUNT

public static final int COUNT

The function type values.

SUM

public static final int SUM

The function type values.

MINIMUM

public static final int MINIMUM

The function type values.

MAXIMUM

public static final int MAXIMUM

The function type values.

DISTINCTCOUNT

public static final int DISTINCTCOUNT

The function type values.

AVERAGE

public static final int AVERAGE

The function type values.

SQRSUM

public static final int SQRSUM

The function type values.

POPULATIONSTDDEV

public static final int POPULATIONSTDDEV

The function type values.

POPULATIONVARIANCE

public static final int POPULATIONVARIANCE

The function type values.

STDDEV

public static final int STDDEV

The function type values.

VARIANCE

public static final int VARIANCE

The function type values.

RUNNING_COUNT

public static final int RUNNING_COUNT

The function type values.

RUNNING_SUM

public static final int RUNNING_SUM

The function type values.

RUNNING_MINIMUM

public static final int RUNNING_MINIMUM

The function type values.

RUNNING_MAXIMUM

public static final int RUNNING_MAXIMUM

The function type values.

RUNNING_DISTINCTCOUNT

public static final int RUNNING_DISTINCTCOUNT

The function type values.SUM

RUNNING_AVERAGE

public static final int RUNNING_AVERAGE

The function type values.

DISTINCTSUM

public static final int DISTINCTSUM

The function type values.

USE_FIELDNAME_FUNCTION

public static final int USE_FIELDNAME_FUNCTION

The Aggregation type value.

USE_AGGREGATION

public static final int USE_AGGREGATION

The Aggregation type value.

USE_CTF

public static final int USE_CTF

The Aggregation type value.

Constructor Detail

CTAggFieldInfo

public CTAggFieldInfo(java.lang.String name,
                      java.lang.String mapping,
                      int func)

Constructor. Creates a crosstab aggregate field information.

Parameters:

name - The instance name of the aggregate field in the crosstab.

mapping - The mapping name of the database field or formula.

func - The int value of the aggregate function type.

CTAggFieldInfo

public CTAggFieldInfo(java.lang.String name,
                      java.lang.String mapping,
                      int func,
                      int index)

Constructor. Creates a crosstab aggregate field information.

Parameters:

name - The instance name of the aggregate field in the crosstab.

mapping - The mapping name of the database field or formula.

func - The int value of the aggregate function type.

index - The position of aggregate field in the crosstab. It is useless in fact since Logi Report arrange aggregate fields according to the aggregate list in the crosstab.

CTAggFieldInfo

public CTAggFieldInfo(java.lang.String name,
                      java.lang.String mapping,
                      int func,
                      int index,
                      java.lang.String label)

Constructor. Creates a crosstab aggregate field information.

Parameters:

name - The instance name of the aggregate field in the crosstab.

mapping - The mapping name of the database field or formula.

func - The int value of the aggregate function type.

index - The position of aggregate field in the crosstab. It is useless in fact since Logi Report arrange aggregate fields according to the aggregate list in the crosstab.

label - The text title of the aggregate field.

Method Detail

getType

public static int getType(java.lang.String typeN)

Gets the int value of the function context.

Parameters:

typeN - The string description of the aggregate function.

Returns:

the int value of the function context.

setBlName

public void setBlName(java.lang.String blName)

Sets the BC/RC name or the BusinessView name of the aggregate field.

Parameters:

blName - The BC/RC name or the BusinessView name of the aggregate field.

getBlName

public java.lang.String getBlName()

Gets the BC/RC name or the BusinessView name of the aggregate field.

Returns:

the BC/RC name or the BusinessView name of the aggregate field.

setCTFName

public void setCTFName(java.lang.String ctfName)

Sets the crossstab formula name of the aggregate field. Crosstab formula is a kind of extended formula used only in page report crosstabs. By using crosstab formulas, you can create custom aggregate functions in a crosstab to get the desired results. Crosstab formulas are private resources on crosstab level. They cannot be used beyond its crosstab.

Parameters:

ctfName - The crossstab formula name of the aggregate field.

getCTFName

public java.lang.String getCTFName()

Gets the crossstab formula name of the aggregate field. Crosstab formula is a kind of extended formula used only in page report crosstabs. By using crosstab formulas, you can create custom aggregate functions in a crosstab to get the desired results. Crosstab formulas are private resources on crosstab level. They cannot be used beyond its crosstab.

Returns:

the crossstab formula name of the aggregate field.

setAggregationType

public void setAggregationType(int aggType)

Sets the aggregate field's type.

Parameters:

aggType - the aggregate field's type. See also USE_FIELDNAME_FUNCTION, USE_CTF}.

getAggregationType

public int getAggregationType()

Gets the aggregate field's type.

Returns:

the aggregate field's type. See also USE_FIELDNAME_FUNCTION, USE_CTF}.

getDistinctOn

public java.util.Vector<java.lang.String> getDistinctOn()

setDistinctOn

public void setDistinctOn(java.util.Vector<java.lang.String> distinctOn)

createCTSpecialFldInfo

public CTSpecialFldInfo createCTSpecialFldInfo(java.lang.String label,
                                               int breakBy,
                                               int refer,
                                               int function,
                                               boolean isRowDirection)

Creates a related comparison aggregate field's information.

Parameters:

label - The text title of the comparison function field.

breakBy - Specifies the first parameter (aggregate or sub-total) of the comparison function, similar like numerator. The number -1 means the aggregate is the first parameter; the number of the real order of the columns/rows means the inner group sub-total.

refer - Specifies the second parameter (sub-total or grand-total) of the comparison function, similar like denominator. The number -1 means the grand-total is the second parameter; the number, less than breakBy, of the real order of the columns/rows means the outer group sub-total.

function - The int value of the comparison function type.

isRowDirection - If it is true, the comparison function field will be placed into the column's total cell of the crosstab;otherwise, the comparison function field will be placed into the row total cell of the crosstab.

Returns:

the CTSpecialFldInfo defines the special aggregate field.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object