com.esri.arcgis.geoprocessing
Class GPFeatureClassDomain

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.GPFeatureClassDomain
All Implemented Interfaces:
IGPDomain, IGxFilterInfo, IGPFeatureClassDomain, com.esri.arcgis.interop.RemoteObjRef, IClone, IPersist, IPersistStream, IXMLSerialize, Externalizable, Serializable

public class GPFeatureClassDomain
extends Object
implements com.esri.arcgis.interop.RemoteObjRef, IClone, IXMLSerialize, IPersistStream, IGPDomain, IGPFeatureClassDomain, IGxFilterInfo, Externalizable

Geoprocessing Feature Class Domain.

Product Availability

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

Supported Platforms

Windows

See Also:
Serialized Form

Constructor Summary
GPFeatureClassDomain()
          Constructs a GPFeatureClassDomain using ArcGIS Engine.
GPFeatureClassDomain(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GPFeatureClassDomain theGPFeatureClassDomain = (GPFeatureClassDomain) obj;
 
Method Summary
 void addFeatureType(int type)
          Add a feature class type.
 void addType(int type)
          Add a shape type.
 void assign(IClone src)
          Assigns the properties of src to the receiver.
 void deleteFeatureType(int type)
          Remove a feature class type.
 void deleteType(int type)
          Remove a shape type.
 void deserialize(IXMLSerializeData data)
          Deserializes an object from XML.
 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.
 int getCount()
          Count.
 int getFeatureType(int index)
          Feature class type.
 int getFeatureTypeCount()
          Count.
 IArray getOpenGxObjectFilters()
          The filters used to open a dataset of this type.
 IArray getSaveGxObjectFilters()
          The filters used to save a dataset of this type.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 int getType(int index)
          Shape type.
 int hashCode()
          the hashcode for this object
 void isDirty()
          isDirty
 boolean isEqual(IClone other)
          Returns TRUE when the receiver and other have the same properties.
 boolean isFilterHasMs()
          Indicates whether or not to filter feature classes based on whether or not they have measures.
 boolean isFilterHasZs()
          Indicates whether or not to filter feature classes based on whether or not they have Z values.
 boolean isFilterIndex()
          Indicates whether or not to filter feature classes based on whether or not they have a spatial index.
 boolean isFilterIndexType()
          Indicates whether to filter feature classes that have or do not have a spatial index.
 boolean isIdentical(IClone other)
          Returns TRUE when the receiver and other are the same object.
 boolean isIncludeHasMs()
          Indicates whether to filter feature classes that have or do not have measures.
 boolean isIncludeHasZs()
          Indicates whether to filter feature classes that have or do not have Z values.
 void load(IStream pstm)
          load
 IArray makeList(IGPValue pValue)
          Make list.
 IGPMessage memberOf(IGPValue value)
          Indicates if the value object is a member of the geoprocessing domain type.
 void readExternal(ObjectInput in)
           
 void save(IStream pstm, int fClearDirty)
          save
 void serialize(IXMLSerializeData data)
          Serializes an object to XML.
 void setHasMsFilter(boolean filter, boolean includeHasMs)
          Set HasMs filter.
 void setHasZsFilter(boolean filter, boolean includeHasZs)
          Set HasZs filter.
 void setIndexFilter(boolean filter, boolean type)
          Set index filter.
 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

GPFeatureClassDomain

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

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

GPFeatureClassDomain

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

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

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

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.

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.

memberOf

public IGPMessage memberOf(IGPValue value)
                    throws IOException,
                           AutomationException
Indicates if the value object is a member of the geoprocessing domain type.

Product Availability

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

Specified by:
memberOf in interface IGPDomain
Parameters:
value - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)
Returns:
A reference to a com.esri.arcgis.geodatabase.IGPMessage
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getCount

public int getCount()
             throws IOException,
                    AutomationException
Count.

Product Availability

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

Supported Platforms

Windows

Specified by:
getCount in interface IGPFeatureClassDomain
Returns:
The pCount
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getType

public int getType(int index)
            throws IOException,
                   AutomationException
Shape type.

Product Availability

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

Specified by:
getType in interface IGPFeatureClassDomain
Parameters:
index - The index (in)
Returns:
A com.esri.arcgis.geometry.esriGeometryType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addType

public void addType(int type)
             throws IOException,
                    AutomationException
Add a shape type.

Product Availability

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

Supported Platforms

Windows

Specified by:
addType in interface IGPFeatureClassDomain
Parameters:
type - A com.esri.arcgis.geometry.esriGeometryType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deleteType

public void deleteType(int type)
                throws IOException,
                       AutomationException
Remove a shape type.

Product Availability

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

Supported Platforms

Windows

Specified by:
deleteType in interface IGPFeatureClassDomain
Parameters:
type - A com.esri.arcgis.geometry.esriGeometryType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

makeList

public IArray makeList(IGPValue pValue)
                throws IOException,
                       AutomationException
Make list.

Product Availability

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

Supported Platforms

Windows

