|
Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components 11g Release 2 (11.1.2.1.0) E17492-02 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.dss.rules.discriminator.ComponentTypeDiscriminator
public class ComponentTypeDiscriminator
Discriminator for a rule that applies when a DataView
item
is a particular component.
For example, you could use this Discriminator
to specify that
numbers should be abbreviated when they mark values along the Y2-axis of a
graph.
This Discriminator
compares the component type integer from the
RuleContext
that describes the DataView
item, with
the internal component type integer in this Discriminator
.
Field Summary | |
---|---|
protected int |
m_componentType
|
static java.lang.String |
NAME_COMP_TYPE_DISC
|
Constructor Summary | |
---|---|
ComponentTypeDiscriminator()
Constructor that does not specify a component type. |
|
ComponentTypeDiscriminator(int componentType)
Constructor that specifies a component type. |
Method Summary | |
---|---|
boolean |
applies(RuleContext context)
Indicates whether the ComponentType from the specified
RuleContext matches the ComponentType for this
ComponentTypeDiscriminator . |
java.lang.Object |
clone()
Clones this ComponentTypeDiscriminator . |
int |
getComponentType()
Retrieves the component type of this ComponentTypeDiscriminator . |
oracle.dss.util.xml.ObjectNode |
getXML(boolean allProperties,
ComponentTypeConverter converter,
boolean emptyNode)
Retrieves XML that represents properties and their values in the form of and ObjectNode . |
void |
setComponentType(int componentType)
Specifies the type of component for this ComponentTypeDiscriminator . |
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 |
---|
protected int m_componentType
public static final java.lang.String NAME_COMP_TYPE_DISC
Constructor Detail |
---|
public ComponentTypeDiscriminator()
setComponentType
method to specify the component.
public ComponentTypeDiscriminator(int componentType)
componentType
- A constant that represents the type of component
that a DataView
item is, such as
Y2AXIS. Constants are defined in the sublasses of the
DataView
class.oracle.dss.crosstab.Crosstab
,
Graph
,
oracle.dss.gridView.GridView
Method Detail |
---|
public java.lang.Object clone()
ComponentTypeDiscriminator
.
clone
in interface Discriminator
clone
in class java.lang.Object
ComponentTypeDiscriminator
.public int getComponentType()
ComponentTypeDiscriminator
.
DataView
item must be in order for this
ComponentTypeDiscriminator
to apply.
Constants are defined in the sublasses of the
DataView
class.oracle.dss.crosstab.Crosstab
,
Graph
,
oracle.dss.gridView.GridView
public void setComponentType(int componentType)
ComponentTypeDiscriminator
.
componentType
- A constant that represents the type of component
that a DataView
item must be in order
for this ComponentTypeDiscriminator
to apply. Constants are defined in the sublasses of
the DataView
class.oracle.dss.crosstab.Crosstab
,
Graph
,
oracle.dss.gridView.GridView
public boolean applies(RuleContext context)
ComponentType
from the specified
RuleContext
matches the ComponentType
for this
ComponentTypeDiscriminator
.
applies
in interface Discriminator
context
- The context of the item being painted.
true
if the component type in context
is the same as the component type of this
ComponentTypeDiscriminator
,
false
if not.public boolean setXML(oracle.dss.util.xml.ObjectNode node, ComponentTypeConverter converter, java.lang.String version, int reset)
DiscriminatorXML
DiscriminatorXML
.
setXML
in interface DiscriminatorXML
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.
true
if XML is properly applied,
false
if the XML cannot be applied.Rule.RESET_NONE
,
Rule.RESET_XML_PROPERTIES
,
Rule.RESET_EVERYTHING
public oracle.dss.util.xml.ObjectNode getXML(boolean allProperties, ComponentTypeConverter converter, boolean emptyNode)
DiscriminatorXML
ObjectNode
.
getXML
in interface DiscriminatorXML
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.emptyNode
- 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
.
|
Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components 11g Release 2 (11.1.2.1.0) E17492-02 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |