|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.arcmap.Report
public class Report
COM Class 'Report'. Generated 3/19/2015 1:20:50 PM from 'C:\ArcGIS\COM\esriArcMap.olb'
Description 'The Report class implements the report engine.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =
Field Summary |
---|
Fields inherited from interface com.esri.arcgis.arcmap.IReportDataSource |
---|
IID, IID174803ec_867f_4a6e_9035_2b558ed0589e, xxDummy |
Fields inherited from interface com.esri.arcgis.arcmap.IReportEngine |
---|
IID, IIDf94b2bd2_edfe_4e39_90d0_e19ea3345645, xxDummy |
Fields inherited from interface com.esri.arcgis.arcmap.IReportTemplate |
---|
IID, IID4ba9f129_fea1_4caf_b29f_349df95deee8, xxDummy |
Constructor Summary | |
---|---|
Report()
Constructs a Report using ArcGIS Engine. |
|
Report(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts. Report theReport = (Report) obj; |
Method Summary | |
---|---|
boolean |
equals(java.lang.Object o)
Compare this object with another |
boolean |
exportReport(java.lang.String filePath,
java.lang.String pages,
int type)
Exports an executed report in the desired format. |
boolean |
fieldMapping(java.lang.String templateFieldList,
java.lang.String sourceFieldList)
Sets the field mapping from the report template to the new fields. |
static java.lang.String |
getClsid()
getClsid. |
java.lang.String |
getDefinitionQuery()
Indicates the definition expression for the report. |
IGeometry |
getExtent()
Indicates the extent of the report features. |
com.esri.arcgis.interop.Dispatch |
getJintegraDispatch()
Deprecated. Internal use only. |
ILayer |
getLayer()
Indicates the data for the report is from a layer. |
java.lang.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(java.lang.String templateFilePath)
Loads the report template file. |
boolean |
relatedReportMapping(java.lang.String relatedReportName,
IRelationshipClass pSourceRelationshipClass,
java.lang.String templateFieldList,
java.lang.String sourceFieldList)
Sets the mapping information for a related report. |
void |
release()
Release a Report. |
boolean |
runReport(ITrackCancel pTrackCancel)
Executes the report base on the IReportDataSource properties. |
boolean |
saveReportTemplate(java.lang.String templateFilePath)
Saves the report as a template file. |
void |
setDefinitionQuery(java.lang.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(java.lang.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 |
Constructor Detail |
---|
public Report() throws java.io.IOException, java.net.UnknownHostException
java.io.IOException
- if there are interop problems
java.net.UnknownHostException
- if there are interop problemspublic Report(java.lang.Object obj) throws java.io.IOException
Report theReport = (Report) obj;
obj
to Report
.
obj
- an object returned from ArcGIS Engine or Server
java.io.IOException
- if there are interop problemsMethod Detail |
---|
public static java.lang.String getClsid()
public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public com.esri.arcgis.interop.Dispatch getJintegraDispatch()
getJintegraDispatch
in interface com.esri.arcgis.interop.RemoteObjRef
public void release()
release
in interface com.esri.arcgis.interop.RemoteObjRef
public ILayer getLayer() throws java.io.IOException, AutomationException
getLayer
in interface IReportDataSource
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setLayerByRef(ILayer ppLayer) throws java.io.IOException, AutomationException
setLayerByRef
in interface IReportDataSource
ppLayer
- A reference to a com.esri.arcgis.carto.ILayer (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ITable getTable() throws java.io.IOException, AutomationException
getTable
in interface IReportDataSource
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setTableByRef(ITable ppTable) throws java.io.IOException, AutomationException
setTableByRef
in interface IReportDataSource
ppTable
- A reference to a com.esri.arcgis.geodatabase.ITable (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.String getDefinitionQuery() throws java.io.IOException, AutomationException
getDefinitionQuery
in interface IReportDataSource
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setDefinitionQuery(java.lang.String pDefinitionQuery) throws java.io.IOException, AutomationException
setDefinitionQuery
in interface IReportDataSource
pDefinitionQuery
- The pDefinitionQuery (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public ISelectionSet getSelectionSet() throws java.io.IOException, AutomationException
getSelectionSet
in interface IReportDataSource
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setSelectionSetByRef(ISelectionSet ppSelectionSet) throws java.io.IOException, AutomationException
setSelectionSetByRef
in interface IReportDataSource
ppSelectionSet
- A reference to a com.esri.arcgis.geodatabase.ISelectionSet (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public IGeometry getExtent() throws java.io.IOException, AutomationException
getExtent
in interface IReportDataSource
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setExtentByRef(IGeometry ppExtent) throws java.io.IOException, AutomationException
setExtentByRef
in interface IReportDataSource
ppExtent
- A reference to a com.esri.arcgis.geometry.IGeometry (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean runReport(ITrackCancel pTrackCancel) throws java.io.IOException, AutomationException
runReport
in interface IReportEngine
pTrackCancel
- A reference to a com.esri.arcgis.system.ITrackCancel (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean exportReport(java.lang.String filePath, java.lang.String pages, int type) throws java.io.IOException, AutomationException
exportReport
in interface IReportEngine
filePath
- The filePath (in)pages
- The pages (in)type
- A com.esri.arcgis.arcmap.esriReportExportType constant (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public int getStartingPageNumber() throws java.io.IOException, AutomationException
getStartingPageNumber
in interface IReportTemplate
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setStartingPageNumber(int pStartingPageNumber) throws java.io.IOException, AutomationException
setStartingPageNumber
in interface IReportTemplate
pStartingPageNumber
- The pStartingPageNumber (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public java.lang.String getReportTitle() throws java.io.IOException, AutomationException
getReportTitle
in interface IReportTemplate
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public void setReportTitle(java.lang.String pReportTitle) throws java.io.IOException, AutomationException
setReportTitle
in interface IReportTemplate
pReportTitle
- The pReportTitle (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean fieldMapping(java.lang.String templateFieldList, java.lang.String sourceFieldList) throws java.io.IOException, AutomationException
fieldMapping
in interface IReportTemplate
templateFieldList
- The templateFieldList (in)sourceFieldList
- The sourceFieldList (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean relatedReportMapping(java.lang.String relatedReportName, IRelationshipClass pSourceRelationshipClass, java.lang.String templateFieldList, java.lang.String sourceFieldList) throws java.io.IOException, AutomationException
relatedReportMapping
in interface IReportTemplate
relatedReportName
- The relatedReportName (in)pSourceRelationshipClass
- A reference to a com.esri.arcgis.geodatabase.IRelationshipClass (in)templateFieldList
- The templateFieldList (in)sourceFieldList
- The sourceFieldList (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean loadReportTemplate(java.lang.String templateFilePath) throws java.io.IOException, AutomationException
loadReportTemplate
in interface IReportTemplate
templateFilePath
- The templateFilePath (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.public boolean saveReportTemplate(java.lang.String templateFilePath) throws java.io.IOException, AutomationException
saveReportTemplate
in interface IReportTemplate
templateFilePath
- The templateFilePath (in)
java.io.IOException
- If there are interop problems.
AutomationException
- If the ArcObject component throws an exception.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |