Style Intelligence v12.0

inetsoft.uql
Class XDrillInfo

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

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

XDrillInfo defines a drill info with a group drill path.

See Also:
Serialized Form

Constructor Summary
XDrillInfo()
          Create an empty drill info.
 
Method Summary
 int addDrillPath(DrillPath path)
          Add a drill path to the info.
 void clear()
          Remove all components from the path.
 Object clone()
          Clone the object.
 boolean contains(DrillPath path)
          Check if the specified drill path is in the info.
 void copyDrillPaths(XDrillInfo info)
          Copy drill paths.
 boolean equals(Object obj)
          Check if equals another object.
 DataRef getColumn()
          Get the field this drill is defined on.
 DrillPath getDrillPath(int idx)
          Get the specified drill path.
 int getDrillPathCount()
          Get the drill paths count.
 Enumeration getDrillPaths()
          Get the all drill paths.
 int indexOf(DrillPath path)
          Get the index of the specified drill path.
 boolean isEmpty()
          Check if there is no drill paths in the info.
 void parseXML(Element tag)
          Method to parse an xml segment.
 boolean removeDrillPath(DrillPath path)
          Remove a selected drill path.
 boolean removeDrillPath(int idx)
          Remove a selected drill path.
 void setColumn(DataRef column)
          Set the column this drill is defined on.
 void setDrillPath(int idx, DrillPath path)
          Set the specified drill path.
 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, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

XDrillInfo

public XDrillInfo()
Create an empty drill info.

Method Detail

copyDrillPaths

public void copyDrillPaths(XDrillInfo info)
Copy drill paths.

Parameters:
info - the drill info to copy from.

addDrillPath

public int addDrillPath(DrillPath path)
Add a drill path to the info.

Parameters:
path - the drill path.

removeDrillPath

public boolean removeDrillPath(DrillPath path)
Remove a selected drill path.

Parameters:
path - the selected drill path.

removeDrillPath

public boolean removeDrillPath(int idx)
Remove a selected drill path.

Parameters:
idx - the index of selected drill path.

isEmpty

public boolean isEmpty()
Check if there is no drill paths in the info.


getDrillPathCount

public int getDrillPathCount()
Get the drill paths count.


getDrillPaths

public Enumeration getDrillPaths()
Get the all drill paths.


setDrillPath

public void setDrillPath(int idx,
                         DrillPath path)
Set the specified drill path.

Parameters:
idx - the index of the selected drill path.
path - the selected drill path.

getDrillPath

public DrillPath getDrillPath(int idx)
Get the specified drill path.

Parameters:
idx - the index of the selected drill path.

contains

public boolean contains(DrillPath path)
Check if the specified drill path is in the info.


indexOf

public int indexOf(DrillPath path)
Get the index of the specified drill path.


getColumn

public DataRef getColumn()
Get the field this drill is defined on.

Returns:
the field this drill is defined.

setColumn

public void setColumn(DataRef column)
Set the column this drill is defined on.

Parameters:
column - the specified field this drill is defined on.

clear

public void clear()
Remove all components from the path.


equals

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

Overrides:
equals in class 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.