com.esri.arcgis.arcmap
Class Report

java.lang.Object
  com.esri.arcgis.arcmap.Report

All Implemented Interfaces:

IReportDataSource, IReportEngine, IReportTemplate, com.esri.arcgis.interop.RemoteObjRef, Serializable

public class Report
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IReportDataSource, IReportEngine, IReportTemplate

The Report class implements the report engine.

Product Availability

Available with ArcGIS Desktop.

See Also:

Serialized Form

Constructor Summary

Report()
Constructs a Report using ArcGIS Engine.

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

Method Summary

boolean	equals(Object o) Compare this object with another
boolean	exportReport(String filePath, String pages, int type) Exports an executed report in the desired format.
boolean	fieldMapping(String templateFieldList, String sourceFieldList) Sets the field mapping from the report template to the new fields.
static String	getClsid() getClsid.
String	getDefinitionQuery() Indicates the definition expression for the report.
IGeometry	getExtent() Indicates the extent of the report features.
ILayer	getLayer() Indicates the data for the report is from a layer.
String	getReportTitle() Indicates the title for the report.
ISelectionSet	getSelectionSet() Indicates the selection set for the report.
int	getStartingPageNumber() Indicates the starting page number for the report.
ITable	getTable() Indicates the data for the report is from a table.
int	hashCode() the hashcode for this object
boolean	loadReportTemplate(String templateFilePath) Loads the report template file.
boolean	relatedReportMapping(String relatedReportName, IRelationshipClass pSourceRelationshipClass, String templateFieldList, String sourceFieldList) Sets the mapping information for a related report.
boolean	runReport(ITrackCancel pTrackCancel) Executes the report base on the IReportDataSource properties.
boolean	saveReportTemplate(String templateFilePath) Saves the report as a template file.
void	setDefinitionQuery(String pDefinitionQuery) Indicates the definition expression for the report.
void	setExtentByRef(IGeometry ppExtent) Indicates the extent of the report features.
void	setLayerByRef(ILayer ppLayer) Indicates the data for the report is from a layer.
void	setReportTitle(String pReportTitle) Indicates the title for the report.
void	setSelectionSetByRef(ISelectionSet ppSelectionSet) Indicates the selection set for the report.
void	setStartingPageNumber(int pStartingPageNumber) Indicates the starting page number for the report.
void	setTableByRef(ITable ppTable) Indicates the data for the report is from a table.

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

Report

public Report()
       throws IOException,
              UnknownHostException

Constructs a Report using ArcGIS Engine.

Throws:

IOException - if there are interop problems

UnknownHostException - if there are interop problems

Report

public Report(Object obj)
       throws IOException

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

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

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

getLayer

public ILayer getLayer()
                throws IOException,
                       AutomationException

Indicates the data for the report is from a layer.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getLayer in interface IReportDataSource

Returns:

A reference to a com.esri.arcgis.carto.ILayer

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setLayerByRef

public void setLayerByRef(ILayer ppLayer)
                   throws IOException,
                          AutomationException

Indicates the data for the report is from a layer.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setLayerByRef in interface IReportDataSource

Parameters:

