|
Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components 11g Release 1 (11.1.1) E12063-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.dss.gauge.DataSpecification
public class DataSpecification
This class allows a developer with a DataAccess and DataDirector implementation to control how their data is mapped to the gauges in a Gauge bean. Data such as metric, thresholds, and minimum and maximum values is pulled from the data source by specifying dimension values containing that data. A developer can use this implementation to direct the data in a BI Beans data view to power a Gauge bean. For instance, given a instance of Crosstab with the following data set:
All Channels | |||
Sales | Quota | Target | |
Boston | 12 | 11 | 13 |
Chicago | 14 | 14 | 17 |
Phoenix | 8 | 10 | 12 |
New York | 21 | 16 | 20 |
The developer could set up this data specification for their Gauge bean to map the Sales measure as the metric, the Quota measure as the first threshold, and the Target measure as the second threshold. The Gauge bean would create a 1 column, 4 row set of gauges complete with 2 thresholds. The data specification setup code would look something like this: String[] thresholds = {"QUOTA", "TARGET"}; DataSpecification bds = new DataSpecification(); bds.setMetric("SALES"); bds.setThresholds(thresholds); This data specification, together with an implementation of DataSource, will be what is needed to supply data to a Gauge bean. An instance of this class is optional when supplying a DataSource instance to the Gauge bean - each cell in the DataSource will be considered to be a separate gauge if an instance of this class is not provided. By default, the measure names provided in the setMetric
, setThresholds
, setMinimum
, and setMaximum
methods are assumed to be valid values in either the default measure dimension or the dimension specified by a call to setMeasureDimensionName
.
Field Summary | |
---|---|
static java.lang.String |
a_index |
static java.lang.String |
a_name |
static java.lang.String |
a_type |
static java.lang.String |
BOTTOM_LABEL Used for identifying THRESHOLD data within a tabular data column |
static int |
INIT_METRIC_CAPACITY |
static int |
INIT_THRESHOLD_CAPACITY |
static java.lang.String |
MAXIMUM Used for identifying MAXIMUM data within a tabular data column |
static java.lang.String |
METRIC Used for identifying METRIC data within a tabular data column |
static java.lang.String |
MINIMUM Used for identifying MINIMUM data within a tabular data column |
static java.lang.String |
NAME_DIMENSION |
static java.lang.String |
NAME_SPECIFICATION |
static java.lang.String |
THRESHOLD Used for identifying THRESHOLD data within a tabular data column |
static java.lang.String |
TOP_LABEL Used for identifying THRESHOLD data within a tabular data column |
Constructor Summary | |
---|---|
DataSpecification() Constructor with no DataSource instance. |
Method Summary | |
---|---|
boolean |
equals(java.lang.Object obj) Returns whether the two data specifications are equal or not |
java.lang.String |
getMaximum() Returns the measure value name used to pull maximum values from the Bean's DataSource implementation. |
java.lang.String |
getMeasureDimensionName() Returns the name of the dimension from which the measures specified in this class are taken. |
java.lang.String |
getMetric() Returns the measure value name from which to pull metric data from the Bean's DataSource implementation. |
java.lang.String |
getMetric(int i) Returns the measure value name with specific index from which to pull metric data from the Bean's DataSource implementation. |
java.util.List<java.lang.String> |
getMetrics() Returns the list of the measure value names from which to pull metric data from the Bean's DataSource implementation. |
java.lang.String |
getMinimum() Returns the measure name used to pull minimum values from the Bean's DataSource implementation. |
java.lang.String |
getThreshold(int index) Gets the measure value name for the given threshold index. |
java.util.ArrayList |
getThresholds() Returns the measure value name used to pull threshold values from the Bean's DataSource implementation. |
protected boolean |
getXML(oracle.dss.util.xml.ObjectNode parent) |
boolean |
isEmpty() Determines if this DataSpecification is empty, that is, has no data specifications on it. |
protected void |
setCommonGauge(CommonGauge cg) |
boolean |
setDataSpecByName(java.lang.String type, java.lang.String value) |
void |
setMaximum(java.lang.String value) Directs the Gauge bean to use the specified measure name to pull maximum values from the Bean's DataSource implementation. |
void |
setMeasureDimensionName(java.lang.String dimName) Allows the developer to change the name of the dimension from which the measures specified in this class are taken. |
void |
setMetric(java.lang.String value) Directs the Gauge bean to use the specified dimension value to pull metric data from the Bean's DataSource implementation. |
void |
setMetric(java.lang.String value, int index) Directs the Gauge bean to use the specified dimension value with index to pull metric data from the Bean's DataSource implementation. |
void |
setMetrics(java.util.List<java.lang.String> list) Directs the Gauge bean to use the specified dimension list of values to pull metric data from the Bean's DataSource implementation. |
void |
setMinimum(java.lang.String value) Returns the measure name used to pull minimum values from the Bean's DataSource implementation. |
void |
setThreshold(int index, java.lang.String value) Sets the measure value name for the given threshold index. |
void |
setThresholds(java.util.ArrayList values) Directs the Gauge bean to use the specified value names to pull threshold values from the Bean's DataSource implementation. |
void |
setXML(oracle.dss.util.xml.ContainerNode node) Sets the data specification attributes through XML file |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String METRIC
public static final java.lang.String MINIMUM
public static final java.lang.String MAXIMUM
public static final java.lang.String THRESHOLD
public static final java.lang.String TOP_LABEL
public static final java.lang.String BOTTOM_LABEL
public static final java.lang.String NAME_DIMENSION
getXML(oracle.dss.util.xml.ObjectNode)
, Constant Field ValuesDimension
.public static final java.lang.String NAME_SPECIFICATION
getXML(oracle.dss.util.xml.ObjectNode)
, Constant Field ValuesSpecification
.public static final java.lang.String a_type
public static final java.lang.String a_index
public static final java.lang.String a_name
public static final int INIT_THRESHOLD_CAPACITY
public static final int INIT_METRIC_CAPACITY
Constructor Detail |
---|
public DataSpecification()
DataSource
instance. Using this constructor will postpone validation of the settings applied with the methods in this class until the Gauge bean processes the DataSource.Method Detail |
---|
public java.lang.String getMeasureDimensionName()
public void setMeasureDimensionName(java.lang.String dimName)
dimName
- Name of the measure dimension to use.public java.lang.String getMetric()
DataSource
implementation. Returns the first metric if there are multiple metrics.public java.lang.String getMetric(int i)
DataSource
implementation.i,
- the index of the metric name which is getting.public java.util.List<java.lang.String> getMetrics()
DataSource
implementation.public void setMetric(java.lang.String value)
DataSource
implementation. Sets the first metric if there are multiple metrics.value
- Name of the measure value to use as the metric.public void setMetric(java.lang.String value, int index)
DataSource
implementation.value
- name of the measure value to use as the metric.index
- the index of the metric name which is setting.public void setMetrics(java.util.List<java.lang.String> list)
DataSource
implementation.list
- the list of names of the measure value to use as the metrics.public java.lang.String getMinimum()
DataSource
implementation.public void setMinimum(java.lang.String value)
DataSource
implementation.value
- Name of the measure value to use as the minimum.public java.lang.String getMaximum()
DataSource
implementation.public void setMaximum(java.lang.String value)
DataSource
implementation.value
- Name of the measure value to use as the maximum.public java.util.ArrayList getThresholds()
DataSource
implementation.public void setThresholds(java.util.ArrayList values)
DataSource
implementation.values
- ArrayList
instance of threshold measure namespublic java.lang.String getThreshold(int index)
index
- Threshold for which to get measure namepublic void setThreshold(int index, java.lang.String value)
index
- Threshold for which to set measure namevalue
- Name of measure providing values for this thresholdpublic boolean setDataSpecByName(java.lang.String type, java.lang.String value)
type
- String representation of the data spec type. Valid values can be found in GaugeAttributes
beginning with dst_.value
- String representation of the value of this spec.True
if the spec value was applied, False
otherwise.public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
obj
- returns true
if they are equal, otherwise false
public boolean isEmpty()
True
if this DataSpecification has no data specifications on it, False
otherwise.public void setXML(oracle.dss.util.xml.ContainerNode node)
node
- The node of the data specification in the XML fileprotected boolean getXML(oracle.dss.util.xml.ObjectNode parent)
protected void setCommonGauge(CommonGauge cg)
|
Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components 11g Release 1 (11.1.1) E12063-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |