oracle.dss.dataView.managers
Class DrillOutLink

java.lang.Object
  oracle.dss.dataView.managers.DrillOutLink

public class DrillOutLink
extends java.lang.Object

Field Summary

protected static java.lang.String	a_id
protected static java.lang.String	a_label
protected static java.lang.String	a_type
protected static java.lang.String	a_value
protected static java.lang.String	DRILL_OUT_LINK_NAME
protected static java.lang.String	s_drillOut
protected static java.lang.String	s_id
protected static java.lang.String	s_label
protected static java.lang.String	s_type
protected static java.lang.String	s_url
protected static java.lang.String	s_value
protected static java.lang.String	s_worksheet_ref
protected static java.lang.String	url
static int	URL Type: The Value is a URL string
protected static java.lang.String	worksheet_ref
static int	WORKSHEET_REFERENCE Type: The Value is a Worksheet Reference

Constructor Summary

DrillOutLink(int type, java.lang.String value, java.lang.String label, java.lang.String id)
Constructor.

Method Summary

boolean	equals(java.lang.Object object) Checks whether the specified DrillOutLink is identical to this DrillOutLink instance.
java.lang.String	getID() Retrieves the unique ID for this DrillOutLink.
java.lang.String	getLabel() Retrieves the label that appears in the popup for a cell that has a DrillOutLink.
protected oracle.dss.util.xml.ObjectNode	getStateAsObjectNode() Retrieves XML that represents properties and their values in the form of and ObjectNode.
int	getType() Retrieves the type of link that this DrillOutLink is.
java.lang.String	getValue() Retrieves the worksheet reference or a URL to which this DrillOutLink directs a user.
protected oracle.dss.util.xml.ObjectNode	getXML(boolean allProperties) Retrieves XML that represents properties and their values in the form of and ObjectNode.
void	setLabel(java.lang.String label) Specifies the label that appears in the popup for a cell that has a DrillOutLink.
protected void	setStateAsObjectNode(oracle.dss.util.xml.ObjectNode node) Specifies XML that represents properties and values.
void	setType(int type) Specifies the type of link that this DrillOutLink is.
void	setValue(java.lang.String value) Specifies the worksheet reference or a URL to which this DrillOutLink directs a user.
protected void	setXML(oracle.dss.util.xml.ObjectNode node) Specifies XML that represents properties and values.

Methods inherited from class java.lang.Object

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

Field Detail

URL

public static final int URL

Type: The Value is a URL string

See Also:

Constant Field Values

WORKSHEET_REFERENCE

public static final int WORKSHEET_REFERENCE

Type: The Value is a Worksheet Reference

See Also:

Constant Field Values

DRILL_OUT_LINK_NAME

protected static final java.lang.String DRILL_OUT_LINK_NAME

See Also:

Constant Field Values

a_type

protected static final java.lang.String a_type

See Also:

Constant Field Values

a_value

protected static final java.lang.String a_value

See Also:

Constant Field Values

a_label

protected static final java.lang.String a_label

See Also:

Constant Field Values

a_id

protected static final java.lang.String a_id

See Also:

Constant Field Values

url

protected static final java.lang.String url

See Also:

Constant Field Values

worksheet_ref

protected static final java.lang.String worksheet_ref

See Also:

Constant Field Values

s_drillOut

protected static final java.lang.String s_drillOut

See Also:

Constant Field Values

s_type

protected static final java.lang.String s_type

See Also:

Constant Field Values

s_value

protected static final java.lang.String s_value

See Also:

Constant Field Values

s_label

protected static final java.lang.String s_label

See Also:

Constant Field Values

s_id

protected static final java.lang.String s_id

See Also:

Constant Field Values

s_url

protected static final java.lang.String s_url

See Also:

Constant Field Values

s_worksheet_ref

protected static final java.lang.String s_worksheet_ref

See Also:

Constant Field Values

Constructor Detail

DrillOutLink

public DrillOutLink(int type,
                    java.lang.String value,
                    java.lang.String label,
                    java.lang.String id)

Constructor. The BI Beans team would like to have the same tokens used for worksheet reference links and URL-based links.

Parameters:

type - A constant that identifies the type of information that the value argument holds. Valid constants are listed in the See Also section.

value - Where to link to. If type is WORKSHEET_REFERENCE, then pass a String representation of a worksheet reference, including the worksheet name and any tokens that are needed. If type is URL, then pass a tokenized URL.

label - The label that should appear in the popup. This is the text that the user clicks on to drill out.

id - A unique ID for this DrillOutLink. This ID is used to determine whether the same value and label can be used in multiple cells.

See Also:

URL, WORKSHEET_REFERENCE

Method Detail

getType

public int getType()

Retrieves the type of link that this DrillOutLink is. The Type property determines how the Value property is interpreted.

Returns:

A constant that identifies whether the Value is a worksheet reference or a URL.

See Also:

URL, WORKSHEET_REFERENCE

setType

public void setType(int type)

Specifies the type of link that this DrillOutLink is. The Type property determines how the Value property is interpreted.

Parameters:

type - A constant that identifies whether the Value is a worksheet reference or a URL.

See Also:

URL, WORKSHEET_REFERENCE

getValue

public java.lang.String getValue()

Retrieves the worksheet reference or a URL to which this DrillOutLink directs a user.

Returns:

The worksheet reference or URL to which this object links.

setValue

public void setValue(java.lang.String value)

Specifies the worksheet reference or a URL to which this DrillOutLink directs a user.

Parameters:

value - The worksheet reference or URL to which this object links.

getLabel

public java.lang.String getLabel()

Retrieves the label that appears in the popup for a cell that has a DrillOutLink.

Returns:

The label to display in the popup.

setLabel

public void setLabel(java.lang.String label)

Specifies the label that appears in the popup for a cell that has a DrillOutLink.

Parameters:

label - The label to display in the popup.

getID

public java.lang.String getID()

Retrieves the unique ID for this DrillOutLink. You can use the same DrillOutLink for more than one cell.

Returns:

The unique id for this DrillOutLink.

getXML

protected oracle.dss.util.xml.ObjectNode getXML(boolean allProperties)

Retrieves XML that represents properties and their values in the form of and ObjectNode.

Parameters:

allProperties - true to store all property values in XML, false to store only values that are different from default values.

Returns:

XML for the properties and values.

setXML

protected void setXML(oracle.dss.util.xml.ObjectNode node)

Specifies XML that represents properties and values.

Parameters:

node - ObjectNode that has the properties and their values.

getStateAsObjectNode

protected oracle.dss.util.xml.ObjectNode getStateAsObjectNode()

Retrieves XML that represents properties and their values in the form of and ObjectNode.

Parameters:

allProperties - true to store all property values in XML, false to store only values that are different from default values.

Returns:

XML for the properties and values.

setStateAsObjectNode

protected void setStateAsObjectNode(oracle.dss.util.xml.ObjectNode node)

Specifies XML that represents properties and values.

Parameters:

node - ObjectNode that has the properties and their values.

equals

public boolean equals(java.lang.Object object)

Checks whether the specified DrillOutLink is identical to this DrillOutLink instance.

Overrides:

equals in class java.lang.Object