oracle.adfdt.view.dvt.binding.pattern.options

Class PivotTableBindingOptions

java.lang.Object

oracle.adfdt.view.dvt.binding.pattern.options.BindingOptions

oracle.adfdt.view.dvt.binding.pattern.options.PivotTableBindingOptions

public class PivotTableBindingOptions
extends BindingOptions

 PivotTableBindingOptions.
 

Since:

12.1.1.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PivotTableBindingOptions.AggType AggType enum, specifying the Aggregation type.
static class	PivotTableBindingOptions.CategorySortAttributeValues Helper class for Category sorts.
static class	PivotTableBindingOptions.CategoryTotalsAttributeValues Helper class for Category totals.
static class	PivotTableBindingOptions.CategoryTotalsInsertTotal CategoryTotalsInsertTotal enum.
static class	PivotTableBindingOptions.DrillType DrillType enum.
static class	PivotTableBindingOptions.DrillTypeLocation DrillTypeLocation enum, currently only valid for DrillType.INSERT.
static class	PivotTableBindingOptions.SequenceNulls SequenceNulls enum.
static class	PivotTableBindingOptions.SortOrder SortOrder enum.

Nested classes/interfaces inherited from class oracle.adfdt.view.dvt.binding.pattern.options.BindingOptions

BindingOptions.ChangeEventPolicy

Constructor Summary

Constructors