ppLayer - A reference to a com.esri.arcgis.carto.ILayer (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTable

public ITable getTable()
                throws IOException,
                       AutomationException

Indicates the data for the report is from a table.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getTable in interface IReportDataSource

Returns:

A reference to a com.esri.arcgis.geodatabase.ITable

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTableByRef

public void setTableByRef(ITable ppTable)
                   throws IOException,
                          AutomationException

Indicates the data for the report is from a table.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setTableByRef in interface IReportDataSource

Parameters:

ppTable - A reference to a com.esri.arcgis.geodatabase.ITable (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDefinitionQuery

public String getDefinitionQuery()
                          throws IOException,
                                 AutomationException

Indicates the definition expression for the report.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getDefinitionQuery in interface IReportDataSource

Returns:

The pDefinitionQuery

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setDefinitionQuery

public void setDefinitionQuery(String pDefinitionQuery)
                        throws IOException,
                               AutomationException

Indicates the definition expression for the report.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setDefinitionQuery in interface IReportDataSource

Parameters:

pDefinitionQuery - The pDefinitionQuery (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSelectionSet

public ISelectionSet getSelectionSet()
                              throws IOException,
                                     AutomationException

Indicates the selection set for the report.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getSelectionSet in interface IReportDataSource

Returns:

A reference to a com.esri.arcgis.geodatabase.ISelectionSet

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSelectionSetByRef

public void setSelectionSetByRef(ISelectionSet ppSelectionSet)
                          throws IOException,
                                 AutomationException

Indicates the selection set for the report.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setSelectionSetByRef in interface IReportDataSource

Parameters:

ppSelectionSet - A reference to a com.esri.arcgis.geodatabase.ISelectionSet (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getExtent

public IGeometry getExtent()
                    throws IOException,
                           AutomationException

Indicates the extent of the report features.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getExtent in interface IReportDataSource

Returns:

A reference to a com.esri.arcgis.geometry.IGeometry

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setExtentByRef

public void setExtentByRef(IGeometry ppExtent)
                    throws IOException,
                           AutomationException

Indicates the extent of the report features.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setExtentByRef in interface IReportDataSource

Parameters:

ppExtent - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

runReport

public boolean runReport(ITrackCancel pTrackCancel)
                  throws IOException,
                         AutomationException

Executes the report base on the IReportDataSource properties.

Product Availability

Available with ArcGIS Desktop.

Specified by:

runReport in interface IReportEngine

Parameters:

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

Returns:

The pResult

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

exportReport

public boolean exportReport(String filePath,
                            String pages,
                            int type)
                     throws IOException,
                            AutomationException

Exports an executed report in the desired format.

Product Availability

Available with ArcGIS Desktop.

Specified by:

exportReport in interface IReportEngine

Parameters:

filePath - The filePath (in)

pages - The pages (in)

type - A com.esri.arcgis.arcmap.esriReportExportType constant (in)

Returns:

The pResult

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStartingPageNumber

public int getStartingPageNumber()
                          throws IOException,
                                 AutomationException

Indicates the starting page number for the report.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getStartingPageNumber in interface IReportTemplate

Returns:

The pStartingPageNumber

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStartingPageNumber

public void setStartingPageNumber(int pStartingPageNumber)
                           throws IOException,
                                  AutomationException

Indicates the starting page number for the report.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setStartingPageNumber in interface IReportTemplate

Parameters:

pStartingPageNumber - The pStartingPageNumber (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReportTitle

public String getReportTitle()
                      throws IOException,
                             AutomationException

Indicates the title for the report.

Product Availability

Available with ArcGIS Desktop.

Specified by:

getReportTitle in interface IReportTemplate

Returns:

The pReportTitle

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReportTitle

public void setReportTitle(String pReportTitle)
                    throws IOException,
                           AutomationException

Indicates the title for the report.

Product Availability

Available with ArcGIS Desktop.

Specified by:

setReportTitle in interface IReportTemplate

Parameters:

pReportTitle - The pReportTitle (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

fieldMapping

public boolean fieldMapping(String templateFieldList,
                            String sourceFieldList)
                     throws IOException,
                            AutomationException

Sets the field mapping from the report template to the new fields.

Product Availability

Available with ArcGIS Desktop.

Specified by:

fieldMapping in interface IReportTemplate

Parameters:

templateFieldList - The templateFieldList (in)

sourceFieldList - The sourceFieldList (in)

Returns:

The pResult

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

relatedReportMapping

public boolean relatedReportMapping(String relatedReportName,
                                    IRelationshipClass pSourceRelationshipClass,
                                    String templateFieldList,
                                    String sourceFieldList)
                             throws IOException,
                                    AutomationException

Sets the mapping information for a related report.

Product Availability

Available with ArcGIS Desktop.

Specified by:

relatedReportMapping in interface IReportTemplate

Parameters:

relatedReportName - The relatedReportName (in)

pSourceRelationshipClass - A reference to a com.esri.arcgis.geodatabase.IRelationshipClass (in)

templateFieldList - The templateFieldList (in)

sourceFieldList - The sourceFieldList (in)

Returns:

The pResult

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

loadReportTemplate

public boolean loadReportTemplate(String templateFilePath)
                           throws IOException,
                                  AutomationException

Loads the report template file.

Product Availability

Available with ArcGIS Desktop.

Specified by:

loadReportTemplate in interface IReportTemplate

Parameters:

templateFilePath - The templateFilePath (in)

Returns:

The pResult

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

saveReportTemplate

public boolean saveReportTemplate(String templateFilePath)
                           throws IOException,
                                  AutomationException

Saves the report as a template file.

Product Availability

Available with ArcGIS Desktop.

Specified by:

saveReportTemplate in interface IReportTemplate

Parameters:

templateFilePath - The templateFilePath (in)

Returns:

The pResult

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.