com.esri.arcgis.location
Class HatchTemplate

java.lang.Object
  extended by com.esri.arcgis.location.HatchTemplate
All Implemented Interfaces:
com.esri.arcgis.interop.RemoteObjRef, IHatchTemplate, IClone, IPersist, IPersistStream, ISupportErrorInfo, Externalizable, Serializable

public class HatchTemplate
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IHatchTemplate, IPersistStream, IPersist, IClone, ISupportErrorInfo, Externalizable

A hatch template manages a collection of hatch definitions. It can be applied to a hatch class or can exist as a hatch style.

Remarks

The HatchTemplate manages a collection of hatch definitions. The HatchTemplate can be applied to a HatchClass or exist as a hatch style. In order to create a HatchClass, you will need to assign a HatchTemplate to it.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Constructor Summary
HatchTemplate()
          Constructs a HatchTemplate using ArcGIS Engine.
HatchTemplate(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
HatchTemplate theHatchTemplate = (HatchTemplate) obj;
 
Method Summary
 void addHatchDefinition(int multipleHatchInterval, IHatchDefinition hatchDefinition)
          Adds a hatch definition to the hatch class.
 void assign(IClone src)
          Assigns the properties of src to the receiver.
 void convertToGraphics(IFeature feature, IHatchInputValue interval, IHatchInputValue fromMeasure, IHatchInputValue toMeasure, IHatchInputValue lateralOffset, int measureUnits, IDisplay display, IGraphicsLayer pGraphicsLayer)
          Converts hatches to graphics.
 void drawFeature(IFeature feature, IHatchInputValue interval, IHatchInputValue fromMeasure, IHatchInputValue toMeasure, IHatchInputValue lateralOffset, int measureUnits, IDisplay display, ITrackCancel trackCancel)
          Draws hatches on along a given feature.
 void drawGeometry(IGeometry geometry, double interval, Object fromMeasure, Object toMeasure, Object lateralOffset, int measureUnits, IDisplay display, ITrackCancel trackCancel)
          Draws hatches along a given geometry.
 void drawPreview(IGeometry geometry, double scaleFactor, int selectedDef, Object fromMeasure, Object toMeasure, Object lateralOffset, int measureUnits, IDisplay display, ITrackCancel trackCancel)
          Draws a sample of hatching to a given display.
 boolean equals(Object o)
          Compare this object with another
 IClone esri_clone()
          Clones the receiver and assigns the result to *clone.
 void getClassID(GUID[] pClassID)
          getClassID
static String getClsid()
          getClsid.
 double getDefaultHatchInterval()
          The hatch interval.
 int getDisplayUnits()
          The units to be used for displaying M values in hatch text.
 IHatchDefinition getEndHatchDefinition()
          The hatch definition to be used on the ends of a feature.
 double getEndHatchDrawingTolerance()
          The end hatch drawing tolerance.
 IEnumHatchDefinition getEnumHatchDefinitions()
          The hatch definition enumeration.
 int getHatchDefinitionCount()
          The number of hatch definitions.
 String getName()
          The descriptive name of a hatch class.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 int getUIDisplayUnits()
          The user interface display units.
 int hashCode()
          the hashcode for this object
 void interfaceSupportsErrorInfo(GUID riid)
          interfaceSupportsErrorInfo
 boolean isConvertUnits()
          Indicates whether to convert units for displaying Ms in hatch text.
 void isDirty()
          isDirty
 boolean isEqual(IClone other)
          Returns TRUE when the receiver and other have the same properties.
 boolean isHatchByPart()
          Indicates whether to hatch by part vs.
 boolean isIdentical(IClone other)
          Returns TRUE when the receiver and other are the same object.
 boolean isStartAtIntervalMultiple()
          Indicates whether to start at the interval multiple.
 void load(IStream pstm)
          load
 void readExternal(ObjectInput in)
           
 void removeAll()
          Removes all definitions from the hatch class.
 void removeHatchDefinition(int index)
          Removes a hatch definition from the hatch class.
 void save(IStream pstm, int fClearDirty)
          save
 void setConvertUnits(boolean convertUnits)
          Indicates whether to convert units for displaying Ms in hatch text.
 void setDefaultHatchInterval(double pDefaultHatchInterval)
          The hatch interval.
 void setDisplayUnits(int units)
          The units to be used for displaying M values in hatch text.
 void setEndHatchDefinitionByRef(IHatchDefinition hatchDefinition)
          The hatch definition to be used on the ends of a feature.
 void setEndHatchDrawingTolerance(double drawingTolerance)
          The end hatch drawing tolerance.
 void setHatchByPart(boolean hatchByPart)
          Indicates whether to hatch by part vs.
 void setName(String name)
          The descriptive name of a hatch class.
 void setStartAtIntervalMultiple(boolean startAtIntervalMultiple)
          Indicates whether to start at the interval multiple.
 void setUIDisplayUnits(int units)
          The user interface display units.
 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

HatchTemplate

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

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

HatchTemplate

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

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

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

getName

public String getName()
               throws IOException,
                      AutomationException
The descriptive name of a hatch class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getName in interface IHatchTemplate
Returns:
The name
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setName

public void setName(String name)
             throws IOException,
                    AutomationException
The descriptive name of a hatch class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getDefaultHatchInterval

public double getDefaultHatchInterval()
                               throws IOException,
                                      AutomationException
The hatch interval.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getDefaultHatchInterval in interface IHatchTemplate
Returns:
The pDefaultHatchInterval
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDefaultHatchInterval

public void setDefaultHatchInterval(double pDefaultHatchInterval)
                             throws IOException,
                                    AutomationException
The hatch interval.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getHatchDefinitionCount

public int getHatchDefinitionCount()
                            throws IOException,
                                   AutomationException
The number of hatch definitions.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getHatchDefinitionCount in interface IHatchTemplate
Returns:
The hatchDefinitionCount
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addHatchDefinition

public void addHatchDefinition(int multipleHatchInterval,
                               IHatchDefinition hatchDefinition)
                        throws IOException,
                               AutomationException
Adds a hatch definition to the hatch class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
addHatchDefinition in interface IHatchTemplate
Parameters:
multipleHatchInterval - The multipleHatchInterval (in)
hatchDefinition - A reference to a com.esri.arcgis.location.IHatchDefinition (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getEnumHatchDefinitions

public IEnumHatchDefinition getEnumHatchDefinitions()
                                             throws IOException,
                                                    AutomationException
The hatch definition enumeration.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getEnumHatchDefinitions in interface IHatchTemplate
Returns:
A reference to a com.esri.arcgis.location.IEnumHatchDefinition
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

removeHatchDefinition

public void removeHatchDefinition(int index)
                           throws IOException,
                                  AutomationException
Removes a hatch definition from the hatch class.

Remarks

The index of a hatch definition is based on it's hatch interval. It is not a zero-based index.
For example, a hatch definition with an interval of 5 would have an index value of 5.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

removeAll

public void removeAll()
               throws IOException,
                      AutomationException
Removes all definitions from the hatch class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setEndHatchDefinitionByRef

public void setEndHatchDefinitionByRef(IHatchDefinition hatchDefinition)
                                throws IOException,
                                       AutomationException
The hatch definition to be used on the ends of a feature.

Product Availability

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

Specified by:
setEndHatchDefinitionByRef in interface IHatchTemplate
Parameters:
hatchDefinition - A reference to a com.esri.arcgis.location.IHatchDefinition (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getEndHatchDefinition

public IHatchDefinition getEndHatchDefinition()
                                       throws IOException,
                                              AutomationException
The hatch definition to be used on the ends of a feature.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getEndHatchDefinition in interface IHatchTemplate
Returns:
A reference to a com.esri.arcgis.location.IHatchDefinition
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setEndHatchDrawingTolerance

public void setEndHatchDrawingTolerance(double drawingTolerance)
                                 throws IOException,
                                        AutomationException
The end hatch drawing tolerance.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getEndHatchDrawingTolerance

public double getEndHatchDrawingTolerance()
                                   throws IOException,
                                          AutomationException
The end hatch drawing tolerance.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getEndHatchDrawingTolerance in interface IHatchTemplate
Returns:
The drawingTolerance
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setConvertUnits

public void setConvertUnits(boolean convertUnits)
                     throws IOException,
                            AutomationException
Indicates whether to convert units for displaying Ms in hatch text.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isConvertUnits

public boolean isConvertUnits()
                       throws IOException,
                              AutomationException
Indicates whether to convert units for displaying Ms in hatch text.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isConvertUnits in interface IHatchTemplate
Returns:
The convertUnits
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getDisplayUnits

public int getDisplayUnits()
                    throws IOException,
                           AutomationException
The units to be used for displaying M values in hatch text.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getDisplayUnits in interface IHatchTemplate
Returns:
A com.esri.arcgis.system.esriUnits constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setDisplayUnits

public void setDisplayUnits(int units)
                     throws IOException,
                            AutomationException
The units to be used for displaying M values in hatch text.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setDisplayUnits in interface IHatchTemplate
Parameters:
units - A com.esri.arcgis.system.esriUnits constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setStartAtIntervalMultiple

public void setStartAtIntervalMultiple(boolean startAtIntervalMultiple)
                                throws IOException,
                                       AutomationException
Indicates whether to start at the interval multiple.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isStartAtIntervalMultiple

public boolean isStartAtIntervalMultiple()
                                  throws IOException,
                                         AutomationException
Indicates whether to start at the interval multiple.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isStartAtIntervalMultiple in interface IHatchTemplate
Returns:
The startAtIntervalMultiple
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setUIDisplayUnits

public void setUIDisplayUnits(int units)
                       throws IOException,
                              AutomationException
The user interface display units.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setUIDisplayUnits in interface IHatchTemplate
Parameters:
units - A com.esri.arcgis.system.esriUnits constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getUIDisplayUnits

public int getUIDisplayUnits()
                      throws IOException,
                             AutomationException
The user interface display units.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getUIDisplayUnits in interface IHatchTemplate
Returns:
A com.esri.arcgis.system.esriUnits constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setHatchByPart

public void setHatchByPart(boolean hatchByPart)
                    throws IOException,
                           AutomationException
Indicates whether to hatch by part vs. by polyline.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isHatchByPart

public boolean isHatchByPart()
                      throws IOException,
                             AutomationException
Indicates whether to hatch by part vs. by polyline.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isHatchByPart in interface IHatchTemplate
Returns:
The hatchByPart
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

drawGeometry

public void drawGeometry(IGeometry geometry,
                         double interval,
                         Object fromMeasure,
                         Object toMeasure,
                         Object lateralOffset,
                         int measureUnits,
                         IDisplay display,
                         ITrackCancel trackCancel)
                  throws IOException,
                         AutomationException
Draws hatches along a given geometry.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
drawGeometry in interface IHatchTemplate
Parameters:
geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
interval - The interval (in)
fromMeasure - A Variant (in)
toMeasure - A Variant (in)
lateralOffset - A Variant (in)
measureUnits - A com.esri.arcgis.system.esriUnits constant (in)
display - A reference to a com.esri.arcgis.display.IDisplay (in)
trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

drawFeature

public void drawFeature(IFeature feature,
                        IHatchInputValue interval,
                        IHatchInputValue fromMeasure,
                        IHatchInputValue toMeasure,
                        IHatchInputValue lateralOffset,
                        int measureUnits,
                        IDisplay display,
                        ITrackCancel trackCancel)
                 throws IOException,
                        AutomationException
Draws hatches on along a given feature.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
drawFeature in interface IHatchTemplate
Parameters:
feature - A reference to a com.esri.arcgis.geodatabase.IFeature (in)
interval - A reference to a com.esri.arcgis.location.IHatchInputValue (in)
fromMeasure - A reference to a com.esri.arcgis.location.IHatchInputValue (in)
toMeasure - A reference to a com.esri.arcgis.location.IHatchInputValue (in)
lateralOffset - A reference to a com.esri.arcgis.location.IHatchInputValue (in)
measureUnits - A com.esri.arcgis.system.esriUnits constant (in)
display - A reference to a com.esri.arcgis.display.IDisplay (in)
trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

drawPreview

public void drawPreview(IGeometry geometry,
                        double scaleFactor,
                        int selectedDef,
                        Object fromMeasure,
                        Object toMeasure,
                        Object lateralOffset,
                        int measureUnits,
                        IDisplay display,
                        ITrackCancel trackCancel)
                 throws IOException,
                        AutomationException
Draws a sample of hatching to a given display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
drawPreview in interface IHatchTemplate
Parameters:
geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)
scaleFactor - The scaleFactor (in)
selectedDef - The selectedDef (in)
fromMeasure - A Variant (in)
toMeasure - A Variant (in)
lateralOffset - A Variant (in)
measureUnits - A com.esri.arcgis.system.esriUnits constant (in)
display - A reference to a com.esri.arcgis.display.IDisplay (in)
trackCancel - A reference to a com.esri.arcgis.system.ITrackCancel (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

convertToGraphics

public void convertToGraphics(IFeature feature,
                              IHatchInputValue interval,
                              IHatchInputValue fromMeasure,
                              IHatchInputValue toMeasure,
                              IHatchInputValue lateralOffset,
                              int measureUnits,
                              IDisplay display,
                              IGraphicsLayer pGraphicsLayer)
                       throws IOException,
                              AutomationException
Converts hatches to graphics.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
convertToGraphics in interface IHatchTemplate
Parameters:
feature - A reference to a com.esri.arcgis.geodatabase.IFeature (in)
interval - A reference to a com.esri.arcgis.location.IHatchInputValue (in)
fromMeasure - A reference to a com.esri.arcgis.location.IHatchInputValue (in)
toMeasure - A reference to a com.esri.arcgis.location.IHatchInputValue (in)
lateralOffset - A reference to a com.esri.arcgis.location.IHatchInputValue (in)
measureUnits - A com.esri.arcgis.system.esriUnits constant (in)
display - A reference to a com.esri.arcgis.display.IDisplay (in)
pGraphicsLayer - A reference to a com.esri.arcgis.carto.IGraphicsLayer (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.

esri_clone

public IClone esri_clone()
                  throws IOException,
                         AutomationException
Clones the receiver and assigns the result to *clone.

Product Availability

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

Specified by:
esri_clone in interface IClone
Returns:
A reference to a com.esri.arcgis.system.IClone
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws IOException,
                   AutomationException
Assigns the properties of src to the receiver.

Description

Use Assign method to assign the properties of source object to receiver object. Both objects need to have the same CLSIDs. Both source and receiver objects need to be instantiated.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isEqual

public boolean isEqual(IClone other)
                throws IOException,
                       AutomationException
Returns TRUE when the receiver and other have the same properties.

Description

IsEqual returns True if the receiver and the source have the same properties. Note, this does not imply that the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isEqual in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The equal
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws IOException,
                           AutomationException
Returns TRUE when the receiver and other are the same object.

Description

IsIdentical returns true if the receiver and the source reference the same object.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isIdentical in interface IClone
Parameters:
other - A reference to a com.esri.arcgis.system.IClone (in)
Returns:
The identical
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.

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