oracle.adf.view.faces.bi.component.pivotTable

Class SliceSizingRuleImpl

java.lang.Object

oracle.adf.view.faces.bi.component.BIComplexAttributeBase

oracle.adf.view.faces.bi.component.pivotTable.SizingRule

oracle.adf.view.faces.bi.component.pivotTable.SliceSizingRule

oracle.adf.view.faces.bi.component.pivotTable.SliceSizingRuleImpl

All Implemented Interfaces:

javax.faces.component.StateHolder

Direct Known Subclasses:

SerializableSliceSizingRuleImpl

public class SliceSizingRuleImpl
extends SliceSizingRule

Implementation of SliceSizingRule. It is recommended that a Serializable subclass be used instead of this class, such as SerializableSliceSizingRuleImpl, and that only Serializable subclasses of Member be used, such as SerializableMember. If an instance of this class is used in conjunction with session change management, it is subject to being replaced by an equivalent instance of SerializableSliceSizingRuleImpl.

Since:

release specific (what release of product did this appear in)

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_SLICE_SIZING_RULE_TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	EXACT_MATCH_REQUIRED_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	MEMBERS_KEY
static org.apache.myfaces.trinidad.bean.PropertyKey	REMOVED_AFTER_LAYOUT_CHANGE_KEY
static org.apache.myfaces.trinidad.bean.FacesBean.Type	TYPE

Fields inherited from class oracle.adf.view.faces.bi.component.pivotTable.SizingRule

SIZE_KEY

Fields inherited from class oracle.adf.view.faces.bi.component.BIComplexAttributeBase

ID_KEY, m_parent, TRANSIENT_KEY

Constructor Summary

Constructors

Constructor and Description
SliceSizingRuleImpl() Constructs an empty SliceSizingRuleImpl.
SliceSizingRuleImpl(java.util.List<Member> members, int size) Constructs a new SliceSizingRuleImpl.

Method Summary

Modifier and Type	Method and Description
protected QDR	generateMemberQDR() Generates a member QDR for the header cell (member) associated with this rule; that is, the header cell that indicates to which slice(s) this rule applies.
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType() Gets the bean type.
protected QDR	getMemberQDR() Gets the member QDR for the header cell (member) associated with this rule; that is, the header cell that indicates to which slice(s) this rule applies.
java.util.List<Member>	getMembers() Returns the header cells indicating to which slice(s) this rule applies.
java.lang.String	getRuleType() Returns the rule type.
void	initBeforeRun() Called after configuring rules, but before running rules.
boolean	isExactMatchRequired() Indicates whether the QDR must match exactly for this rule to apply.
boolean	isRemovedAfterLayoutChange() Indicates whether this rule is removed when the layout changes.
boolean	overridesRule(SliceSizingRuleImpl rule) Indicates whether the rule is overridden.
boolean	runRule(QDR sliceQDR) Indicates whether this rule applies to the specified slice.
void	setExactMatchRequired(boolean exactMatchRequired) Sets whether the QDR must match exactly for this rule to apply.
void	setMembers(java.util.List<Member> members) Sets the header cells indicating to which slice(s) this rule applies.
void	setRemovedAfterLayoutChange(boolean removed) Sets whether this rule should be removed when the layout changes.

Methods inherited from class oracle.adf.view.faces.bi.component.pivotTable.SizingRule

getSize, setSize

Methods inherited from class oracle.adf.view.faces.bi.component.BIComplexAttributeBase

applyProperties, getBooleanProperty, getFacesBean, getId, getParent, getProperty, getPropertyKey, getSetAttributeIndex, isTransient, isUpdated, processSetAttribute, processSetAttributeAndAdd, registerAttachedObjectKey, restoreState, saveState, setBooleanProperty, setId, setParent, setProperty, setTransient, setUpdated

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_SLICE_SIZING_RULE_TYPE

public static final java.lang.String DEFAULT_SLICE_SIZING_RULE_TYPE

See Also:

Constant Field Values