Constructor and Description
PivotTableBindingOptions()

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Map<java.lang.String,PivotTableBindingOptions.CategorySortAttributeValues>	getCategorySorts() Retrieves the category sorts, which can be used to specify a custom sort order on the data layer of any row, column, or page edge.
java.util.Map<java.lang.String,PivotTableBindingOptions.CategoryTotalsAttributeValues>	getCategoryTotals() Retrieves the category totals which can be used to define totals and subtotals for attribute categories added to the column, row, or page edges in the pivot table.
java.util.List<oracle.adf.model.dvt.binding.common.LayerDefinition>	getColumnEdge() Retrieves the layers for the column edge.
PivotTableBindingOptions.AggType	getDataAggregationDefaultFunction() Retrieves the data aggregation default function.
java.util.Map<java.lang.String,PivotTableBindingOptions.AggType>	getDataAggregations() Retrieves the data aggregations.
java.util.Map<java.lang.String,java.lang.String>	getDataSortsInitialSortColumn() Retrieves the data sort initial sort column.
PivotTableBindingOptions.SortOrder	getDataSortsInitialSortOrder() Retrieves the data sort initial sort order.
PivotTableBindingOptions.SequenceNulls	getDataSortsSequenceNulls() Retrieves the data sort sequence nulls order.
java.util.Map<java.lang.String,oracle.adf.model.dvt.binding.common.LayerDefinition>	getDrillingHierarchies() Retrieves the drilling hierarchies.
PivotTableBindingOptions.DrillType	getDrillingType() Retrieves the drilling type.
PivotTableBindingOptions.DrillTypeLocation	getDrillingTypeLocation() Retrieves the drilling type location.
java.lang.String	getNameValuePairsQualifier() Retrieves the name/value pairs qualifier.
java.lang.String	getNameValuePairsValue() Retrieves the name/value pairs value.
java.util.List<oracle.adf.model.dvt.binding.common.LayerDefinition>	getPageEdge() Retrieves the layers for the page edge
java.util.List<oracle.adf.model.dvt.binding.common.LayerDefinition>	getRowEdge() Retrieves the layers for the row edge.
boolean	isAggregateDuplicates() Retrieves whether the data layer should aggregate duplicates, which by default is true.
void	setAggregateDuplicates(boolean bAggregateDuplicates) Determines whether the data layer should aggregate duplicates.
void	setCategorySorts(java.util.Map<java.lang.String,PivotTableBindingOptions.CategorySortAttributeValues> mapCategorySorts) Specifies the category sorts, which can be used to specify a custom sort order on the data layer of any row, column, or page edge.
void	setCategoryTotals(java.util.Map<java.lang.String,PivotTableBindingOptions.CategoryTotalsAttributeValues> mapCategoryTotals) Specifies the category totals which can be used to define totals and subtotals for attribute categories added to the column, row, or page edges in the pivot table.
void	setColumnEdge(java.util.List<oracle.adf.model.dvt.binding.common.LayerDefinition> columnEdge) Specifies the layers for the column edge.
void	setDataAggregation(PivotTableBindingOptions.AggType defaultFunction, java.util.Map<java.lang.String,PivotTableBindingOptions.AggType> mapAggregations) Specifies the data aggregration.
void	setDataSorts(PivotTableBindingOptions.SortOrder initialSortOrder, PivotTableBindingOptions.SequenceNulls sequenceNulls, java.util.Map<java.lang.String,java.lang.String> mapInitialSortColumn) Specifies the data sorts, which includes the initial sort order, null sequencing and mapping of data layer attribute names to associated value (e.g.
void	setDrilling(PivotTableBindingOptions.DrillType drillType, PivotTableBindingOptions.DrillTypeLocation insertParentRow, java.util.Map<java.lang.String,oracle.adf.model.dvt.binding.common.LayerDefinition> mapDrillingHierarchies) Specifies the drilling type and associated drill paths.
void	setNameValuePairs(java.lang.String strQualifier, java.lang.String strValue) Specifies that the data consists of name/value pairs.
void	setPageEdge(java.util.List<oracle.adf.model.dvt.binding.common.LayerDefinition> pageEdge) Specifies the layers for the page edge.
void	setRowEdge(java.util.List<oracle.adf.model.dvt.binding.common.LayerDefinition> rowEdge) Specifies the layers for the row edge.

Methods inherited from class oracle.adfdt.view.dvt.binding.pattern.options.BindingOptions

getChangeEventPolicy, setChangeEventPolicy

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PivotTableBindingOptions

public PivotTableBindingOptions()

Method Detail

setPageEdge

public void setPageEdge(java.util.List<oracle.adf.model.dvt.binding.common.LayerDefinition> pageEdge)

Specifies the layers for the page edge.

 Example
 <pages>
   <item value="Mgr"/>
 </pages>
 
 

Parameters:

pageEdge - A List of LayerDefinition>s representing the list of page edge layers.

getPageEdge

public java.util.List<oracle.adf.model.dvt.binding.common.LayerDefinition> getPageEdge()

Retrieves the layers for the page edge

Returns:

List of LayerDefinition>s containing list of page edge layers.

setRowEdge

public void setRowEdge(java.util.List<oracle.adf.model.dvt.binding.common.LayerDefinition> rowEdge)

Specifies the layers for the row edge.

 Example
 <rows>
   <item value="Ename"/>
 </rows>
 
 

Parameters:

rowEdge - A List of LayerDefinition>s representing the list of row edge layers.

getRowEdge

public java.util.List<oracle.adf.model.dvt.binding.common.LayerDefinition> getRowEdge()

Retrieves the layers for the row edge.

Returns:

List of LayerDefinition>s containing list of row edge layers.

setColumnEdge

public void setColumnEdge(java.util.List<oracle.adf.model.dvt.binding.common.LayerDefinition> columnEdge)

Specifies the layers for the column edge.

 Example
 <columns>
   <item value="Hierdate"/>
 </columns>
 
 

Parameters:

columnEdge - A List<LayerDefinition> representing the list of column edge layers.

getColumnEdge

public java.util.List<oracle.adf.model.dvt.binding.common.LayerDefinition> getColumnEdge()

Retrieves the layers for the column edge.

Returns:

List of LayerDefinition>s containing list of column edge layers.

setNameValuePairs

public void setNameValuePairs(java.lang.String strQualifier,
                     java.lang.String strValue)
                       throws java.lang.IllegalArgumentException

 Specifies that the data consists of name/value pairs.
 If both values are null, no qualifiers are written out.
 

 Example
 <data qualifier="Metric" value="Value">
   <item value="Costs"/>
   <item value="Sales"/>
 </data>
 
 

Parameters:

strQualifier - A String which represents the column name.

strValue - A String which represents the column value.

Throws:

IllegalArgumentException - if only one of the values is non-null.

java.lang.IllegalArgumentException

getNameValuePairsQualifier

public java.lang.String getNameValuePairsQualifier()

Retrieves the name/value pairs qualifier.

Returns:

String which represents the name/value pairs qualifier.

See Also:

setNameValuePairs(String,String)

getNameValuePairsValue

public java.lang.String getNameValuePairsValue()

Retrieves the name/value pairs value.

Returns:

String which represents the name/value pairs value.

See Also:

setNameValuePairs(String,String)

setDrilling

public void setDrilling(PivotTableBindingOptions.DrillType drillType,
               PivotTableBindingOptions.DrillTypeLocation insertParentRow,
               java.util.Map<java.lang.String,oracle.adf.model.dvt.binding.common.LayerDefinition> mapDrillingHierarchies)
                 throws java.lang.IllegalArgumentException

Specifies the drilling type and associated drill paths. A null removes the value.

 Example
 <drills type="INSERT"/>
 <hierarchies>
  <item value="Empno" location="AFTER">
    <child value="Ename"/>
  </item>
  <item value="Ename" location="AFTER">
    <child value="Mgr"/>
  </item>
 </hierarchies>
 
 

Parameters:

drillType - A DrillType enum representing the drilling type.

insertParentRow - A DrillTypeLocation enum that represents where the parent row should be inserted, which is only valid for the DrillType.INSERT.

Throws:

IllegalArgumentException.

java.lang.IllegalArgumentException

getDrillingType

public PivotTableBindingOptions.DrillType getDrillingType()

Retrieves the drilling type.

Returns:

DrillType representing the drilling type.

See Also:

(DrillType, DrillTypeLocation, Map)

getDrillingTypeLocation

public PivotTableBindingOptions.DrillTypeLocation getDrillingTypeLocation()

Retrieves the drilling type location.

Returns:

DrillTypeLocation representing the drilling type location.

See Also:

(DrillType, DrillTypeLocation, Map)

getDrillingHierarchies

public java.util.Map<java.lang.String,oracle.adf.model.dvt.binding.common.LayerDefinition> getDrillingHierarchies()

Retrieves the drilling hierarchies.

Returns:

Map containing the mappings of the name of the parent layer String (which has already been defined, either in the main layout or as the child of another hierarchy path) to child Layer LayerDefinition.

See Also:

(DrillType, DrillTypeLocation, Map)

setDataAggregation

public void setDataAggregation(PivotTableBindingOptions.AggType defaultFunction,
                      java.util.Map<java.lang.String,PivotTableBindingOptions.AggType> mapAggregations)
                        throws java.lang.IllegalArgumentException

Specifies the data aggregration. A null removes the value.

 Example
 <columns>
   <data aggregateDuplicates="true" defaultAggregateType="SUM">
     <item label="Salary" value="Sal" aggregateType="SUM"/>
     <item value="Comm" aggregateType="MAX"/>
   </data>
 </columns>
 
 

Parameters:

defaultFunction - A AggType> representing the default data aggregation function.

mapAggregations - A Map containing the mappings of data attribute name String to aggregation type attribute-level AggType overrides.

Throws:

IllegalArgumentException.

java.lang.IllegalArgumentException

getDataAggregationDefaultFunction

public PivotTableBindingOptions.AggType getDataAggregationDefaultFunction()

Retrieves the data aggregation default function.

Returns:

AggType representing the default data aggregation function.

See Also:

(AggType, Map)

getDataAggregations

public java.util.Map<java.lang.String,PivotTableBindingOptions.AggType> getDataAggregations()

Retrieves the data aggregations.

Returns:

Map containing the mappings of data attribute name String to aggregation type attribute-level AggType overrides.

See Also:

(AggType, Map)

setAggregateDuplicates

public void setAggregateDuplicates(boolean bAggregateDuplicates)

Determines whether the data layer should aggregate duplicates.

 Example
 <rows>
   <data aggregateDuplicates="true"/>
 </rows>
 
 

Parameters:

bAggregateDuplicates - A boolean which is true if the data layer should aggregate duplicates and false otherwise.

isAggregateDuplicates

public boolean isAggregateDuplicates()

Retrieves whether the data layer should aggregate duplicates, which by default is true.

Returns:

boolean which is true if the data layer should aggregate duplicates and false otherwise.

setCategoryTotals

public void setCategoryTotals(java.util.Map<java.lang.String,PivotTableBindingOptions.CategoryTotalsAttributeValues> mapCategoryTotals)

Specifies the category totals which can be used to define totals and subtotals for attribute categories added to the column, row, or page edges in the pivot table.

 Example
 <aggregatedItems>
   <item aggregateLocation="BEFORE" aggregateType="SUM" value="Empno" aggregateLabel="Empno Total"/>
   <item aggregateLocation="AFTER" aggregateType="AVERAGE" value="Ename" aggregateLabel="Ename Total"/>
   <item aggregateLocation="REPLACE" aggregateType="COUNT" value="Mgr" aggregateLabel="Mgr Total"/>
 </aggregatedItems>
 
 

Parameters:

mapCategoryTotals - A Map containing the mappings of category name String to CategoryTotalsAttributeValues.

getCategoryTotals

public java.util.Map<java.lang.String,PivotTableBindingOptions.CategoryTotalsAttributeValues> getCategoryTotals()

Retrieves the category totals which can be used to define totals and subtotals for attribute categories added to the column, row, or page edges in the pivot table.

Returns:

Map containing the mappings of item to category totals attribute values.

setCategorySorts

public void setCategorySorts(java.util.Map<java.lang.String,PivotTableBindingOptions.CategorySortAttributeValues> mapCategorySorts)

Specifies the category sorts, which can be used to specify a custom sort order on the data layer of any row, column, or page edge.

 Example
 <sorts>
   <categorySort item="Ename" direction="ASCENDING"/>
   <categorySort item="Hiredate" direction="DESCENDING"/>
 </sorts>
 
 

Parameters:

mapCategorySorts - A Map containing the mappings of category name String to CategorySortAttributeValues.

getCategorySorts

public java.util.Map<java.lang.String,PivotTableBindingOptions.CategorySortAttributeValues> getCategorySorts()

Retrieves the category sorts, which can be used to specify a custom sort order on the data layer of any row, column, or page edge.

Returns:

Map containing the mappings of category name String to CategorySortAttributeValues.

setDataSorts

public void setDataSorts(PivotTableBindingOptions.SortOrder initialSortOrder,
                PivotTableBindingOptions.SequenceNulls sequenceNulls,
                java.util.Map<java.lang.String,java.lang.String> mapInitialSortColumn)

Specifies the data sorts, which includes the initial sort order, null sequencing and mapping of data layer attribute names to associated value (e.g. Data Labels to Sal).

 Example
 <sorts>
   <qdrSliceSort direction="DESCENDING" edge="rows" grouped="true" nullsFirst="false">
     <item name="DataLayer" value="Sal"/>
   </qdrSliceSort>
 </sorts>
 
 

Parameters:

initialSortOrder - A SortOrder representing the initialSortOrder.

strSequenceNulls - A SequenceNulls representing how nulls should be sequenced.

mapInitialSortColumn - A Map <String,String> containing the mappings mapping of data layer attribute names to associated value (e.g. Data Labels to Sal).

getDataSortsInitialSortOrder

public PivotTableBindingOptions.SortOrder getDataSortsInitialSortOrder()

Retrieves the data sort initial sort order.

Returns:

SortOrder represents the data sort initial sort order.

getDataSortsSequenceNulls

public PivotTableBindingOptions.SequenceNulls getDataSortsSequenceNulls()

Retrieves the data sort sequence nulls order.

Returns:

SequenceNulls representint the data sort sequence nulls order.

getDataSortsInitialSortColumn

public java.util.Map<java.lang.String,java.lang.String> getDataSortsInitialSortColumn()

Retrieves the data sort initial sort column.

Returns:

Map containing the mappings mapping of data layer attribute names to associated value (e.g. Data Labels to Sal).