com.esri.arcgis.location
Class HatchClass

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

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

The hatch class relates a hatch template to a polyline feature layer.

Description

A HatchClass is a container for the hatch definitions. A HatchClass can be defined more than once for the features you wish to hatch. Each HatchClass is composed of one or more hatch definitions.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

See Also:
Serialized Form

Constructor Summary
HatchClass()
          Constructs a HatchClass using ArcGIS Engine.
HatchClass(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
HatchClass theHatchClass = (HatchClass) obj;
 
Method Summary
 void assign(IClone src)
          Assigns the properties of src to the receiver.
 void convertToGraphics(IFeatureLayer pFLayer, IGraphicsLayer pGraphicsLayer, IDisplay pDisplay, int convertType)
          Convert to graphics.
 void draw(IFeatureLayer pFLayer, IDisplay pDisplay, ITrackCancel pTrackCancel)
          Draw.
 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.
 IHatchInputValue getEndRange()
          The EndRange.
 IQueryFilter getFilter()
          Query definition hatch class is defined by.
 IHatchInputValue getHatchInterval()
          Hatch Interval for the class.
 IHatchTemplate getHatchTemplate()
          HatchTemplate for hatch class.
 IHatchInputValue getLateralOffset()
          The LateralOffset.
 double getMaximumScale()
          Maximum scale at which the hatch class will display.
 double getMinimumScale()
          Minimum scale at which the hatch class will display.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 IHatchInputValue getStartRange()
          The StartRange.
 int hashCode()
          the hashcode for this object
 void interfaceSupportsErrorInfo(GUID riid)
          interfaceSupportsErrorInfo
 void isDirty()
          isDirty
 boolean isEqual(IClone other)
          Returns TRUE when the receiver and other have the same properties.
 boolean isIdentical(IClone other)
          Returns TRUE when the receiver and other are the same object.
 boolean isShowHatches()
          Indicates whether to show hatches.
 void load(IStream pstm)
          load
 void readExternal(ObjectInput in)
           
 void save(IStream pstm, int fClearDirty)
          save
 void setEndRangeByRef(IHatchInputValue ppEndRange)
          The EndRange.
 void setFilterByRef(IQueryFilter ppQF)
          Query definition hatch class is defined by.
 void setHatchIntervalByRef(IHatchInputValue ppHatchInterval)
          Hatch Interval for the class.
 void setHatchTemplateByRef(IHatchTemplate ppHatchTemplate)
          HatchTemplate for hatch class.
 void setLateralOffsetByRef(IHatchInputValue ppLateralOffset)
          The LateralOffset.
 void setMaximumScale(double maxScale)
          Maximum scale at which the hatch class will display.
 void setMinimumScale(double minScale)
          Minimum scale at which the hatch class will display.
 void setShowHatches(boolean pshowHatches)
          Indicates whether to show hatches.
 void setStartRangeByRef(IHatchInputValue ppStartRange)
          The StartRange.
 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

HatchClass

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

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

HatchClass

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

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

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

setShowHatches

public void setShowHatches(boolean pshowHatches)
                    throws IOException,
                           AutomationException
Indicates whether to show hatches.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

isShowHatches

public boolean isShowHatches()
                      throws IOException,
                             AutomationException
Indicates whether to show hatches.

Remarks

The ShowHatches property (type as boolean) indicates whether to show hatches.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
isShowHatches in interface IHatchClass
Returns:
The pshowHatches
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getHatchTemplate

public IHatchTemplate getHatchTemplate()
                                throws IOException,
                                       AutomationException
HatchTemplate for hatch class.

Remarks

The HatchTemplate property will need to be associated to a HatchClass.

Example:

IHatchClass pHatchClass1 = new HatchClass();

pHatchClass1.setHatchTemplateByRef(pHatchTemplate);

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setHatchTemplateByRef

public void setHatchTemplateByRef(IHatchTemplate ppHatchTemplate)
                           throws IOException,
                                  AutomationException
HatchTemplate for hatch class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getHatchInterval

public IHatchInputValue getHatchInterval()
                                  throws IOException,
                                         AutomationException
Hatch Interval for the class.

Remarks

The HatchInterval property controls interval between successive hatches.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setHatchIntervalByRef

public void setHatchIntervalByRef(IHatchInputValue ppHatchInterval)
                           throws IOException,
                                  AutomationException
Hatch Interval for the class.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getFilter

public IQueryFilter getFilter()
                       throws IOException,
                              AutomationException
Query definition hatch class is defined by.

Remarks

The Filter property defines the query definition for a hatch class.

Example:

IQueryFilter pQFilt = new QueryFilter();

pQFilt.setWhereClause( "[OBJECTID] = 4 OR [OBJECTID] = 6");

pHatchClass1.setFilterByRef(pQFilt);

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setFilterByRef

public void setFilterByRef(IQueryFilter ppQF)
                    throws IOException,
                           AutomationException
Query definition hatch class is defined by.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
setFilterByRef in interface IHatchClass
Parameters:
ppQF - A reference to a com.esri.arcgis.geodatabase.IQueryFilter (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getMinimumScale

public double getMinimumScale()
                       throws IOException,
                              AutomationException
Minimum scale at which the hatch class will display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getMinimumScale in interface IHatchClass
Returns:
The minScale
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMinimumScale

public void setMinimumScale(double minScale)
                     throws IOException,
                            AutomationException
Minimum scale at which the hatch class will display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getMaximumScale

public double getMaximumScale()
                       throws IOException,
                              AutomationException
Maximum scale at which the hatch class will display.

Remarks

The MaximumScale property defines the maximum scale at which the hatch class will display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getMaximumScale in interface IHatchClass
Returns:
The maxScale
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setMaximumScale

public void setMaximumScale(double maxScale)
                     throws IOException,
                            AutomationException
Maximum scale at which the hatch class will display.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getStartRange

public IHatchInputValue getStartRange()
                               throws IOException,
                                      AutomationException
The StartRange.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setStartRangeByRef

public void setStartRangeByRef(IHatchInputValue ppStartRange)
                        throws IOException,
                               AutomationException
The StartRange.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getEndRange

public IHatchInputValue getEndRange()
                             throws IOException,
                                    AutomationException
The EndRange.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setEndRangeByRef

public void setEndRangeByRef(IHatchInputValue ppEndRange)
                      throws IOException,
                             AutomationException
The EndRange.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getLateralOffset

public IHatchInputValue getLateralOffset()
                                  throws IOException,
                                         AutomationException
The LateralOffset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

setLateralOffsetByRef

public void setLateralOffsetByRef(IHatchInputValue ppLateralOffset)
                           throws IOException,
                                  AutomationException
The LateralOffset.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

draw

public void draw(IFeatureLayer pFLayer,
                 IDisplay pDisplay,
                 ITrackCancel pTrackCancel)
          throws IOException,
                 AutomationException
Draw.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
draw in interface IHatchClass
Parameters:
pFLayer - A reference to a com.esri.arcgis.carto.IFeatureLayer (in)
pDisplay - A reference to a com.esri.arcgis.display.IDisplay (in)
pTrackCancel - 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(IFeatureLayer pFLayer,
                              IGraphicsLayer pGraphicsLayer,
                              IDisplay pDisplay,
                              int convertType)
                       throws IOException,
                              AutomationException
Convert to graphics.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
convertToGraphics in interface IHatchClass
Parameters:
pFLayer - A reference to a com.esri.arcgis.carto.IFeatureLayer (in)
pGraphicsLayer - A reference to a com.esri.arcgis.carto.IGraphicsLayer (in)
pDisplay - A reference to a com.esri.arcgis.display.IDisplay (in)
convertType - A com.esri.arcgis.location.esriConvertHatchesToGraphicsType constant (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