com.esri.arcgis.arcweb
Class ArcWebReport

java.lang.Object
  com.esri.arcgis.arcweb.ArcWebReport

All Implemented Interfaces:

IArcWebReport, com.esri.arcgis.interop.RemoteObjRef, ISupportErrorInfo, Serializable

public class ArcWebReport
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IArcWebReport, ISupportErrorInfo

An ArcWeb service used to 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.

See Also:

Serialized Form

Constructor Summary

ArcWebReport()
Constructs a ArcWebReport using ArcGIS Engine.

ArcWebReport(Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ArcWebReport theArcWebReport = (ArcWebReport) obj;

Method Summary

String	createPDFDocument(ITrackCancel cancelTracker, String templateName, IEnumArcWebKeyValue data) Creates a user-defined data in PFD format.
boolean	equals(Object o) Compare this object with another
IEnumBSTR	getAvailableTemplateNames(ITrackCancel cancelTracker) Gets template names to use with the CreatePDFDocument method.
static String	getClsid() getClsid.
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.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
IEnumArcWebThematicVariableInfo	searchThematicVariables(ITrackCancel cancelTracker, String keyword) Gets the thematic variables based on a keyword search.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.esri.arcgis.interop.RemoteObjRef

getJintegraDispatch, release

Constructor Detail

ArcWebReport

public ArcWebReport()
             throws IOException,
                    UnknownHostException

Constructs a ArcWebReport using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

ArcWebReport

public ArcWebReport(Object obj)
             throws IOException

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
ArcWebReport theArcWebReport = (ArcWebReport) obj;

Construct a ArcWebReport using a reference to such an object returned from ArcGIS Engine or Server. This is semantically equivalent to casting obj to ArcWebReport.

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

IOException - if there are interop problems

Method Detail

getClsid

public static String getClsid()

getClsid.

equals

public boolean equals(Object o)

Compare this object with another

Overrides:

equals in class Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class Object

getAvailableTemplateNames

public 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.

Specified by:

getAvailableTemplateNames in interface IArcWebReport

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

public 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.

Specified by:

getDatabases in interface IArcWebReport

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

public 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.

Specified by:

getTables in interface IArcWebReport

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

public 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.

Specified by:

getThematicVariables in interface IArcWebReport

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

public 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.

Specified by:

searchThematicVariables in interface IArcWebReport

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

public 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.

Specified by:

getCustomVariables in interface IArcWebReport

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

public 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.

Specified by:

getReportHeaderKeys in interface IArcWebReport

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

public 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.

Specified by:

getSiteReports in interface IArcWebReport

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

public 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.

Specified by:

getGeographyIDs in interface IArcWebReport

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

public 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.

Specified by:

getThematicMapReport in interface IArcWebReport

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

public 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.

Specified by:

getCustomSiteReport in interface IArcWebReport

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

public 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.

Specified by:

getStandardGeographyReport in interface IArcWebReport

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

public 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.

Specified by:

getCustomStandardGeographyReport in interface IArcWebReport

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

public 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.

Specified by:

createPDFDocument in interface IArcWebReport

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.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Description

Indicates whether the interface supports IErrorInfo.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.