public class

ReportTimelineXMLTransform

extends AbstractReportXMLTransform
java.lang.Object
   ↳ com.microstrategy.web.transform.AbstractTransform
     ↳ com.microstrategy.web.app.transforms.AbstractBasicReportTransform
       ↳ com.microstrategy.web.app.transforms.AbstractReportXMLTransform
         ↳ com.microstrategy.web.app.transforms.ReportTimelineXMLTransform

Class Overview

This transform generates the report xml necessary for the timeline AJAX visualization sample rendered by ReportTimelineVisualizationTransform
The following is a sample of the XML generated:

 <data>
   <event start="1/7/2002" title="event title 1" end="1/15/2002">event description 1</event>
   <event start="1/18/2002" title="event title 2" end="1/23/2002">event description 2</event>
 </data>
 
This transforms assumes the following regarding the report structure:
  • The report contains at least 2 attributes on the rows axis
  • The first attribute represents the event. This attribute has the following forms:
    • EventTitle
    • EventDescription - When clicked this opens in the popup window
    • EventImage - Image source of the image displayed in the popup.
    • EventColor - Color of the horizontal bar
    • EventIcon - Image source for the icon displayed on the timeline.
    • EventTextPostion - Whether to start the text to the right of the bar or on top of the bar
  • The second attribute represents the event's start date
  • The third attribute represents the event's end date (optional)
More information about the timeline code can be obtained from http://simile.mit.edu/timeline/

Summary

Fields
public FormalParameter _imagesLocation The location of the images used for the popup Default value: "images/"
[Expand]
Inherited Fields
From class com.microstrategy.web.app.transforms.AbstractBasicReportTransform
Public Constructors
ReportTimelineXMLTransform()
Public Methods
String getDescription()
void renderXml(MarkupOutput out)
Renders the report XML needed for the timeline AJAX visualization sample
Protected Methods
void addDateFormat(Tag dataTag)
Adds date-time-format="iso8601" to "data" XML tag
Note: overwrite this and getFormatedDate(String) to change date format.
String getFormatedDate(String dateStr)
Returns a date formatted as ISO 8601 as required per the timeline sample.
[Expand]
Inherited Methods
From class com.microstrategy.web.app.transforms.AbstractReportXMLTransform
From class com.microstrategy.web.app.transforms.AbstractBasicReportTransform
From class com.microstrategy.web.transform.AbstractTransform
From class java.lang.Object
From interface com.microstrategy.web.transform.Transform

Fields

public FormalParameter _imagesLocation

The location of the images used for the popup Default value: "images/"

Public Constructors

public ReportTimelineXMLTransform ()

Public Methods

public String getDescription ()

public void renderXml (MarkupOutput out)

Renders the report XML needed for the timeline AJAX visualization sample

Protected Methods

protected void addDateFormat (Tag dataTag)

Adds date-time-format="iso8601" to "data" XML tag
Note: overwrite this and getFormatedDate(String) to change date format.

protected String getFormatedDate (String dateStr)

Returns a date formatted as ISO 8601 as required per the timeline sample.
Note: overwrite this and addDateFormat(Tag) to change date format.

Parameters
dateStr the date to format
Returns
  • The date formatted as ISO 8601