com.esri.arcgis.geodatabaseextensions
Class TerrainDataSource

java.lang.Object
  com.esri.arcgis.geodatabaseextensions.TerrainDataSource

All Implemented Interfaces:

ITerrainDataSource, ITerrainEmbeddedDataSource, ITerrainEmbeddedDataSource2, com.esri.arcgis.interop.RemoteObjRef, java.io.Serializable

public class TerrainDataSource
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ITerrainDataSource, ITerrainEmbeddedDataSource, ITerrainEmbeddedDataSource2

COM Class 'TerrainDataSource'. Generated 3/19/2015 1:20:49 PM from 'C:\ArcGIS\COM\esriGeoDatabaseExtensions.olb'

Description 'Esri Terrain Data Source object.' 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 =

See Also:

Serialized Form

Field Summary

Fields inherited from interface com.esri.arcgis.geodatabaseextensions.ITerrainDataSource

IID, IID4d228018_1ec1_4fcc_9646_9c6a67f9ef3c, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabaseextensions.ITerrainEmbeddedDataSource2

IID, IID7a0bb0b6_b097_4fbf_be95_d32473b75ab1, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabaseextensions.ITerrainEmbeddedDataSource

IID36a1b4a5_d296_433d_ac4f_4da50d020812

Constructor Summary

TerrainDataSource()
Constructs a TerrainDataSource using ArcGIS Engine.

