com.ibm.itim.adhocreport
Class ReportXML

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

public class ReportXML
extends java.lang.Object
implements java.io.Serializable

This is a wrapper class for representing the report template XML file.

See Also:
Serialized Form

Constructor Summary
ReportXML()
           
ReportXML(java.io.FileInputStream file)
          This is a constructor which takes the XML report template as input
ReportXML(int reportId)
          This is a constructor which takes the report template ID
ReportXML(org.w3c.dom.Node node)
          This is a constructor which takes the location of the XML file and constructs the object.
 
Method Summary
 java.lang.String getAuthor()
          Get the report designer name
 java.sql.Timestamp getCreationTime()
          Get the template creation time
 java.lang.String getCreationTimeZone()
          Get the template creation time zone
 java.sql.Timestamp getLastUpdateTime()
          Get last updation time
 java.lang.String getLastUpdateTimeZone()
          Get the last updation time zone
 java.lang.String getLastUpdateUser()
          Get the name of the user who updated the report last
 int getPageLines()
          Get the number of lines per page
 java.lang.String getPageNumberFormat()
          Gets the format in which page numbers are displayed on the report
 Query getQuery()
          This method returns the Query object
 java.lang.String getStyle()
          Get the stylesheet name
 java.lang.String getTimestampTimeZone()
          Get the time stamp zone
 java.lang.String getTitle()
          The method retuns empty String since title is now picked up from reporttemplate object.
 java.lang.String getVersion()
          Retuns the version of the template file
 org.w3c.dom.Node getXML()
          Returns the XML document
 void setAll(java.lang.String version, java.sql.Timestamp creationTime, java.lang.String creationTimeZone, java.lang.String author, java.sql.Timestamp lastUpdateTime, java.lang.String lastUpdateTimeZone, java.lang.String lastUpdateUser, java.lang.String style, java.lang.String title, int pageLines, boolean showTimestamp, java.lang.String timestampTimeZone, boolean showUser, boolean showLogo, boolean showPageNumbers, java.lang.String pageNumberFormat)
          Sets the values of the various data members of the class.
 void setAuthor(java.lang.String author)
          Set the report designer name
 void setCreationTime(java.sql.Timestamp creationTime)
          Set the template creation time
 void setCreationTimeZone(java.lang.String creationTimeZone)
          Set the template creation time zone
 void setLastUpdateTime(java.sql.Timestamp lastUpdateTime)
          Set last updation time
 void setLastUpdateTimeZone(java.lang.String lastUpdateTimeZone)
          Set the last updation time zone
 void setLastUpdateUser(java.lang.String lastUpdateUser)
          Set the name of the user who updated the report last
 void setPageLines(int pageLines)
          Set the number of lines per page
 void setPageNumberFormat(java.lang.String pageNumberFormat)
          Sets the format in which page numbers are displayed on the report
 void setQuery(Query query)
          This method sets the Query object.
 void setShowLogo(boolean showLogo)
          Sets a flag indicating whether to show the logo on the report
 void setShowPageNumbers(boolean showPageNumbers)
          Sets a flag indicating whether to show page numbers on the report
 void setShowTimestamp(boolean showTimestamp)
          Sets the flag that indicates whether to show time stamp on the report
 void setShowUser(boolean showUser)
          Sets a flag indicating whether to show the name of the author on the report
 void setStyle(java.lang.String style)
          Set the stylesheet name
 void setTimestampTimeZone(java.lang.String timestampTimeZone)
          Set the time stamp zone, Set to "GMT" by default
 void setTitle(java.lang.String title)
          The method set report title as a dummy String since title is now set in reporttemplate object.
 void setVersion(java.lang.String version)
          Sets the version of the template file
 boolean showLogo()
          Returns a flag indicating whether to show the logo on the report
 boolean showPageNumbers()
          Returns a flag indicating whether to show page numbers on the report
 boolean showTimestamp()
          Indicates whether to show time stamp on the report
 boolean showUser()
          Returns a flag indicating whether to show the name of the author on the report
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ReportXML

public ReportXML(org.w3c.dom.Node node)
          throws InvalidReportColumnException
This is a constructor which takes the location of the XML file and constructs the object.
Parameters:
xml - - The XML file location as a java String

ReportXML

public ReportXML(java.io.FileInputStream file)
This is a constructor which takes the XML report template as input
Parameters:
file - The inputstream of the XML file from the server filesystem

ReportXML

public ReportXML(int reportId)
This is a constructor which takes the report template ID
Parameters:
reportId - This is the report template id

ReportXML

public ReportXML()
Method Detail

setAll

public void setAll(java.lang.String version,
                   java.sql.Timestamp creationTime,
                   java.lang.String creationTimeZone,
                   java.lang.String author,
                   java.sql.Timestamp lastUpdateTime,
                   java.lang.String lastUpdateTimeZone,
                   java.lang.String lastUpdateUser,
                   java.lang.String style,
                   java.lang.String title,
                   int pageLines,
                   boolean showTimestamp,
                   java.lang.String timestampTimeZone,
                   boolean showUser,
                   boolean showLogo,
                   boolean showPageNumbers,
                   java.lang.String pageNumberFormat)
