public class i4Report
extends java.lang.Object
implements java.io.Serializable
| Modifier and Type | Field and Description |
|---|---|
static int |
SORT_ASCENDING
Constant value representing ascending sort.
|
static int |
SORT_DESCENDING
Constant value representing descending sort.
|
| Constructor and Description |
|---|
i4Report(ReportServiceResponse rs,
java.util.HashMap Storage) |
| Modifier and Type | Method and Description |
|---|---|
boolean |
broadcastReport(java.lang.String Subject,
java.lang.String content,
java.lang.String[] recipients,
java.lang.String attachmentType) |
boolean |
broadcastReport(java.lang.String Subject,
java.lang.String content,
java.lang.String[] recipients,
java.lang.String attachmentType,
java.lang.String distributeMethod) |
boolean |
canUserSubscribe() |
boolean |
deleteComment(java.lang.Integer CommentId) |
boolean |
distributeReport(java.lang.String[] recipients) |
boolean |
distributeReport(java.lang.String[] recipients,
java.lang.String message) |
boolean |
filterHasDependantChildren(java.lang.Integer filterId)
Returns whether or not a filter has child filters that are dependant on it.
|
java.lang.Integer |
getAbsoluteTableWidth() |
java.lang.String |
getAuthor() |
java.lang.String |
getAuthoringMode()
How the report was authored: "JAVA" (Standard drag-and-drop builder),
"SQL" (Freehand SQL), "JASPER", "BIRT".
|
java.lang.Integer |
getAverageRunTime() |
java.lang.String |
getBinaryURL()
Get URL for binary link.
|
java.util.HashMap |
getBlobs()
Get binary objects
|
BreadCrumb[] |
getBreadcrumbs() |
java.lang.Boolean |
getCanDrill() |
java.lang.String |
getCategory() |
java.lang.Integer |
getChartHeight() |
java.lang.String |
getChartPlacementCode() |
java.util.HashMap |
getCharts()
Get charts returned with the report
|
java.lang.Integer |
getChartScale() |
java.lang.Integer |
getChartWidth() |
java.lang.String |
getColumnDisplayName(java.lang.String colName)
Returns the display name for a column.
|
ReportSchema[] |
getColumns()
Retrieve columns from report object
|
java.lang.String |
getColumnType(java.lang.String ColumnName)
Get the column type.
|
ReportComment[] |
getComments() |
java.lang.String |
getContentType()
Get the Content Type (mime-type) of the report
|
java.lang.String |
getDataFormatterType()
Data formatter type to use.
|
java.lang.String |
getDataOutput()
Data output type: "COLUMN", "ROW", "PIVOT"
|
java.lang.String |
getDatasource() |
java.lang.Integer |
getDisplayedReportId()
After running a report, this will return the id of the report
displayed.
|
java.lang.String |
getDrillCode() |
java.lang.String |
getExecutionObject()
Get the Execution Object Name
|
ReportSchema |
getFilterColumn(java.lang.Integer filterId)
Gets the ReportSchema object for a filter.
|
java.lang.String[] |
getFilterColumns()
Deprecated.
use
getFilterIds() or getFilterSchema() |
java.lang.Integer[] |
getFilterIds()
Get the filterIds for all required filters
|
ReportSchema[] |
getFilterSchema()
Get the column schema objects for all required filters
|
java.lang.String |
getFilterType(java.lang.String ColumnName)
Deprecated.
|
java.lang.String |
getFilterTypeById(java.lang.Integer filterId)
Get the column type for a filter.
|
java.lang.String |
getFilterValue(java.lang.String ColumnName,
java.lang.String DataValue)
Deprecated.
|
java.lang.String |
getFilterValueById(java.lang.Integer filterId)
Get the stored value of a user prompt filter.
|
java.lang.Boolean |
getFitTableWidth() |
java.lang.String |
getFormatCode()
Get the Format Code of Report
|
GISMap[] |
getGisMap() |
GMap[] |
getGoogleMaps() |
java.lang.String |
getImageType()
Returns the image type used for rendering charts
|
java.lang.String |
getImageURL()
Returns URL for image generation.
|
java.lang.String |
getLanguageCode() |
java.lang.String |
getLastModifiedDate() |
java.lang.Integer |
getLastRunDuration()
Get last run duration of report
|
java.lang.String |
getLastRunStatus()
Get last run status
|
java.math.BigDecimal |
getLastRunTime()
Get last run time
|
java.lang.String |
getLinkFormatterClass() |
java.lang.String |
getLinkURL()
Returns URL for link generation.
|
java.lang.String[] |
getMessages()
Get status messages generated by Yellowfin
|
java.lang.String |
getMultiReportTag() |
int |
getPort()
Get TCPIP port that is being used for connecting to webservices.
|
java.lang.String |
getPreReportRunFilter() |
RelatedReports |
getRelatedReports() |
java.lang.String |
getReportDescription() |
java.lang.Integer |
getReportId()
Get internal Yellowfin report Id
|
java.lang.String |
getReportName()
Get the Report Name
|
java.lang.String[] |
getReportOptions() |
ReportPageSelection[] |
getReportPageSelection() |
java.lang.String |
getReportStyle()
Returns the CSS style used for this report.
|
ReportTabSelection[] |
getReportTabSelection() |
java.lang.String |
getReportTemplate()
Report template: "REPORT", "CHART", "REPORTANDCHART"
|
java.lang.Integer |
getReportUsage() |
java.lang.String |
getRequestStatus()
Get last webservices request status
|
java.lang.Integer |
getSelectedSortColumn() |
java.lang.Integer |
getSelectedSortType() |
SeriesSelection[] |
getSeriesSelection() |
SortableTableColumn[] |
getSortableColumns() |
java.lang.String |
getSubCategory() |
ScheduleRecord |
getSubscriptionSchedule() |
java.lang.String |
getTags() |
TimeAggregationSelection[] |
getTimeAggregationSelection() |
TimeSliderSelection[] |
getTimeSliderSelection() |
java.lang.String |
getUsername()
Get webservices request username
|
java.lang.String |
getViewName() |
int |
getVisibleColumns()
Get number of visible columns
|
java.lang.String |
getWebServicesURL()
Get webservices request URL
|
boolean |
isActiveCharts() |
boolean |
isAllowInteractiveGoogleMaps() |
boolean |
isDashboardEnabled()
Is the report enabled for dashboard use?
|
boolean |
isGisNavigation() |
boolean |
isMultiCharts() |
java.lang.Boolean |
isPrivate() |
boolean |
isShowAlertImages()
Get status of Show Alert Images
|
boolean |
isShowAlertLegendTable() |
boolean |
isShowAlerts()
Get status of Alerts
|
boolean |
isShowCharts()
Get status of ShowCharts
|
boolean |
isShowCoDisplay() |
boolean |
isShowDrillDownStack() |
boolean |
isShowDrillThroughStack() |
boolean |
isShowLinks()
Get status of ShowLinks
|
boolean |
isShowPageSelection() |
boolean |
isShowSeriesSelection() |
boolean |
isShowSort()
Get status of ShowSort
|
boolean |
isShowTabs() |
boolean |
isShowTimeSlider() |
boolean |
isShowTimeUnitSelection() |
boolean |
isShowTitle()
Get status of ShowTitle
|
boolean |
isSinglePage() |
boolean |
isTriggerJSGoogleMapsSetup() |
boolean |
populateComments() |
boolean |
populateDetails() |
boolean |
populateSubscription() |
boolean |
postComment(java.lang.Integer ParentCommentId,
java.lang.String Comment) |
boolean |
postComment(java.lang.Integer ParentCommentId,
java.lang.String Comment,
java.lang.Integer authorId) |
java.lang.String |
render()
Render the report.
|
byte[] |
renderBinary()
Render the report.
|
java.util.ArrayList |
retrieveFilterPromptValues(java.lang.Integer filterId)
Retrieves a list of options for a filter.
|
void |
run()
Run the report.
|
void |
run(java.util.HashMap Storage)
Run the report.
|
void |
run(java.util.HashMap Storage,
java.lang.String Type)
Run the report.
|
void |
run(java.util.HashMap Storage,
java.lang.String Type,
boolean multiChart) |
void |
runCommand(java.lang.String Command)
Run a modification command against the report.
|
void |
setAbsoluteTableWidth(java.lang.Integer absoluteTableWidth) |
void |
setActiveCharts(boolean activeCharts) |
void |
setAllowInteractiveGoogleMaps(boolean allowInteractiveGoogleMaps) |
void |
setBinaryURL(java.lang.String binaryURL)
Set URL for binary link.
|
void |
setBreadcrumbs(BreadCrumb[] breadcrumbs) |
void |
setCanDrill(java.lang.Boolean canDrill) |
void |
setCanUserSubscribe(boolean canUserSubscribe) |
void |
setChartHeight(java.lang.Integer chartHeight) |
void |
setChartPlacementCode(java.lang.String chartPlacementCode) |
void |
setCharts(java.util.HashMap charts)
Set charts
|
void |
setChartScale(java.lang.Integer chartScale) |
void |
setChartWidth(java.lang.Integer chartWidth) |
void |
setComments(ReportComment[] comments) |
void |
setDataFormatterType(java.lang.String dataFormatterType)
Data formatter type to use
|
void |
setDatasource(java.lang.String datasource) |
void |
setDrillCode(java.lang.String drillCode) |
boolean |
setFilter(java.lang.String ColumnName,
java.lang.String DataValue)
Deprecated.
|
boolean |
setFilterById(java.lang.Integer filterId,
java.lang.String value)
Set a user prompt filter.
|
boolean |
setFilterOmittedById(java.lang.Integer filterId)
Set a user prompt filter to be omitted.
|
void |
setFitTableWidth(java.lang.Boolean fitTableWidth) |
void |
setGisMap(GISMap[] gisMap) |
void |
setGisNavigation(boolean gisNavigation) |
void |
setGoogleMaps(GMap[] googleMaps) |
void |
setImageType(java.lang.String imageType)
Setes the image type used for rendering charts ("png", "jpg", "bmp", or "image/png", "image/jpeg", etc)
|
void |
setImageURL(java.lang.String imageURL)
Set URL for image generation.
|
void |
setIsPrivate(java.lang.Boolean isPrivate) |
void |
setLanguageCode(java.lang.String languageCode) |
void |
setLastModifiedDate(java.lang.String lastModifiedDate) |
void |
setLinkFormatterClass(java.lang.String linkFormatterClass)
Class type used to generate drill-anywhere links.
|
void |
setLinkURL(java.lang.String linkURL)
Set URL for link generation.
|
void |
setMultiCharts(boolean multiCharts) |
void |
setMultiReportTag(java.lang.String multiReportTag) |
void |
setPreReportRunFilter(java.lang.String preReportRunFilter) |
void |
setRelatedReports(RelatedReports relatedReports) |
void |
setReportName(java.lang.String reportName)
Set the Report Name (Used Internally)
|
void |
setReportOptions(java.lang.String[] reportOptions) |
void |
setReportPageSelection(ReportPageSelection[] reportPageSelection) |
void |
setReportTabSelection(ReportTabSelection[] reportTabSelection) |
void |
setReportUsage(java.lang.Integer reportUsage) |
void |
setSelectedSortColumn(java.lang.Integer selectedSortColumn) |
void |
setSelectedSortType(java.lang.Integer selectedSortType) |
void |
setSeriesSelection(SeriesSelection[] seriesSelection) |
void |
setShowAlertImages(boolean showAlertImages)
Show image based alerts in rendered HTML
|
void |
setShowAlertLegendTable(boolean showAlertLegendTable) |
void |
setShowAlerts(boolean showAlerts)
Show alerts in rendered report
|
void |
setShowCharts(boolean showCharts)
Show charts in rendered report
|
void |
setShowCoDisplay(boolean showCoDisplay) |
void |
setShowDrillDownStack(boolean showDrillDownStack) |
void |
setShowDrillThroughStack(boolean showDrillThroughStack) |
void |
setShowLinks(boolean showLinks)
Show links in rendered report
|
void |
setShowPageSelection(boolean showPageSelection) |
void |
setShowSeriesSelection(boolean showSeriesSelection) |
void |
setShowSort(boolean showSort)
Show sort links in rendered report
|
void |
setShowTabs(boolean showTabs) |
void |
setShowTimeSlider(boolean showTimeSlider) |
void |
setShowTimeUnitSelection(boolean showTimeUnitSelection) |
void |
setShowTitle(boolean showTitle)
Show title in rendered report
|
void |
setSinglePage(boolean singlePage) |
void |
setSortableColumns(SortableTableColumn[] sortableColumns) |
void |
setSubscriptionSchedule(ScheduleRecord subscriptionSchedule) |
void |
setTags(java.lang.String tags) |
void |
setTimeAggregationSelection(TimeAggregationSelection[] timeAggregationSelection) |
void |
setTimeSliderSelection(TimeSliderSelection[] timeSliderSelection) |
void |
setTriggerJSGoogleMapsSetup(boolean triggerJSGoogleMapsSetup) |
void |
setViewName(java.lang.String viewName) |
void |
setVisibleColumns(int visibleColumns)
Set visible column count (used internally)
|
void |
sortBy(int column,
int Direction)
Sort the report by a particular column.
|
boolean |
subscribeToReport(ScheduleRecord schedule) |
java.lang.String |
toString()
Print debug information for current report.
|
boolean |
unsubscribe() |
public static final int SORT_ASCENDING
public static final int SORT_DESCENDING
public i4Report(ReportServiceResponse rs, java.util.HashMap Storage) throws WebserviceException
WebserviceExceptionpublic void sortBy(int column,
int Direction)
throws WebserviceException
column - Direction - either SORT_ASCENDING or SORT_DESCENDINGWebserviceExceptionpublic void runCommand(java.lang.String Command)
throws WebserviceException
Command - WebserviceExceptionpublic java.lang.Integer getDisplayedReportId()
throws WebserviceException
WebserviceExceptionpublic void run()
throws WebserviceException
WebserviceExceptionpublic void run(java.util.HashMap Storage)
throws WebserviceException
Storage - WebserviceExceptionpublic void run(java.util.HashMap Storage,
java.lang.String Type)
throws WebserviceException
Storage - Type - WebserviceExceptionpublic void run(java.util.HashMap Storage,
java.lang.String Type,
boolean multiChart)
throws WebserviceException
WebserviceExceptionpublic boolean populateComments()
public boolean postComment(java.lang.Integer ParentCommentId,
java.lang.String Comment)
public boolean postComment(java.lang.Integer ParentCommentId,
java.lang.String Comment,
java.lang.Integer authorId)
public boolean populateSubscription()
public boolean deleteComment(java.lang.Integer CommentId)
public java.util.ArrayList retrieveFilterPromptValues(java.lang.Integer filterId)
public boolean filterHasDependantChildren(java.lang.Integer filterId)
public boolean populateDetails()
public boolean broadcastReport(java.lang.String Subject,
java.lang.String content,
java.lang.String[] recipients,
java.lang.String attachmentType)
throws WebserviceException
WebserviceExceptionpublic boolean subscribeToReport(ScheduleRecord schedule)
public boolean unsubscribe()
public boolean distributeReport(java.lang.String[] recipients)
throws WebserviceException
WebserviceExceptionpublic boolean distributeReport(java.lang.String[] recipients,
java.lang.String message)
throws WebserviceException
WebserviceExceptionpublic boolean broadcastReport(java.lang.String Subject,
java.lang.String content,
java.lang.String[] recipients,
java.lang.String attachmentType,
java.lang.String distributeMethod)
throws WebserviceException
WebserviceExceptionpublic byte[] renderBinary()
public java.lang.String render()
public java.lang.String getReportName()
public void setReportName(java.lang.String reportName)
reportName - public java.lang.String getContentType()
public java.lang.String getExecutionObject()
public java.lang.String getFormatCode()
public java.lang.Integer getLastRunDuration()
public java.lang.String getLastRunStatus()
public java.math.BigDecimal getLastRunTime()
public int getPort()
public java.lang.Integer getReportId()
public java.lang.String getRequestStatus()
public java.lang.String getUsername()
public java.lang.String getWebServicesURL()
public java.lang.String[] getMessages()
public java.util.HashMap getCharts()
public java.util.HashMap getBlobs()
public void setCharts(java.util.HashMap charts)
public boolean setFilter(java.lang.String ColumnName,
java.lang.String DataValue)
setFilterById(Integer, String)ColumnName - DataValue - public boolean setFilterById(java.lang.Integer filterId,
java.lang.String value)
filterId - value - public boolean setFilterOmittedById(java.lang.Integer filterId)
filterId - entityValue - public java.lang.String getFilterValue(java.lang.String ColumnName,
java.lang.String DataValue)
getFilterValueById(Integer)ColumnName - DataValue - public java.lang.String getFilterValueById(java.lang.Integer filterId)
filterId - public ReportSchema getFilterColumn(java.lang.Integer filterId)
filterId - public java.lang.String[] getFilterColumns()
getFilterIds() or getFilterSchema()public java.lang.Integer[] getFilterIds()
public ReportSchema[] getFilterSchema()
public java.lang.String getColumnType(java.lang.String ColumnName)
public java.lang.String getFilterType(java.lang.String ColumnName)
getFilterTypeById(Integer)public java.lang.String getFilterTypeById(java.lang.Integer filterId)
public java.lang.String getColumnDisplayName(java.lang.String colName)
colName - the column namepublic java.lang.String toString()
toString in class java.lang.Objectpublic boolean isShowAlertImages()
public void setShowAlertImages(boolean showAlertImages)
showAlertImages - boolean on/offpublic boolean isShowAlerts()
public void setShowAlerts(boolean showAlerts)
showAlerts - boolean on/offpublic boolean isShowCharts()
public void setShowCharts(boolean showCharts)
showCharts - boolean on/offpublic boolean isShowLinks()
public void setShowLinks(boolean showLinks)
showLinks - boolean on/offpublic boolean isShowTitle()
public void setShowTitle(boolean showTitle)
showTitle - boolean on/offpublic boolean isShowSort()
public void setShowSort(boolean showSort)
showSort - boolean on/offpublic int getVisibleColumns()
public void setVisibleColumns(int visibleColumns)
visibleColumns - public java.lang.String getLinkURL()
public void setLinkURL(java.lang.String linkURL)
linkURL - public java.lang.String getImageURL()
public void setImageURL(java.lang.String imageURL)
imageURL - public java.lang.String getBinaryURL()
public void setBinaryURL(java.lang.String binaryURL)
binaryURL - public java.lang.String getAuthoringMode()
public boolean isDashboardEnabled()
public java.lang.String getDataOutput()
public java.lang.String getReportTemplate()
public java.lang.String getPreReportRunFilter()
public void setPreReportRunFilter(java.lang.String preReportRunFilter)
public java.lang.String getImageType()
public void setImageType(java.lang.String imageType)
imageType - public ReportSchema[] getColumns()
public java.lang.String getReportStyle()
public boolean isSinglePage()
public void setSinglePage(boolean singlePage)
public java.lang.String getReportDescription()
public java.lang.String getSubCategory()
public java.lang.String getCategory()
public java.lang.String getAuthor()
public java.lang.Integer getAverageRunTime()
public ReportComment[] getComments()
public void setComments(ReportComment[] comments)
public void setTags(java.lang.String tags)
public java.lang.String getTags()
public void setDatasource(java.lang.String datasource)
public java.lang.String getDatasource()
public void setViewName(java.lang.String viewName)
public java.lang.String getViewName()
public void setLastModifiedDate(java.lang.String lastModifiedDate)
public java.lang.String getLastModifiedDate()
public void setBreadcrumbs(BreadCrumb[] breadcrumbs)
public BreadCrumb[] getBreadcrumbs()
public void setShowDrillDownStack(boolean showDrillDownStack)
public boolean isShowDrillDownStack()
public void setShowDrillThroughStack(boolean showDrillThroughStack)
public boolean isShowDrillThroughStack()
public void setSeriesSelection(SeriesSelection[] seriesSelection)
public SeriesSelection[] getSeriesSelection()
public void setShowSeriesSelection(boolean showSeriesSelection)
public boolean isShowSeriesSelection()
public TimeAggregationSelection[] getTimeAggregationSelection()
public void setTimeAggregationSelection(TimeAggregationSelection[] timeAggregationSelection)
public ReportTabSelection[] getReportTabSelection()
public void setReportTabSelection(ReportTabSelection[] reportTabSelection)
public boolean isShowTabs()
public void setShowTabs(boolean showTabs)
public boolean isShowPageSelection()
public void setShowPageSelection(boolean showPageSelection)
public ReportPageSelection[] getReportPageSelection()
public void setReportPageSelection(ReportPageSelection[] reportPageSelection)
public void setSubscriptionSchedule(ScheduleRecord subscriptionSchedule)
public ScheduleRecord getSubscriptionSchedule()
public boolean isShowTimeSlider()
public void setShowTimeSlider(boolean showTimeSlider)
public boolean isShowTimeUnitSelection()
public void setShowTimeUnitSelection(boolean showTimeUnitSelection)
public TimeSliderSelection[] getTimeSliderSelection()
public void setTimeSliderSelection(TimeSliderSelection[] timeSliderSelection)
public java.lang.Integer getSelectedSortColumn()
public void setSelectedSortColumn(java.lang.Integer selectedSortColumn)
public java.lang.Integer getSelectedSortType()
public void setSelectedSortType(java.lang.Integer selectedSortType)
public RelatedReports getRelatedReports()
public void setRelatedReports(RelatedReports relatedReports)
public boolean isShowCoDisplay()
public void setShowCoDisplay(boolean showCoDisplay)
public java.lang.Integer getChartWidth()
public void setChartWidth(java.lang.Integer chartWidth)
public java.lang.Boolean getFitTableWidth()
public void setFitTableWidth(java.lang.Boolean fitTableWidth)
public java.lang.String getChartPlacementCode()
public void setChartPlacementCode(java.lang.String chartPlacementCode)
public java.lang.Integer getAbsoluteTableWidth()
public void setAbsoluteTableWidth(java.lang.Integer absoluteTableWidth)
public boolean isActiveCharts()
public void setActiveCharts(boolean activeCharts)
public SortableTableColumn[] getSortableColumns()
public void setSortableColumns(SortableTableColumn[] sortableColumns)
public boolean isGisNavigation()
public void setGisNavigation(boolean gisNavigation)
public java.lang.String getDrillCode()
public void setDrillCode(java.lang.String drillCode)
public java.lang.Boolean getCanDrill()
public void setCanDrill(java.lang.Boolean canDrill)
public java.lang.Integer getReportUsage()
public void setReportUsage(java.lang.Integer reportUsage)
public java.lang.String getMultiReportTag()
public void setMultiReportTag(java.lang.String multiReportTag)
public GISMap[] getGisMap()
public void setGisMap(GISMap[] gisMap)
public java.lang.Integer getChartHeight()
public void setChartHeight(java.lang.Integer chartHeight)
public java.lang.Integer getChartScale()
public void setChartScale(java.lang.Integer chartScale)
public GMap[] getGoogleMaps()
public void setGoogleMaps(GMap[] googleMaps)
public java.lang.String getLinkFormatterClass()
public void setLinkFormatterClass(java.lang.String linkFormatterClass)
drillAnywherLinkGeneratorClass - - Full class name, including namespace.public java.lang.String getLanguageCode()
public void setLanguageCode(java.lang.String languageCode)
languageCode - the languageCode to setpublic java.lang.Boolean isPrivate()
public void setIsPrivate(java.lang.Boolean isPrivate)
languageCode - the languageCode to setpublic java.lang.String getDataFormatterType()
public void setDataFormatterType(java.lang.String dataFormatterType)
dataFormatterType - String object, or null to use defaultpublic boolean canUserSubscribe()
public void setCanUserSubscribe(boolean canUserSubscribe)
public boolean isMultiCharts()
public void setMultiCharts(boolean multiCharts)
public boolean isShowAlertLegendTable()
public void setShowAlertLegendTable(boolean showAlertLegendTable)
public java.lang.String[] getReportOptions()
public void setReportOptions(java.lang.String[] reportOptions)
public boolean isAllowInteractiveGoogleMaps()
public void setAllowInteractiveGoogleMaps(boolean allowInteractiveGoogleMaps)
public boolean isTriggerJSGoogleMapsSetup()
public void setTriggerJSGoogleMapsSetup(boolean triggerJSGoogleMapsSetup)