Style Intelligence v12.0

inetsoft.uql
Class DrillPath

java.lang.Object
  extended by inetsoft.uql.DrillPath
All Implemented Interfaces:
inetsoft.util.XMLSerializable, Serializable, Cloneable

public class DrillPath
extends Object
implements inetsoft.util.XMLSerializable, Serializable, Cloneable

DrillPath defines a drill path to a report or a URL.

See Also:
Serialized Form

Field Summary
static int REPORT_LINK
          Link to other report/replet.
static int VIEWSHEET_LINK
          Link to a viewsheet.
static int WEB_LINK
          Web link.
 
Constructor Summary
DrillPath(String name)
          Create a drill path.
 
Method Summary
 Object clone()
          Clone the object.
 DrillPath copyDrillPath(String name)
          Copy the object with a new name.
 boolean equals(Object obj)
          Check if equals another object.
 boolean equalsContent(Object obj)
          Check if equals another object.
 String getLink()
          Get the hyperlink.
 int getLinkType()
          Get the link type of this hyperlink
 String getName()
          Get the name.
 int getParameterCount()
          Get the number of parameters defined for this link.
 String getParameterField(String name)
          Get the field value for the parameter.
 Enumeration getParameterNames()
          Get all parameter names.
 String getParameterType(String name)
          Get the type value for the hard-coded parameter.
 DrillSubQuery getQuery()
          Get drill subquery.
 String getTargetFrame()
          Get the target frame.
 String getToolTip()
          Get the tooltip.
 int hashCode()
          Get the hash code of the drill path.
 boolean isDisablePrompting()
          Check whether to disable the prompting of the parameters on the target report.
 boolean isParameterHardCoded(String name)
          Judge whether the parameter is hard-coded or not.
 boolean isSendReportParameters()
          Check if to pass all report parameters to the linked report.
 void parseXML(Element tag)
          Method to parse an xml segment.
 void removeAllParameterFields()
          Remove all parameter fields.
 void removeParameterField(String name)
          Remove a parameter field.
 void setDisablePrompting(boolean disable)
          Set whether to disable the prompting of the parameters on the target report.
 void setLink(String link)
          Set the hyperlink.
 void setLinkType(int linkType)
          Set the link type.
 void setParameterField(String name, String field)
          Set the field name for the parameter.
 void setParameterType(String name, String type)
          Set the type name for the parameter.
 void setQuery(DrillSubQuery query)
          Set the drill subquery.
 void setSendReportParameters(boolean pass)
          Set whether to pass all report parameters to the link report.
 void setTargetFrame(String targetFrame)
          Set the target frame.
 void setToolTip(String tip)
          Set the tooltip.
 String toString()
          Get the string representaion.
 void writeXML(PrintWriter writer)
          Write the xml segment to print writer.
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

REPORT_LINK

public static final int REPORT_LINK
Link to other report/replet.

See Also:
Constant Field Values

WEB_LINK

public static final int WEB_LINK
Web link.

See Also:
Constant Field Values

VIEWSHEET_LINK

public static final int VIEWSHEET_LINK
Link to a viewsheet.

See Also:
Constant Field Values
Constructor Detail

DrillPath

public DrillPath(String name)
Create a drill path.

Method Detail

copyDrillPath

public DrillPath copyDrillPath(String name)
Copy the object with a new name.


getName

public String getName()
Get the name.


setLink

public void setLink(String link)
Set the hyperlink. It could be a report name (path) or a URL.

Parameters:
link - for Web URL, the link must be the full URL including the protocol. If the link is to another report, it should be the report path as registered in report server.

getLink

public String getLink()
Get the hyperlink.


setTargetFrame

public void setTargetFrame(String targetFrame)
Set the target frame.

Parameters:
targetFrame - is the window name.

getTargetFrame

public String getTargetFrame()
Get the target frame.


setToolTip

public void setToolTip(String tip)
Set the tooltip. If tooltip is set, the tip is shown when mouse moves into the hyperlink.


getToolTip

public String getToolTip()
Get the tooltip.


setLinkType

public void setLinkType(int linkType)
Set the link type.

Parameters:
linkType - link type.

getLinkType

public int getLinkType()
Get the link type of this hyperlink

Returns:
link type.

setQuery

public void setQuery(DrillSubQuery query)
Set the drill subquery.

Parameters:
query - the specified subquery.

getQuery

public DrillSubQuery getQuery()
Get drill subquery.

Returns:
drill subquery.

setSendReportParameters

public void setSendReportParameters(boolean pass)
Set whether to pass all report parameters to the link report.

Parameters:
pass - true to pass all report parameters. It defaults to true.

isSendReportParameters

public boolean isSendReportParameters()
Check if to pass all report parameters to the linked report. It defaults to true.


setDisablePrompting

public void setDisablePrompting(boolean disable)
Set whether to disable the prompting of the parameters on the target report.


isDisablePrompting

public boolean isDisablePrompting()
Check whether to disable the prompting of the parameters on the target report.


getParameterNames

public Enumeration getParameterNames()
Get all parameter names.


getParameterCount

public int getParameterCount()
Get the number of parameters defined for this link.


getParameterField

public String getParameterField(String name)
Get the field value for the parameter.


getParameterType

public String getParameterType(String name)
Get the type value for the hard-coded parameter.


setParameterField

public void setParameterField(String name,
                              String field)
Set the field name for the parameter.

Parameters:
name - parameter name.
field - data field name.

setParameterType

public void setParameterType(String name,
                             String type)
Set the type name for the parameter.

Parameters:
name - parameter name.
type - type name.

isParameterHardCoded

public boolean isParameterHardCoded(String name)
Judge whether the parameter is hard-coded or not.

Parameters:
name - parameter name.

removeParameterField

public void removeParameterField(String name)
Remove a parameter field.

Parameters:
name - parameter name.

removeAllParameterFields

public void removeAllParameterFields()
Remove all parameter fields.


hashCode

public int hashCode()
Get the hash code of the drill path.

Overrides:
hashCode in class Object
Returns:
the hash code of the drill path.

equals

public boolean equals(Object obj)
Check if equals another object.

Overrides:
equals in class Object

equalsContent

public boolean equalsContent(Object obj)
Check if equals another object.


toString

public String toString()
Get the string representaion.

Overrides:
toString in class Object

clone

public Object clone()
Clone the object.

Overrides:
clone in class Object

writeXML

public void writeXML(PrintWriter writer)
Write the xml segment to print writer.

Specified by:
writeXML in interface inetsoft.util.XMLSerializable
Parameters:
writer - the destination print writer.

parseXML

public void parseXML(Element tag)
              throws Exception
Method to parse an xml segment.

Specified by:
parseXML in interface inetsoft.util.XMLSerializable
Throws:
Exception

Copyright © 1996-2014 InetSoft Technology Corp. All Rights Reserved.