|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.itim.adhocreport.ReportXML
This is a wrapper class for representing the report template XML file.
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 |
public ReportXML(org.w3c.dom.Node node) throws InvalidReportColumnException
xml
- - The XML file location as a java Stringpublic ReportXML(java.io.FileInputStream file)
file
- The inputstream of the XML file from the server filesystempublic ReportXML(int reportId)
reportId
- This is the report template idpublic ReportXML()
Method Detail |
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)
version
- creationTime
- creationTimeZone
- author
- lastUpdateTime
- lastUpdateTimeZone
- lastUpdateUser
- style
- title
- pageLines
- showTimestamp
- timestampTimeZone
- showUser
- showLogo
- showPageNumbers
- pageNumberFormat
- public org.w3c.dom.Node getXML() throws javax.xml.parsers.ParserConfigurationException
javax.xml.parsers.ParserConfigurationException
- public Query getQuery()
public void setQuery(Query query)
query
- public java.lang.String getVersion()
public void setVersion(java.lang.String version)
version
- public java.sql.Timestamp getCreationTime()
public void setCreationTime(java.sql.Timestamp creationTime)
creationTime
- public java.lang.String getCreationTimeZone()
public void setCreationTimeZone(java.lang.String creationTimeZone)
creationTimeZone
- public java.lang.String getAuthor()
public void setAuthor(java.lang.String author)
author
- public java.sql.Timestamp getLastUpdateTime()
public void setLastUpdateTime(java.sql.Timestamp lastUpdateTime)
lastUpdateTime
- public java.lang.String getLastUpdateTimeZone()
public void setLastUpdateTimeZone(java.lang.String lastUpdateTimeZone)
lastUpdateTimeZone
- public java.lang.String getLastUpdateUser()
public void setLastUpdateUser(java.lang.String lastUpdateUser)
lastUpdateUser
- public java.lang.String getStyle()
public void setStyle(java.lang.String style)
style
- public java.lang.String getTitle()
public void setTitle(java.lang.String title)
title
- public int getPageLines()
public void setPageLines(int pageLines)
pageLines
- public boolean showTimestamp()
public void setShowTimestamp(boolean showTimestamp)
showTimestamp
- public java.lang.String getTimestampTimeZone()
public void setTimestampTimeZone(java.lang.String timestampTimeZone)
timestampTimeZone
- public boolean showUser()
public void setShowUser(boolean showUser)
showUser
- public boolean showLogo()
public void setShowLogo(boolean showLogo)
showLogo
- public boolean showPageNumbers()
public void setShowPageNumbers(boolean showPageNumbers)
showPageNumbers
- public java.lang.String getPageNumberFormat()
public void setPageNumberFormat(java.lang.String pageNumberFormat)
pageNumberFormat
-
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |