com.esri.arcgis.arcweb
Interface IArcWebReport

All Superinterfaces:

Serializable

All Known Implementing Classes:

ArcWebReport

public interface IArcWebReport
extends Serializable

Provides access to members that create a demographic report or a print-quality thematic map for a specified area.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Method Summary

String	createPDFDocument(ITrackCancel cancelTracker, String templateName, IEnumArcWebKeyValue data) Creates a user-defined data in PFD format.
IEnumBSTR	getAvailableTemplateNames(ITrackCancel cancelTracker) Gets template names to use with the CreatePDFDocument method.
IArcWebReportInfo	getCustomSiteReport(ITrackCancel cancelTracker, IArcWebSite site, IArcWebReportOptions reportOptions, IEnumArcWebCustomReportVariables customReportVariables) Gets a report with user-requested variables for a specified site.
IArcWebReportInfo	getCustomStandardGeographyReport(ITrackCancel cancelTracker, IEnumArcWebStandardGeography standardGeography, IArcWebReportOptions reportOptions, IEnumArcWebCustomReportVariables customReportVariables) Gets a report containing user-requested variables for a specified standard geography.
IEnumArcWebCustomVariableInfo	getCustomVariables(ITrackCancel cancelTracker, String variableDataSource) Gets a list of variables that can be used to create a custom report.
IEnumBSTR	getDatabases(ITrackCancel cancelTracker) Gets a list of databases that can be used to create a thematic map report.
IArcWebTable	getGeographyIDs(ITrackCancel cancelTracker, IArcWebGeographyIDOptions geographyIDOptions) Gets the geography ID information.
IEnumArcWebKeyValue	getReportHeaderKeys(ITrackCancel cancelTracker, String methodName) Gets the key/value pairs for the header of the report based on the method name.
IEnumArcWebReportInfo	getSiteReports(ITrackCancel cancelTracker, IArcWebSite site, IEnumArcWebReportOptions reportOptions, boolean combineReports) Gets pre-formatted reports for a specified site.
IArcWebReportInfo	getStandardGeographyReport(ITrackCancel cancelTracker, IEnumArcWebStandardGeography standardGeography, IArcWebReportOptions reportOptions) Gets a pre-formatted report for specified standard geographies.
IEnumBSTR	getTables(ITrackCancel cancelTracker, String database) Gets a list of tables for a specific database that can be used to create a thematic map report.
IArcWebReportInfo	getThematicMapReport(ITrackCancel cancelTracker, IEnumArcWebSite site, IArcWebReportOptions reportOptions, IArcWebThematicReportOptions thematicReportOptions, String thematicVariable) Gets a thematic map in PDF format for a specified set of sites.
IEnumArcWebThematicVariableInfo	getThematicVariables(ITrackCancel cancelTracker, String database, String table) Gets a list of variables for a specified database and table.
IEnumArcWebThematicVariableInfo	searchThematicVariables(ITrackCancel cancelTracker, String keyword) Gets the thematic variables based on a keyword search.

Method Detail

getAvailableTemplateNames

IEnumBSTR getAvailableTemplateNames(ITrackCancel cancelTracker)
                                    throws IOException,
                                           AutomationException

Gets template names to use with the CreatePDFDocument method.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

cancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Returns:

A reference to a com.esri.arcgis.system.IEnumBSTR

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDatabases

IEnumBSTR getDatabases(ITrackCancel cancelTracker)
                       throws IOException,
                              AutomationException

Gets a list of databases that can be used to create a thematic map report.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

cancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in)

Returns:

A reference to a com.esri.arcgis.system.IEnumBSTR

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTables

IEnumBSTR getTables(ITrackCancel cancelTracker,
                    String database)
                    throws IOException,
                           AutomationException

Gets a list of tables for a specific database that can be used to create a thematic map report.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

cancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in)

database - The database (in)

Returns:

A reference to a com.esri.arcgis.system.IEnumBSTR

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getThematicVariables

IEnumArcWebThematicVariableInfo getThematicVariables(ITrackCancel cancelTracker,
                                                     String database,
                                                     String table)
                                                     throws IOException,
                                                            AutomationException

Gets a list of variables for a specified database and table.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

cancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in)

database - The database (in)

table - The table (in)

Returns:

A reference to a com.esri.arcgis.arcweb.IEnumArcWebThematicVariableInfo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

searchThematicVariables

IEnumArcWebThematicVariableInfo searchThematicVariables(ITrackCancel cancelTracker,
                                                        String keyword)
                                                        throws IOException,
                                                               AutomationException

Gets the thematic variables based on a keyword search.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

cancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in)

keyword - The keyword (in)

Returns:

A reference to a com.esri.arcgis.arcweb.IEnumArcWebThematicVariableInfo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCustomVariables

IEnumArcWebCustomVariableInfo getCustomVariables(ITrackCancel cancelTracker,
                                                 String variableDataSource)
                                                 throws IOException,
                                                        AutomationException

Gets a list of variables that can be used to create a custom report.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

cancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in)

variableDataSource - The variableDataSource (in)

Returns:

A reference to a com.esri.arcgis.arcweb.IEnumArcWebCustomVariableInfo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReportHeaderKeys

