Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components
11g Release 1 (11.1.1.6.0)

E12063-07

oracle.dss.rules.discriminator
Class PositionDiscriminator

java.lang.Object
  extended by oracle.dss.rules.discriminator.PositionDiscriminator
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable, Discriminator, DiscriminatorXML

public class PositionDiscriminator
extends java.lang.Object
implements DiscriminatorXML

Discriminator for a rule that applies when a DataView item is in a particular location. For example, you could use this Discriminator to specify that a DiscriminatorRule should apply to the first row in a crosstab or table.

This Discriminator compares an internal ComponentInfo class to a ComponentInfo class that is in the RuleContext that describes the item to be painted.

See Also:
DiscriminatorRule, RuleContext, ComponentInfo, Serialized Form

Field Summary
protected static java.lang.String a_column
           
protected static java.lang.String a_depth
           
protected static java.lang.String a_edge
           
protected static java.lang.String a_group
           
protected static java.lang.String a_index
           
protected static java.lang.String a_row
           
protected static int column
           
protected static int dataColumn
           
protected static int dataRow
           
protected static int depth
           
protected static int edge
           
protected static int group
           
protected static int index
           
protected  ComponentInfo m_componentInfo
           
protected static java.lang.String NAME_COLCOMPINFO
           
protected static java.lang.String NAME_DATACOMPINFO
           
protected static java.lang.String NAME_EDGECOMPINFO
           
protected static java.lang.String NAME_GROUPCOMPINFO
           
protected static java.lang.String NAME_PAGEITEMCOMPINFO
           
static java.lang.String NAME_POS_DISC
           
protected static java.lang.String NAME_ROWCOMPINFO
           
protected static java.lang.String NAME_SERIESCOMPINFO
           
protected static int pageItem
           
protected static int row
           
protected static int series
           
 
Constructor Summary
PositionDiscriminator()
          Constructor that does not take a ComponentInfo.
PositionDiscriminator(ComponentInfo componentInfo)
          Constructor that specifies a ComponentInfo.
 
Method Summary
 boolean applies(RuleContext context)
          Specifies whether the position in the specified RuleContext matches that of the position for this PositionDiscriminator.
 java.lang.Object clone()
          Clones this PositionDiscriminator.
 ComponentInfo getComponentInfo()
          Retrieves the ComponentInfo object of this PositionDiscriminator.
 oracle.dss.util.xml.ObjectNode getXML(boolean allProperties, ComponentTypeConverter converter, boolean emptyElement)
          Retrieves XML that represents properties and their values in the form of and ObjectNode.
 void setComponentInfo(ComponentInfo componentInfo)
          Specifies the ComponentInfo object for this PositionDiscriminator.
 boolean setXML(oracle.dss.util.xml.ObjectNode node, ComponentTypeConverter converter, java.lang.String version, int reset)
          Specifies XML that represents properties and values.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

m_componentInfo

protected ComponentInfo m_componentInfo

NAME_POS_DISC

public static final java.lang.String NAME_POS_DISC
See Also:
Constant Field Values

column

protected static final int column
See Also:
Constant Field Values

dataRow

protected static final int dataRow
See Also:
Constant Field Values

dataColumn

protected static final int dataColumn
See Also:
Constant Field Values

edge

protected static final int edge
See Also:
Constant Field Values

depth

protected static final int depth
See Also:
Constant Field Values

index

protected static final int index
See Also:
Constant Field Values

group

protected static final int group
See Also:
Constant Field Values

pageItem

protected static final int pageItem
See Also:
Constant Field Values

row

protected static final int row
See Also:
Constant Field Values

series

protected static final int series
See Also:
Constant Field Values

NAME_COLCOMPINFO

protected static final java.lang.String NAME_COLCOMPINFO
See Also:
Constant Field Values

NAME_DATACOMPINFO

protected static final java.lang.String NAME_DATACOMPINFO
See Also:
Constant Field Values

NAME_EDGECOMPINFO

protected static final java.lang.String NAME_EDGECOMPINFO
See Also:
Constant Field Values

NAME_GROUPCOMPINFO

protected static final java.lang.String NAME_GROUPCOMPINFO
See Also:
Constant Field Values