TYPE

public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE

MEMBERS_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey MEMBERS_KEY

REMOVED_AFTER_LAYOUT_CHANGE_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey REMOVED_AFTER_LAYOUT_CHANGE_KEY

EXACT_MATCH_REQUIRED_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey EXACT_MATCH_REQUIRED_KEY

Constructor Detail

SliceSizingRuleImpl

public SliceSizingRuleImpl()

Constructs an empty SliceSizingRuleImpl.

SliceSizingRuleImpl

public SliceSizingRuleImpl(java.util.List<Member> members,
                           int size)

Constructs a new SliceSizingRuleImpl. The members param specifies the slice or slices to which this rule applies. For example, say that the row edge has three layers: City, Year, and Measure. If the members param is "Boston, 2010, Sales", then this rule applies to the one and only row having those three header cells. If the members param is "Boston, 2010", and isExactMatchRequired returns false, then this rule applies to all rows spanned by those two header cells. So if there are two measures, "Sales" and "Units", under "Boston, 2010" then this rule applies to both of those rows.

Parameters:

members - the header cells indicating to which slice(s) this rule applies

size - the size in pixels

Method Detail

initBeforeRun

public void initBeforeRun()

Description copied from class: SizingRule

Called after configuring rules, but before running rules.

Specified by:

initBeforeRun in class SizingRule

getMembers

public java.util.List<Member> getMembers()

Returns the header cells indicating to which slice(s) this rule applies. See the constructor documentation for details.

Returns:

the header cells indicating to which slice(s) this rule applies

setMembers

public void setMembers(java.util.List<Member> members)

Sets the header cells indicating to which slice(s) this rule applies. See the constructor documentation for details.

Parameters:

members - the header cells indicating to which slice(s) this rule applies

isRemovedAfterLayoutChange

public boolean isRemovedAfterLayoutChange()

Indicates whether this rule is removed when the layout changes.

Returns:

true if this rule is removed when the layout changes, false otherwise

setRemovedAfterLayoutChange

public void setRemovedAfterLayoutChange(boolean removed)

Sets whether this rule should be removed when the layout changes.

Parameters:

removed - true if this rule should be removed when the layout changes, false otherwise

isExactMatchRequired

public boolean isExactMatchRequired()

Indicates whether the QDR must match exactly for this rule to apply. The default is false.

Returns:

true if this rule requires an exact match, false otherwise

setExactMatchRequired

public void setExactMatchRequired(boolean exactMatchRequired)

Sets whether the QDR must match exactly for this rule to apply.

Parameters:

exactMatchRequired - true if this rule should require an exact match, false otherwise

runRule

public boolean runRule(QDR sliceQDR)

Description copied from class: SliceSizingRule

Indicates whether this rule applies to the specified slice.

Specified by:

runRule in class SliceSizingRule

Parameters:

sliceQDR - the QDR of the slice to be checked for applicability

Returns:

true if this rule applies to the specified slice, false otherwise

overridesRule

public boolean overridesRule(SliceSizingRuleImpl rule)

Indicates whether the rule is overridden.

Parameters:

rule - another SliceSizingRuleImpl

Returns:

true if the rule is overridden, false otherwise

getRuleType

public java.lang.String getRuleType()

Description copied from class: SizingRule

Returns the rule type.

Specified by:

getRuleType in class SizingRule

Returns:

the rule type

getBeanType

protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()

Description copied from class: SizingRule

Gets the bean type.

Overrides:

getBeanType in class SizingRule

Returns:

the bean type

getMemberQDR

protected QDR getMemberQDR()

Gets the member QDR for the header cell (member) associated with this rule; that is, the header cell that indicates to which slice(s) this rule applies.

Returns:

the QDR of this rule's header cell

generateMemberQDR

protected QDR generateMemberQDR()

Generates a member QDR for the header cell (member) associated with this rule; that is, the header cell that indicates to which slice(s) this rule applies.

Returns:

the QDR of this rule's header cell