Sets the values of the various data members of the class.
Parameters:
version -  
creationTime -  
creationTimeZone -  
author -  
lastUpdateTime -  
lastUpdateTimeZone -  
lastUpdateUser -  
style -  
title -  
pageLines -  
showTimestamp -  
timestampTimeZone -  
showUser -  
showLogo -  
showPageNumbers -  
pageNumberFormat -  

getXML

public org.w3c.dom.Node getXML()
                        throws javax.xml.parsers.ParserConfigurationException
Returns the XML document
Returns:
 
Throws:
javax.xml.parsers.ParserConfigurationException -  

getQuery

public Query getQuery()
This method returns the Query object
Returns:
 

setQuery

public void setQuery(Query query)
This method sets the Query object.
Parameters:
query -  

getVersion

public java.lang.String getVersion()
Retuns the version of the template file
Returns:
 

setVersion

public void setVersion(java.lang.String version)
Sets the version of the template file
Parameters:
version -  

getCreationTime

public java.sql.Timestamp getCreationTime()
Get the template creation time
Returns:
 

setCreationTime

public void setCreationTime(java.sql.Timestamp creationTime)
Set the template creation time
Parameters:
creationTime -  

getCreationTimeZone

public java.lang.String getCreationTimeZone()
Get the template creation time zone
Returns:
 

setCreationTimeZone

public void setCreationTimeZone(java.lang.String creationTimeZone)
Set the template creation time zone
Parameters:
creationTimeZone -  

getAuthor

public java.lang.String getAuthor()
Get the report designer name
Returns:
 

setAuthor

public void setAuthor(java.lang.String author)
Set the report designer name
Parameters:
author -  

getLastUpdateTime

public java.sql.Timestamp getLastUpdateTime()
Get last updation time
Returns:
 

setLastUpdateTime

public void setLastUpdateTime(java.sql.Timestamp lastUpdateTime)
Set last updation time
Parameters:
lastUpdateTime -  

getLastUpdateTimeZone

public java.lang.String getLastUpdateTimeZone()
Get the last updation time zone
Returns:
 

setLastUpdateTimeZone

public void setLastUpdateTimeZone(java.lang.String lastUpdateTimeZone)
Set the last updation time zone
Parameters:
lastUpdateTimeZone -  

getLastUpdateUser

public java.lang.String getLastUpdateUser()
Get the name of the user who updated the report last
Returns:
 

setLastUpdateUser

public void setLastUpdateUser(java.lang.String lastUpdateUser)
Set the name of the user who updated the report last
Parameters:
lastUpdateUser -  

getStyle

public java.lang.String getStyle()
Get the stylesheet name
Returns:
 

setStyle

public void setStyle(java.lang.String style)
Set the stylesheet name
Parameters:
style -  

getTitle

public java.lang.String getTitle()
The method retuns empty String since title is now picked up from reporttemplate object.
Returns:
 

setTitle

public void setTitle(java.lang.String title)
The method set report title as a dummy String since title is now set in reporttemplate object.
Parameters:
title -  

getPageLines

public int getPageLines()
Get the number of lines per page
Returns:
 

setPageLines

public void setPageLines(int pageLines)
Set the number of lines per page
Parameters:
pageLines -  

showTimestamp

public boolean showTimestamp()
Indicates whether to show time stamp on the report
Returns:
 

setShowTimestamp

public void setShowTimestamp(boolean showTimestamp)
Sets the flag that indicates whether to show time stamp on the report
Parameters:
showTimestamp -  

getTimestampTimeZone

public java.lang.String getTimestampTimeZone()
Get the time stamp zone
Returns:
 

setTimestampTimeZone

public void setTimestampTimeZone(java.lang.String timestampTimeZone)
Set the time stamp zone, Set to "GMT" by default
Parameters:
timestampTimeZone -  

showUser

public boolean showUser()
Returns a flag indicating whether to show the name of the author on the report
Returns:
 

setShowUser

public void setShowUser(boolean showUser)
Sets a flag indicating whether to show the name of the author on the report
Parameters:
showUser -  

showLogo

public boolean showLogo()
Returns a flag indicating whether to show the logo on the report
Returns:
 

setShowLogo

public void setShowLogo(boolean showLogo)
Sets a flag indicating whether to show the logo on the report
Parameters:
showLogo -  

showPageNumbers

public boolean showPageNumbers()
Returns a flag indicating whether to show page numbers on the report
Returns:
 

setShowPageNumbers

public void setShowPageNumbers(boolean showPageNumbers)
Sets a flag indicating whether to show page numbers on the report
Parameters:
showPageNumbers -  

getPageNumberFormat

public java.lang.String getPageNumberFormat()
Gets the format in which page numbers are displayed on the report
Returns:
 

setPageNumberFormat

public void setPageNumberFormat(java.lang.String pageNumberFormat)
Sets the format in which page numbers are displayed on the report
Parameters:
pageNumberFormat -