com.ibm.itim.adhocreport
Class ReportColumn

java.lang.Object
  |
  +--com.ibm.itim.adhocreport.ReportColumn
All Implemented Interfaces:
java.lang.Comparable, java.io.Serializable

public class ReportColumn
extends java.lang.Object
implements java.io.Serializable, java.lang.Comparable

This class is a wrapper for the columns contained in ad hoc report template. These are the columns in the SELECT clause of the report SQL query.

See Also:
Serialized Form

Constructor Summary
ReportColumn()
           
ReportColumn(org.w3c.dom.Node node)
          This is a constructor that populates the member variables after parsing the XML string passed as an argument.
 
Method Summary
 int compareTo(java.lang.Object obj)
          This method will compare the values of 2 ReportColumn objects.
 int getId()
          This method returns the Column ID.
 java.lang.String getName()
          This method returns the name of the report column.
 int getSortOrder()
          This method gets the sort order of the report column.
 java.lang.String getSortType()
          This method gets the sort type of the report column.
 java.lang.String getSource()
          This method returns the source for the report column.
 int getWidth()
          This method returns the width of the report column.
 org.w3c.dom.Document getXML()
          This method returns the columns in XML format.
 void setAll(int id, java.lang.String entityName, java.lang.String attributeName, java.lang.String reportSource, java.lang.String functionName, int sortOrder, java.lang.String sortType, int width)
          Creates the ReportColumn object
 void setAll(java.lang.String name, int id, int sortOrder, java.lang.String sortType, int width, java.lang.String source)
          Sets the values for member variables
 void setId(int id)
          This method sets the Column ID.
 void setName(java.lang.String name)
          This method sets the name of the report column.
 void setSortOrder(int order)
          This method sets the sort order of the report column.
 void setSortType(java.lang.String type)
          This method sets the sort type of the report column.
 void setSource(java.lang.String source)
          This method sets the source for the report column.
 void setWidth(int width)
          This method sets the width of the report column.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ReportColumn

public ReportColumn()
Since:
1.0

ReportColumn

public ReportColumn(org.w3c.dom.Node node)
This is a constructor that populates the member variables after parsing the XML string passed as an argument.
Parameters:
xml - - This is an XML string containing the report columns.
Method Detail

compareTo

public int compareTo(java.lang.Object obj)
This method will compare the values of 2 ReportColumn objects. This method is needed to be implemented as part of the Comparable interface.
Specified by:
compareTo in interface java.lang.Comparable

setAll

public void setAll(java.lang.String name,
                   int id,
                   int sortOrder,
                   java.lang.String sortType,
                   int width,
                   java.lang.String source)
            throws InvalidReportColumnException
Sets the values for member variables
Parameters:
name - Display name of the column eg Person.Full Name
id -  
sortOrder -  
sortType -  
width -  
source - The actual source of the report column eg Person.cn
Throws:
InvalidReportColumnException -  

setId

public void setId(int id)
           throws InvalidReportColumnException
This method sets the Column ID.
Parameters:
id - - This is the value for the Column ID.
Throws:
InvalidReportColumnException -  

getId

public int getId()
This method returns the Column ID.
Returns:
int

setSortOrder

public void setSortOrder(int order)
                  throws InvalidReportColumnException
This method sets the sort order of the report column.
Parameters:
order - - This value indicates the sort order of the column.

getSortOrder

public int getSortOrder()
This method gets the sort order of the report column.
Returns:
int

setSortType

public void setSortType(java.lang.String type)
                 throws InvalidReportColumnException
This method sets the sort type of the report column.
Parameters:
order - - This value indicates the sort type of the column.

getSortType

public java.lang.String getSortType()
This method gets the sort type of the report column.
Returns:
String

setWidth

public void setWidth(int width)
              throws InvalidReportColumnException
This method sets the width of the report column.
Parameters:
width - - This value specifies the width of the report column.

getWidth

public int getWidth()
This method returns the width of the report column.
Returns:
int

setName

public void setName(java.lang.String name)
             throws InvalidReportColumnException
This method sets the name of the report column.
Parameters:
name - - This is the name of the report column.

getName

public java.lang.String getName()
This method returns the name of the report column.
Returns:
java.lang.String

getXML

public org.w3c.dom.Document getXML()
                            throws javax.xml.parsers.ParserConfigurationException
This method returns the columns in XML format.
Returns:
Node

getSource

public java.lang.String getSource()
This method returns the source for the report column.
Returns:
java.lang.String

setSource

public void setSource(java.lang.String source)
               throws InvalidReportColumnException
This method sets the source for the report column.
Parameters:
source - - This specifies the source for the report column.

setAll

public void setAll(int id,
                   java.lang.String entityName,
                   java.lang.String attributeName,
                   java.lang.String reportSource,
                   java.lang.String functionName,
                   int sortOrder,
                   java.lang.String sortType,
                   int width)
            throws InvalidReportColumnException
Creates the ReportColumn object
Parameters:
id -  
entityName -  
attributeName -  
functionName -  
sortOrder -  
sortType -  
width -  
Throws:
InvalidReportColumnException -