Specified by:
makeList in interface IGPFeatureClassDomain
Parameters:
pValue - A reference to a com.esri.arcgis.geodatabase.IGPValue (in)
Returns:
A reference to a com.esri.arcgis.system.IArray
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setIndexFilter

public void setIndexFilter(boolean filter,
                           boolean type)
                    throws IOException,
                           AutomationException
Set index filter.

Product Availability

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

Supported Platforms

Windows

Specified by:
setIndexFilter in interface IGPFeatureClassDomain
Parameters:
filter - The filter (in)
type - The type (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isFilterIndex

public boolean isFilterIndex()
                      throws IOException,
                             AutomationException
Indicates whether or not to filter feature classes based on whether or not they have a spatial index.

Product Availability

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

Supported Platforms

Windows

Specified by:
isFilterIndex in interface IGPFeatureClassDomain
Returns:
The pFilter
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isFilterIndexType

public boolean isFilterIndexType()
                          throws IOException,
                                 AutomationException
Indicates whether to filter feature classes that have or do not have a spatial index.

Product Availability

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

Supported Platforms

Windows

Specified by:
isFilterIndexType in interface IGPFeatureClassDomain
Returns:
The pType
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setHasMsFilter

public void setHasMsFilter(boolean filter,
                           boolean includeHasMs)
                    throws IOException,
                           AutomationException
Set HasMs filter.

Product Availability

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

Supported Platforms

Windows

Specified by:
setHasMsFilter in interface IGPFeatureClassDomain
Parameters:
filter - The filter (in)
includeHasMs - The includeHasMs (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isFilterHasMs

public boolean isFilterHasMs()
                      throws IOException,
                             AutomationException
Indicates whether or not to filter feature classes based on whether or not they have measures.

Product Availability

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

Supported Platforms

Windows

Specified by:
isFilterHasMs in interface IGPFeatureClassDomain
Returns:
The pFilterHasMs
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isIncludeHasMs

public boolean isIncludeHasMs()
                       throws IOException,
                              AutomationException
Indicates whether to filter feature classes that have or do not have measures.

Product Availability

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

Supported Platforms

Windows

Specified by:
isIncludeHasMs in interface IGPFeatureClassDomain
Returns:
The pIncludeHasMs
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

setHasZsFilter

public void setHasZsFilter(boolean filter,
                           boolean includeHasZs)
                    throws IOException,
                           AutomationException
Set HasZs filter.

Product Availability

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

Supported Platforms

Windows

Specified by:
setHasZsFilter in interface IGPFeatureClassDomain
Parameters:
filter - The filter (in)
includeHasZs - The includeHasZs (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isFilterHasZs

public boolean isFilterHasZs()
                      throws IOException,
                             AutomationException
Indicates whether or not to filter feature classes based on whether or not they have Z values.

Product Availability

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

Supported Platforms

Windows

Specified by:
isFilterHasZs in interface IGPFeatureClassDomain
Returns:
The pFilterHasZs
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

isIncludeHasZs

public boolean isIncludeHasZs()
                       throws IOException,
                              AutomationException
Indicates whether to filter feature classes that have or do not have Z values.

Product Availability

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

Supported Platforms

Windows

Specified by:
isIncludeHasZs in interface IGPFeatureClassDomain
Returns:
The pIncludeHasZs
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFeatureTypeCount

public int getFeatureTypeCount()
                        throws IOException,
                               AutomationException
Count.

Product Availability

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

Supported Platforms

Windows

Specified by:
getFeatureTypeCount in interface IGPFeatureClassDomain
Returns:
The pCount
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFeatureType

public int getFeatureType(int index)
                   throws IOException,
                          AutomationException
Feature class type.

Product Availability

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

Specified by:
getFeatureType in interface IGPFeatureClassDomain
Parameters:
index - The index (in)
Returns:
A com.esri.arcgis.geodatabase.esriFeatureType constant
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addFeatureType

public void addFeatureType(int type)
                    throws IOException,
                           AutomationException
Add a feature class type.

Product Availability

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

Supported Platforms

Windows

Specified by:
addFeatureType in interface IGPFeatureClassDomain
Parameters:
type - A com.esri.arcgis.geodatabase.esriFeatureType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deleteFeatureType

public void deleteFeatureType(int type)
                       throws IOException,
                              AutomationException
Remove a feature class type.

Product Availability

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

Supported Platforms

Windows

Specified by:
deleteFeatureType in interface IGPFeatureClassDomain
Parameters:
type - A com.esri.arcgis.geodatabase.esriFeatureType constant (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getOpenGxObjectFilters

public IArray getOpenGxObjectFilters()
                              throws IOException,
                                     AutomationException
The filters used to open a dataset of this type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

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

getSaveGxObjectFilters

public IArray getSaveGxObjectFilters()
                              throws IOException,
                                     AutomationException
The filters used to save a dataset of this type.

Product Availability

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

Supported Platforms

Windows, Solaris, Linux

Specified by:
getSaveGxObjectFilters in interface IGxFilterInfo
Returns:
A reference to a com.esri.arcgis.system.IArray
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