IEnumArcWebKeyValue getReportHeaderKeys(ITrackCancel cancelTracker,
                                        String methodName)
                                        throws IOException,
                                               AutomationException

Gets the key/value pairs for the header of the report based on the method name.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

cancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in)

methodName - The methodName (in)

Returns:

A reference to a com.esri.arcgis.arcweb.IEnumArcWebKeyValue

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSiteReports

IEnumArcWebReportInfo getSiteReports(ITrackCancel cancelTracker,
                                     IArcWebSite site,
                                     IEnumArcWebReportOptions reportOptions,
                                     boolean combineReports)
                                     throws IOException,
                                            AutomationException

Gets pre-formatted reports for a specified site.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

cancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in)

site - A reference to a com.esri.arcgis.arcweb.IArcWebSite (in)

reportOptions - A reference to a com.esri.arcgis.arcweb.IEnumArcWebReportOptions (in)

combineReports - The combineReports (in)

Returns:

A reference to a com.esri.arcgis.arcweb.IEnumArcWebReportInfo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGeographyIDs

IArcWebTable getGeographyIDs(ITrackCancel cancelTracker,
                             IArcWebGeographyIDOptions geographyIDOptions)
                             throws IOException,
                                    AutomationException

Gets the geography ID information.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

cancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in)

geographyIDOptions - A reference to a com.esri.arcgis.arcweb.IArcWebGeographyIDOptions (in)

Returns:

A reference to a com.esri.arcgis.arcweb.IArcWebTable

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getThematicMapReport

IArcWebReportInfo getThematicMapReport(ITrackCancel cancelTracker,
                                       IEnumArcWebSite site,
                                       IArcWebReportOptions reportOptions,
                                       IArcWebThematicReportOptions thematicReportOptions,
                                       String thematicVariable)
                                       throws IOException,
                                              AutomationException

Gets a thematic map in PDF format for a specified set of sites.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

cancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in)

site - A reference to a com.esri.arcgis.arcweb.IEnumArcWebSite (in)

reportOptions - A reference to a com.esri.arcgis.arcweb.IArcWebReportOptions (in)

thematicReportOptions - A reference to a com.esri.arcgis.arcweb.IArcWebThematicReportOptions (in)

thematicVariable - The thematicVariable (in)

Returns:

A reference to a com.esri.arcgis.arcweb.IArcWebReportInfo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCustomSiteReport

IArcWebReportInfo getCustomSiteReport(ITrackCancel cancelTracker,
                                      IArcWebSite site,
                                      IArcWebReportOptions reportOptions,
                                      IEnumArcWebCustomReportVariables customReportVariables)
                                      throws IOException,
                                             AutomationException

Gets a report with user-requested variables for a specified site.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

cancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in)

site - A reference to a com.esri.arcgis.arcweb.IArcWebSite (in)

reportOptions - A reference to a com.esri.arcgis.arcweb.IArcWebReportOptions (in)

customReportVariables - A reference to a com.esri.arcgis.arcweb.IEnumArcWebCustomReportVariables (in)

Returns:

A reference to a com.esri.arcgis.arcweb.IArcWebReportInfo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStandardGeographyReport

IArcWebReportInfo getStandardGeographyReport(ITrackCancel cancelTracker,
                                             IEnumArcWebStandardGeography standardGeography,
                                             IArcWebReportOptions reportOptions)
                                             throws IOException,
                                                    AutomationException

Gets a pre-formatted report for specified standard geographies.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

cancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in)

standardGeography - A reference to a com.esri.arcgis.arcweb.IEnumArcWebStandardGeography (in)

reportOptions - A reference to a com.esri.arcgis.arcweb.IArcWebReportOptions (in)

Returns:

A reference to a com.esri.arcgis.arcweb.IArcWebReportInfo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getCustomStandardGeographyReport

IArcWebReportInfo getCustomStandardGeographyReport(ITrackCancel cancelTracker,
                                                   IEnumArcWebStandardGeography standardGeography,
                                                   IArcWebReportOptions reportOptions,
                                                   IEnumArcWebCustomReportVariables customReportVariables)
                                                   throws IOException,
                                                          AutomationException

Gets a report containing user-requested variables for a specified standard geography.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

cancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in)

standardGeography - A reference to a com.esri.arcgis.arcweb.IEnumArcWebStandardGeography (in)

reportOptions - A reference to a com.esri.arcgis.arcweb.IArcWebReportOptions (in)

customReportVariables - A reference to a com.esri.arcgis.arcweb.IEnumArcWebCustomReportVariables (in)

Returns:

A reference to a com.esri.arcgis.arcweb.IArcWebReportInfo

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

createPDFDocument

String createPDFDocument(ITrackCancel cancelTracker,
                         String templateName,
                         IEnumArcWebKeyValue data)
                         throws IOException,
                                AutomationException

Creates a user-defined data in PFD format.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

cancelTracker - A reference to a com.esri.arcgis.system.ITrackCancel (in)

templateName - The templateName (in)

data - A reference to a com.esri.arcgis.arcweb.IEnumArcWebKeyValue (in)

Returns:

The pdf

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.