NAME_PAGEITEMCOMPINFO

protected static final java.lang.String NAME_PAGEITEMCOMPINFO
See Also:
Constant Field Values

NAME_ROWCOMPINFO

protected static final java.lang.String NAME_ROWCOMPINFO
See Also:
Constant Field Values

NAME_SERIESCOMPINFO

protected static final java.lang.String NAME_SERIESCOMPINFO
See Also:
Constant Field Values

a_column

protected static final java.lang.String a_column
See Also:
Constant Field Values

a_row

protected static final java.lang.String a_row
See Also:
Constant Field Values

a_edge

protected static final java.lang.String a_edge
See Also:
Constant Field Values

a_depth

protected static final java.lang.String a_depth
See Also:
Constant Field Values

a_index

protected static final java.lang.String a_index
See Also:
Constant Field Values

a_group

protected static final java.lang.String a_group
See Also:
Constant Field Values
Constructor Detail

PositionDiscriminator

public PositionDiscriminator()
Constructor that does not take a ComponentInfo. If you use this constructor, call the setComponentInfo method to specify the position.


PositionDiscriminator

public PositionDiscriminator(ComponentInfo componentInfo)
Constructor that specifies a ComponentInfo.

Parameters:
componentInfo - The ComponentInfo object that specifies the position that a DataView item must occupy in order for this PositionDiscriminator to apply.
Method Detail

clone

public java.lang.Object clone()
Clones this PositionDiscriminator.

Specified by:
clone in interface Discriminator
Overrides:
clone in class java.lang.Object
Returns:
The clone of this PositionDiscriminator.

getComponentInfo

public ComponentInfo getComponentInfo()
Retrieves the ComponentInfo object of this PositionDiscriminator.

Returns:
The ComponentInfo object that specifies the position that a DataView item must occupy in order for this PositionDiscriminator to apply.

setComponentInfo

public void setComponentInfo(ComponentInfo componentInfo)
Specifies the ComponentInfo object for this PositionDiscriminator.

Parameters:
componentInfo - The ComponentInfo object that specifies the position that a DataView item must occupy in order for this PositionDiscriminator to apply.

applies

public boolean applies(RuleContext context)
Specifies whether the position in the specified RuleContext matches that of the position for this PositionDiscriminator. This method compares ComponentInfo objects.

Specified by:
applies in interface Discriminator
Parameters:
context - The context of the item to be painted.
Returns:
true if the ComponentInfo of the specified RuleContext is equivalent to the ComponentInfo for this PositionDiscriminator, false if not.

setXML

public boolean setXML(oracle.dss.util.xml.ObjectNode node,
                      ComponentTypeConverter converter,
                      java.lang.String version,
                      int reset)
Description copied from interface: DiscriminatorXML
Specifies XML that represents properties and values. This method applies the values of the properties in the XML to the DiscriminatorXML.

Specified by:
setXML in interface DiscriminatorXML
Parameters:
node - ObjectNode that has the properties and their values.
converter - A converter that converts component strings to integers and vice versa.
version - The XML version.
reset - A constant that indicates how much to reset when XML is applied. Valid values are listed in the See Also section.
Returns:
true if XML is properly applied, false if the XML cannot be applied.
See Also:
Rule.RESET_NONE, Rule.RESET_XML_PROPERTIES, Rule.RESET_EVERYTHING

getXML

public oracle.dss.util.xml.ObjectNode getXML(boolean allProperties,
                                             ComponentTypeConverter converter,
                                             boolean emptyElement)
Description copied from interface: DiscriminatorXML
Retrieves XML that represents properties and their values in the form of and ObjectNode.

Specified by:
getXML in interface DiscriminatorXML
Parameters:
allProperties - true to store all property values in XML, false to store only values that are different from default values.
converter - A converter that converts component strings to integers and integers to strings.
emptyElement - true if an empty element needs to be returned when none of the property values have changed from default. false if null should should be returned when none of the property values have changed from default. This argument is considered only if allProperties is false.
Returns:
XML for the properties and values.

Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components
11g Release 1 (11.1.1.6.0)

E12063-07

Copyright © 1997, 2011, Oracle. All rights reserved.