com.esri.arcgis.geodatabase
Class GeometryResultOptions

java.lang.Object
  extended by com.esri.arcgis.geodatabase.GeometryResultOptions
All Implemented Interfaces:
IGeometryResultOptions, com.esri.arcgis.interop.RemoteObjRef, IDocumentVersionSupportGEN, IPersist, IPersistStream, IXMLSerialize, IXMLVersionSupport, Externalizable, Serializable

public class GeometryResultOptions
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IGeometryResultOptions, IXMLSerialize, IPersistStream, IXMLVersionSupport, IDocumentVersionSupportGEN, Externalizable

Esri Geometry export options object.

Description

This object is new at ArcGIS 9.3.

Product Availability

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

See Also:
Serialized Form

Constructor Summary
GeometryResultOptions()
          Constructs a GeometryResultOptions using ArcGIS Engine.
GeometryResultOptions(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GeometryResultOptions theGeometryResultOptions = (GeometryResultOptions) obj;
 
Method Summary
 Object convertToSupportedObject(int docVersion)
          Convert the object to another object that is supported.
 void deserialize(IXMLSerializeData data)
          Deserializes an object from XML.
 boolean equals(Object o)
          Compare this object with another
 void getClassID(GUID[] pClassID)
          getClassID
static String getClsid()
          getClsid.
 double getMaximumAllowableOffset()
          The maximum allowable offset.
 double getMaximumDeviation()
          The maximum deviation.
 double getMaximumSegmentLength()
          The maximum segment length.
 String getMinNamespaceSupported()
          The minimum namespace the class can serialize to (eg the 90 namespace).
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 int hashCode()
          the hashcode for this object
 boolean isDensifyGeometries()
          Indicates if MaximumSegmentLength and MaximumDeviation will be honored to densify geometry in the results.
 void isDirty()
          isDirty
 boolean isGeneralizeGeometries()
          Indicates whether MaximumAllowableOffset will be honored to generalize the geometry in the results.
 boolean isSupportedAtVersion(int docVersion)
          Is this object valid at the given document version.
 void load(IStream pstm)
          load
 void readExternal(ObjectInput in)
           
 void save(IStream pstm, int fClearDirty)
          save
 void serialize(IXMLSerializeData data)
          Serializes an object to XML.
 void setDensifyGeometries(boolean doDensify)
          Indicates if MaximumSegmentLength and MaximumDeviation will be honored to densify geometry in the results.
 void setGeneralizeGeometries(boolean doGeneralize)
          Indicates whether MaximumAllowableOffset will be honored to generalize the geometry in the results.
 void setMaximumAllowableOffset(double maxOffset)
          The maximum allowable offset.
 void setMaximumDeviation(double maxDev)
          The maximum deviation.
 void setMaximumSegmentLength(double maxSegLen)
          The maximum segment length.
 void writeExternal(ObjectOutput out)
           
 
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

GeometryResultOptions

public GeometryResultOptions()
                      throws IOException,
                             UnknownHostException
Constructs a GeometryResultOptions using ArcGIS Engine.

Throws:
IOException - if there are interop problems
UnknownHostException - if there are interop problems

GeometryResultOptions

public GeometryResultOptions(Object obj)
                      throws IOException
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GeometryResultOptions theGeometryResultOptions = (GeometryResultOptions) obj;

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

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

isDensifyGeometries

public boolean isDensifyGeometries()
                            throws IOException,
                                   AutomationException
Indicates if MaximumSegmentLength and MaximumDeviation will be honored to densify geometry in the results.

Remarks

When DensifyGeometries is set to true, MaximumDeviation and MaximumSegmentLength should also be set. For more information please see Densify.

Product Availability

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

Specified by:
isDensifyGeometries in interface IGeometryResultOptions
Returns:
The doDensify
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDensifyGeometries

public void setDensifyGeometries(boolean doDensify)
                          throws IOException,
                                 AutomationException
Indicates if MaximumSegmentLength and MaximumDeviation will be honored to densify geometry in the results.

Product Availability

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

Specified by:
setDensifyGeometries in interface IGeometryResultOptions
Parameters:
doDensify - The doDensify (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaximumSegmentLength

public double getMaximumSegmentLength()
                               throws IOException,
                                      AutomationException
The maximum segment length.

Remarks

Default value for MaximumSegmentLength is -1. Values for MaximumSegmentLength must be in the units of the map's spatial reference. For example, if the units of the spatial reference of the feature class being queried is in decimal degrees and the spatial reference units of the map is in meters, the values specified for MaximumSegmentLength must be in meters.

Product Availability

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

Specified by:
getMaximumSegmentLength in interface IGeometryResultOptions
Returns:
The maxSegLen
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaximumSegmentLength

public void setMaximumSegmentLength(double maxSegLen)
                             throws IOException,
                                    AutomationException
The maximum segment length.

Product Availability

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

Specified by:
setMaximumSegmentLength in interface IGeometryResultOptions
Parameters:
maxSegLen - The maxSegLen (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaximumDeviation

public double getMaximumDeviation()
                           throws IOException,
                                  AutomationException
The maximum deviation.

Remarks

Default value for MaximumDeviation is 0. Values for MaximumDeviation must be in the units of the map's spatial reference. For example, if the units of the spatial reference of the feature class being queried is in decimal degrees and the spatial reference units of the map is in meters, the values specified for MaximumDeviation must be in meters.

Product Availability

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

Specified by:
getMaximumDeviation in interface IGeometryResultOptions
Returns:
The maxDev
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaximumDeviation

public void setMaximumDeviation(double maxDev)
                         throws IOException,
                                AutomationException
The maximum deviation.

Product Availability

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

Specified by:
setMaximumDeviation in interface IGeometryResultOptions
Parameters:
maxDev - The maxDev (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isGeneralizeGeometries

public boolean isGeneralizeGeometries()
                               throws IOException,
                                      AutomationException
Indicates whether MaximumAllowableOffset will be honored to generalize the geometry in the results.

Remarks

When GeneralizeGeometries is set to true, the MaximumAllowableOffset property should also be set. For more information please see Generalize.

Product Availability

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

Specified by:
isGeneralizeGeometries in interface IGeometryResultOptions
Returns:
The doGeneralize
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setGeneralizeGeometries

public void setGeneralizeGeometries(boolean doGeneralize)
                             throws IOException,
                                    AutomationException
Indicates whether MaximumAllowableOffset will be honored to generalize the geometry in the results.

Product Availability

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

Specified by:
setGeneralizeGeometries in interface IGeometryResultOptions
Parameters:
doGeneralize - The doGeneralize (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMaximumAllowableOffset

public double getMaximumAllowableOffset()
                                 throws IOException,
                                        AutomationException
The maximum allowable offset.

Remarks

Default value for MaximumAllowableOffset is 0. Values for MaximumAllowableOffset must be in the units of the map's spatial reference. For example, if the units of the spatial reference of the feature class being queried is in decimal degrees and the spatial reference units of the map is in meters, the values specified for MaximumAllowableOffset must be in meters.

Product Availability

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

Specified by:
getMaximumAllowableOffset in interface IGeometryResultOptions
Returns:
The maxOffset
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaximumAllowableOffset

public void setMaximumAllowableOffset(double maxOffset)
                               throws IOException,
                                      AutomationException
The maximum allowable offset.

Product Availability

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

Specified by:
setMaximumAllowableOffset in interface IGeometryResultOptions
Parameters:
maxOffset - The maxOffset (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws IOException,
                      AutomationException
Serializes an object to XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
serialize in interface IXMLSerialize
Parameters:
data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws IOException,
                        AutomationException
Deserializes an object from XML.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
deserialize in interface IXMLSerialize
Parameters:
data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws IOException,
                    AutomationException
isDirty

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isDirty in interface IPersistStream
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws IOException,
                 AutomationException
load

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
load in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

save

public void save(IStream pstm,
                 int fClearDirty)
          throws IOException,
                 AutomationException
save

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
save in interface IPersistStream
Parameters:
pstm - A reference to a com.esri.arcgis.system.IStream (in)
fClearDirty - The fClearDirty (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getSizeMax

public void getSizeMax(_ULARGE_INTEGER[] pcbSize)
                throws IOException,
                       AutomationException
getSizeMax

Description

IPersistStream is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSizeMax in interface IPersistStream
Parameters:
pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getClassID

public void getClassID(GUID[] pClassID)
                throws IOException,
                       AutomationException
getClassID

Description

IPersist is a Microsoft interface. Please refer to MSDN for information about this interface.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getClassID in interface IPersist
Parameters:
pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMinNamespaceSupported

public String getMinNamespaceSupported()
                                throws IOException,
                                       AutomationException
The minimum namespace the class can serialize to (eg the 90 namespace).

Product Availability

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

Specified by:
getMinNamespaceSupported in interface IXMLVersionSupport
Returns:
The namespaceURI
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isSupportedAtVersion

public boolean isSupportedAtVersion(int docVersion)
                             throws IOException,
                                    AutomationException
Is this object valid at the given document version.

Remarks

Use IsSupportedAtVersion to identify if a particular object should be saved to the ObjectStream. This result is based on the esriArcGISVersion enumeration. In some instances, if the object is not supported at a particular ArcGIS version, the object may support conversion to another similar object; use IDocumentVersionSupportGEN::ConvertToSupportedObject to accomplish this.

Product Availability

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

Specified by:
isSupportedAtVersion in interface IDocumentVersionSupportGEN
Parameters:
docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)
Returns:
The supported
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

convertToSupportedObject

public Object convertToSupportedObject(int docVersion)
                                throws IOException,
                                       AutomationException
Convert the object to another object that is supported.

Remarks

This method should be used when IDocumentVersionSupportGEN::IsSupportedAtVersion returns FALSE. Calling ConvertToSupportedObject will return an IUnknown pointer to a relevant object supported at the particular ArcGIS version. Not all objects will return a supported object; in these cases a null pointer will be returned.

Product Availability

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

Specified by:
convertToSupportedObject in interface IDocumentVersionSupportGEN
Parameters:
docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)
Returns:
A Variant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException
Specified by:
writeExternal in interface Externalizable
Throws:
IOException

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
Specified by:
readExternal in interface Externalizable
Throws:
IOException
ClassNotFoundException