TerrainDataSource(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
TerrainDataSource theTerrainDataSource = (TerrainDataSource) obj;

Method Summary

boolean	equals(java.lang.Object o) Compare this object with another
static java.lang.String	getClsid() getClsid.
int	getFeatureClassID() The unique database identifier for the feature class.
ITerrainFieldStatistics	getFieldStatistics(java.lang.String fieldName) Returns the statistics of the specified Terrain blob field.
int	getGroupID() The identifier of the terrain's thematic group to which this feature class belongs.
java.lang.String	getHeightField() The database column providing heights for the features.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
java.lang.String	getName() The name of the embedded data source.
IStringArray	getReservedFields() Returns the names of the database fields associated with the data source that are copied into the terrain.
IArray	getReservedFieldStatistics() Returns the statistics of all the Terrain blob fields.
int	getSurfaceFeatureType() Indicates how the features are used to define the terrain surface.
java.lang.String	getTagValueField() The database column providing tag values for TIN elements derived from the terrain.
int	hashCode() the hashcode for this object
boolean	isApplyToOverviewTerrain() Indicates if the 'breakline' data source should be added to the overview Terrain.
boolean	isEmbedded() Indicates whether or not the data source is contained by the terrain.
boolean	isToBeEmbedded() Indicates the terrain will copy the data and not have a dependency on the data source after the terrain is built.
void	queryResolutionBounds(double[] pLowerBound, double[] pUpperBound) Returns the lower and upper resolution bounds in which the line/area data source participates in the triangulation.
void	release() Release a TerrainDataSource.
void	setApplyToOverviewTerrain(boolean pbApply) Indicates if the 'breakline' data source should be added to the overview Terrain.
void	setFeatureClassID(int pClassID) The unique database identifier for the feature class.
void	setGroupID(int pGroupID) The identifier of the terrain's thematic group to which this feature class belongs.
void	setHeightField(java.lang.String pFieldName) The database column providing heights for the features.
void	setName(java.lang.String pName) The name of the embedded data source.
void	setReservedFields(IStringArray pFields) Set the names of the database fields associated with the data source that will be copied into the terrain.
void	setResolutionBounds(double lowerBound, double upperBound) Sets the lower and upper resolution bounds in which the line/area data source participates in the triangulation.
void	setSurfaceFeatureType(int pType) Indicates how the features are used to define the terrain surface.
void	setTagValueField(java.lang.String pFieldName) The database column providing tag values for TIN elements derived from the terrain.
void	setToBeEmbedded(boolean pbToBeEmbedded) Indicates the terrain will copy the data and not have a dependency on the data source after the terrain is built.

Methods inherited from class java.lang.Object

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

Constructor Detail

TerrainDataSource

public TerrainDataSource()
                  throws java.io.IOException,
                         java.net.UnknownHostException

Constructs a TerrainDataSource using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

TerrainDataSource

public TerrainDataSource(java.lang.Object obj)
                  throws java.io.IOException

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

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a TerrainDataSource.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

setFeatureClassID

public void setFeatureClassID(int pClassID)
                       throws java.io.IOException,
                              AutomationException

The unique database identifier for the feature class.

Specified by:

setFeatureClassID in interface ITerrainDataSource

Parameters:

pClassID - The pClassID (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFeatureClassID

public int getFeatureClassID()
                      throws java.io.IOException,
                             AutomationException

The unique database identifier for the feature class.

Specified by:

getFeatureClassID in interface ITerrainDataSource

Returns:

The pClassID

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGroupID

public void setGroupID(int pGroupID)
                throws java.io.IOException,
                       AutomationException

The identifier of the terrain's thematic group to which this feature class belongs.

Specified by:

setGroupID in interface ITerrainDataSource

Parameters:

pGroupID - The pGroupID (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGroupID

public int getGroupID()
               throws java.io.IOException,
                      AutomationException

The identifier of the terrain's thematic group to which this feature class belongs.

Specified by:

getGroupID in interface ITerrainDataSource

Returns:

The pGroupID

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setHeightField

public void setHeightField(java.lang.String pFieldName)
                    throws java.io.IOException,
                           AutomationException

The database column providing heights for the features.

Specified by:

setHeightField in interface ITerrainDataSource

Parameters:

pFieldName - The pFieldName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getHeightField

public java.lang.String getHeightField()
                                throws java.io.IOException,
                                       AutomationException

The database column providing heights for the features.

Specified by:

getHeightField in interface ITerrainDataSource

Returns:

The pFieldName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTagValueField

public void setTagValueField(java.lang.String pFieldName)
                      throws java.io.IOException,
                             AutomationException

The database column providing tag values for TIN elements derived from the terrain.

Specified by:

setTagValueField in interface ITerrainDataSource

Parameters:

pFieldName - The pFieldName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTagValueField

public java.lang.String getTagValueField()
                                  throws java.io.IOException,
                                         AutomationException

The database column providing tag values for TIN elements derived from the terrain.

Specified by:

getTagValueField in interface ITerrainDataSource

Returns:

The pFieldName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSurfaceFeatureType

public void setSurfaceFeatureType(int pType)
                           throws java.io.IOException,
                                  AutomationException

Indicates how the features are used to define the terrain surface.

Specified by:

setSurfaceFeatureType in interface ITerrainDataSource

Parameters:

pType - A com.esri.arcgis.geodatabase.esriTinSurfaceType constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSurfaceFeatureType

public int getSurfaceFeatureType()
                          throws java.io.IOException,
                                 AutomationException

Indicates how the features are used to define the terrain surface.

Specified by:

getSurfaceFeatureType in interface ITerrainDataSource

Returns:

A com.esri.arcgis.geodatabase.esriTinSurfaceType constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setApplyToOverviewTerrain

public void setApplyToOverviewTerrain(boolean pbApply)
                               throws java.io.IOException,
                                      AutomationException

Indicates if the 'breakline' data source should be added to the overview Terrain.

Specified by:

setApplyToOverviewTerrain in interface ITerrainDataSource

Parameters:

pbApply - The pbApply (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isApplyToOverviewTerrain

public boolean isApplyToOverviewTerrain()
                                 throws java.io.IOException,
                                        AutomationException

Indicates if the 'breakline' data source should be added to the overview Terrain.

Specified by:

isApplyToOverviewTerrain in interface ITerrainDataSource

Returns:

The pbApply

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEmbedded

public boolean isEmbedded()
                   throws java.io.IOException,
                          AutomationException

Indicates whether or not the data source is contained by the terrain.

Specified by:

isEmbedded in interface ITerrainDataSource

Returns:

The pbEmbedded

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setResolutionBounds

public void setResolutionBounds(double lowerBound,
                                double upperBound)
                         throws java.io.IOException,
                                AutomationException

Sets the lower and upper resolution bounds in which the line/area data source participates in the triangulation.

Specified by:

setResolutionBounds in interface ITerrainDataSource

Parameters:

lowerBound - The lowerBound (in)

upperBound - The upperBound (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

queryResolutionBounds

public void queryResolutionBounds(double[] pLowerBound,
                                  double[] pUpperBound)
                           throws java.io.IOException,
                                  AutomationException

Returns the lower and upper resolution bounds in which the line/area data source participates in the triangulation.

Specified by:

queryResolutionBounds in interface ITerrainDataSource

Parameters:

pLowerBound - The pLowerBound (out: use single element array)

pUpperBound - The pUpperBound (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setToBeEmbedded

public void setToBeEmbedded(boolean pbToBeEmbedded)
                     throws java.io.IOException,
                            AutomationException

Indicates the terrain will copy the data and not have a dependency on the data source after the terrain is built.

Specified by:

setToBeEmbedded in interface ITerrainEmbeddedDataSource

Parameters:

pbToBeEmbedded - The pbToBeEmbedded (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isToBeEmbedded

public boolean isToBeEmbedded()
                       throws java.io.IOException,
                              AutomationException

Indicates the terrain will copy the data and not have a dependency on the data source after the terrain is built.

Specified by:

isToBeEmbedded in interface ITerrainEmbeddedDataSource

Returns:

The pbToBeEmbedded

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setName

public void setName(java.lang.String pName)
             throws java.io.IOException,
                    AutomationException

The name of the embedded data source.

Specified by:

setName in interface ITerrainEmbeddedDataSource

Parameters:

pName - The pName (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getName

public java.lang.String getName()
                         throws java.io.IOException,
                                AutomationException

The name of the embedded data source.

Specified by:

getName in interface ITerrainEmbeddedDataSource

Returns:

The pName

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setReservedFields

public void setReservedFields(IStringArray pFields)
                       throws java.io.IOException,
                              AutomationException

Set the names of the database fields associated with the data source that will be copied into the terrain.

Specified by:

setReservedFields in interface ITerrainEmbeddedDataSource

Parameters:

pFields - A reference to a com.esri.arcgis.system.IStringArray (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReservedFields

public IStringArray getReservedFields()
                               throws java.io.IOException,
                                      AutomationException

Returns the names of the database fields associated with the data source that are copied into the terrain.

Specified by:

getReservedFields in interface ITerrainEmbeddedDataSource

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFieldStatistics

public ITerrainFieldStatistics getFieldStatistics(java.lang.String fieldName)
                                           throws java.io.IOException,
                                                  AutomationException

Returns the statistics of the specified Terrain blob field.

Specified by:

getFieldStatistics in interface ITerrainEmbeddedDataSource2

Parameters:

fieldName - The fieldName (in)

Returns:

A reference to a com.esri.arcgis.geodatabaseextensions.ITerrainFieldStatistics

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getReservedFieldStatistics

public IArray getReservedFieldStatistics()
                                  throws java.io.IOException,
                                         AutomationException

Returns the statistics of all the Terrain blob fields.

Specified by:

getReservedFieldStatistics in interface ITerrainEmbeddedDataSource2

Returns:

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

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.