public class SpatialFilter extends java.lang.Object implements com.esri.arcgis.interop.RemoteObjRef, ISpatialFilter, IQueryFilter, IQueryFilter2, IQueryFilterDefinition, IQueryFilterDefinition2, IQueryFilterDefinition3, IQueryFilterFIDSet, IClone, IPersistStream, IXMLSerialize, java.io.Externalizable
Description 'Esri Spatial Filter object.' Generator Options: PromptForTypeLibraries = False ClashPrefix = esri_ LowerCaseMemberNames = True IDispatchOnly = False RetryOnReject = False AwtForOcxs = True ArraysAsObjects = False DontRenameSameMethods = False ImplementConflictingInterfaces = True ReuseMethods = True RenameConflictingInterfaceMethods = True GenBeanInfo = True GenerateJavadoc =
| Modifier and Type | Field and Description |
|---|---|
static long |
serialVersionUID |
IID, IIDfdfebd94_ed75_11d0_9a95_080009ec734b, xxDummyIID, IIDe5b21410_17a6_11d4_9f4b_00c04f79927c, xxDummyIID, IIDadfe656b_a187_4cd2_add3_4f067f61d986, xxDummyIID45096447_06ff_4e5e_a260_9213e009af29IID90f3c7ca_30d5_454b_ab33_fb869991edfeIID, IID4430bbbe_47b7_11d4_9f52_00c04f79927c, xxDummyIID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummyIID, IID00000109_0000_0000_c000_000000000046, xxDummyIID0000010c_0000_0000_c000_000000000046IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy| Constructor and Description |
|---|
SpatialFilter()
Constructs a SpatialFilter using ArcGIS Engine.
|
SpatialFilter(java.lang.Object obj)
Deprecated.
As of ArcGIS 9.2, replaced by normal Java casts.
SpatialFilter theSpatialFilter = (SpatialFilter) obj; |
| Modifier and Type | Method and Description |
|---|---|
void |
addField(java.lang.String subField)
Appends a single field name to the list of sub-fields.
|
void |
assign(IClone src)
Assigns the properties of src to the receiver.
|
void |
deserialize(IXMLSerializeData data)
Deserializes an object from XML.
|
boolean |
equals(java.lang.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 java.lang.String |
getClsid()
getClsid.
|
IFIDSet |
getFIDSet()
The FID set used to filter results.
|
IFilterDefs |
getFilterDefs()
The filter definitions specified for this query filter.
|
IGeometry |
getGeometry()
The query geometry used to filter results.
|
java.lang.String |
getGeometryField()
The name of the Geometry field to which the filter applies.
|
com.esri.arcgis.interop.Dispatch |
getJintegraDispatch()
Gets a reference to a com.esri.arcgis.interop.Dispatch which can be used to access the COM object that support for this
interface indicates the implementing class references.
|
ISpatialReference |
getOutputSpatialReference(java.lang.String fieldName)
The spatial reference in which to output geometry for a given field.
|
void |
getPaginationClause(int[] offset,
int[] rowCount)
A clause that controls query pagination.
|
java.lang.String |
getPostfixClause()
A clause that will be appended to the SELECT statement, following the where clause.
|
java.lang.String |
getPrefixClause()
A clause that will be inserted between the SELECT keyword and the SELECT COLUMN LIST.
|
int |
getSearchOrder()
The search order used by the filter.
|
void |
getSizeMax(_ULARGE_INTEGER[] pcbSize)
getSizeMax
|
int |
getSpatialRel()
The spatial relationship checked by the filter.
|
java.lang.String |
getSpatialRelDescription()
The array elements which describe the spatial relation between the query geometry and the requested geometries.
|
double |
getSpatialResolution()
The spatial resolution in which to output geometry.
|
java.lang.String |
getSubFields()
The comma delimited list of field names for the filter.
|
java.lang.String |
getWhereClause()
The where clause for the filter.
|
int |
hashCode()
the hashcode for this object
|
void |
isDirty()
isDirty
|
boolean |
isEqual(IClone other)
Indicates if the receiver and other have the same properties.
|
boolean |
isFilterOwnsGeometry()
Indicates whether the filter owns the query geometry.
|
boolean |
isIdentical(IClone other)
Indicates if the receiver and other are the same object.
|
void |
load(IStream pstm)
load
|
void |
readExternal(java.io.ObjectInput in) |
void |
release()
Release this COM object reference
|
void |
save(IStream pstm,
int fClearDirty)
save
|
void |
serialize(IXMLSerializeData data)
Serializes an object to XML.
|
void |
setFIDSetByRef(IFIDSet fIDSet)
The FID set used to filter results.
|
void |
setFilterDefsByRef(IFilterDefs filters)
The filter definitions specified for this query filter.
|
void |
setGeometryByRef(IGeometry geometry)
The query geometry used to filter results.
|
void |
setGeometryExByRef(IGeometry geometry,
boolean rhs2)
The query geometry used to filter results.
|
void |
setGeometryField(java.lang.String geomField)
The name of the Geometry field to which the filter applies.
|
void |
setOutputSpatialReferenceByRef(java.lang.String fieldName,
ISpatialReference outputSpatialReference)
The spatial reference in which to output geometry for a given field.
|
void |
setPaginationClause(int offset,
int rowCount)
A clause that controls query pagination.
|
void |
setPostfixClause(java.lang.String clause)
A clause that will be appended to the SELECT statement, following the where clause.
|
void |
setPrefixClause(java.lang.String clause)
A clause that will be inserted between the SELECT keyword and the SELECT COLUMN LIST.
|
void |
setSearchOrder(int order)
The search order used by the filter.
|
void |
setSpatialRel(int spatialRel)
The spatial relationship checked by the filter.
|
void |
setSpatialRelDescription(java.lang.String spatialRelDescription)
The array elements which describe the spatial relation between the query geometry and the requested geometries.
|
void |
setSpatialResolution(double resolution)
The spatial resolution in which to output geometry.
|
void |
setSubFields(java.lang.String subFields)
The comma delimited list of field names for the filter.
|
void |
setWhereClause(java.lang.String whereClause)
The where clause for the filter.
|
void |
writeExternal(java.io.ObjectOutput out) |
public static final long serialVersionUID
public SpatialFilter()
throws java.io.IOException,
java.net.UnknownHostException
java.io.IOException - if there are interop problemsjava.net.UnknownHostException - if there are interop problemspublic SpatialFilter(java.lang.Object obj)
throws java.io.IOException
SpatialFilter theSpatialFilter = (SpatialFilter) obj;obj to SpatialFilter.obj - an object returned from ArcGIS Engine or Serverjava.io.IOException - if there are interop problemspublic static java.lang.String getClsid()
public boolean equals(java.lang.Object o)
equals in class java.lang.Objectpublic int hashCode()
hashCode in class java.lang.Objectpublic com.esri.arcgis.interop.Dispatch getJintegraDispatch()
getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRefpublic void release()
release in interface com.esri.arcgis.interop.RemoteObjRefpublic int getSearchOrder()
throws java.io.IOException,
AutomationException
getSearchOrder in interface ISpatialFilterjava.io.IOException - If there are interop problems.AutomationException - If the ArcObject component throws an exception.public void setSearchOrder(int order)
throws java.io.IOException,
AutomationException
setSearchOrder in interface ISpatialFilterorder - A com.esri.arcgis.geodatabase.esriSearchOrder constant (in)java.io.IOException - If there are interop problems.AutomationException - If the ArcObject component throws an exception.public int getSpatialRel()
throws java.io.IOException,
AutomationException
getSpatialRel in interface ISpatialFilterjava.io.IOException - If there are interop problems.AutomationException - If the ArcObject component throws an exception.public void setSpatialRel(int spatialRel)
throws java.io.IOException,
AutomationException
setSpatialRel in interface ISpatialFilterspatialRel - A com.esri.arcgis.geodatabase.esriSpatialRelEnum constant (in)java.io.IOException - If there are interop problems.AutomationException - If the ArcObject component throws an exception.public IGeometry getGeometry() throws java.io.IOException, AutomationException
getGeometry in interface ISpatialFilterjava.io.IOException - If there are interop problems.AutomationException - If the ArcObject component throws an exception.public void setGeometryByRef(IGeometry geometry) throws java.io.IOException, AutomationException
setGeometryByRef in interface ISpatialFiltergeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)java.io.IOException - If there are interop problems.AutomationException - If the ArcObject component throws an exception.public void setGeometryExByRef(IGeometry geometry, boolean rhs2) throws java.io.IOException, AutomationException
setGeometryExByRef in interface ISpatialFiltergeometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)rhs2 - The rhs2 (in)java.io.IOException - If there are interop problems.AutomationException - If the ArcObject component throws an exception.public boolean isFilterOwnsGeometry()
throws java.io.IOException,
AutomationException
isFilterOwnsGeometry in interface ISpatialFilterjava.io.IOException - If there are interop problems.AutomationException - If the ArcObject component throws an exception.public java.lang.String getGeometryField()
throws java.io.IOException,
AutomationException
getGeometryField in interface ISpatialFilterjava.io.IOException - If there are interop problems.AutomationException - If the ArcObject component throws an exception.public void setGeometryField(java.lang.String geomField)
throws java.io.IOException,
AutomationException
setGeometryField in interface ISpatialFiltergeomField - The geomField (in)java.io.IOException - If there are interop problems.AutomationException - If the ArcObject component throws an exception.public java.lang.String getSpatialRelDescription()
throws java.io.IOException,
AutomationException
getSpatialRelDescription in interface ISpatialFilterjava.io.IOException - If there are interop problems.AutomationException - If the ArcObject component throws an exception.public void setSpatialRelDescription(java.lang.String spatialRelDescription)
throws java.io.IOException,
AutomationException
setSpatialRelDescription in interface ISpatialFilterspatialRelDescription - The spatialRelDescription (in)java.io.IOException - If there are interop problems.AutomationException - If the ArcObject component throws an exception.public java.lang.String getSubFields()
throws java.io.IOException,
AutomationException
getSubFields in interface IQueryFilterjava.io.IOException - If there are interop problems.AutomationException - If the ArcObject component throws an exception.public void setSubFields(java.lang.String subFields)
throws java.io.IOException,
AutomationException
setSubFields in interface IQueryFiltersubFields - The subFields (in)java.io.IOException - If there are interop problems.AutomationException - If the ArcObject component throws an exception.public void addField(java.lang.String subField)
throws java.io.IOException,
AutomationException
addField in interface IQueryFiltersubField - The subField (in)java.io.IOException - If there are interop problems.AutomationException - If the ArcObject component throws an exception.public java.lang.String getWhereClause()
throws java.io.IOException,
AutomationException
getWhereClause in interface IQueryFilterjava.io.IOException - If there are interop problems.AutomationException - If the ArcObject component throws an exception.public void setWhereClause(java.lang.String whereClause)
throws java.io.IOException,
AutomationException
setWhereClause in interface IQueryFilterwhereClause - The whereClause (in)java.io.IOException - If there are interop problems.AutomationException - If the ArcObject component throws an exception.public ISpatialReference getOutputSpatialReference(java.lang.String fieldName) throws java.io.IOException, AutomationException
getOutputSpatialReference in interface IQueryFilterfieldName - The fieldName (in)java.io.IOException - If there are interop problems.AutomationException - If the ArcObject component throws an exception.public void setOutputSpatialReferenceByRef(java.lang.String fieldName,
ISpatialReference outputSpatialReference)
throws java.io.IOException,
AutomationException
setOutputSpatialReferenceByRef in interface IQueryFilterfieldName - The fieldName (in)outputSpatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)java.io.IOException - If there are interop problems.AutomationException - If the ArcObject component throws an exception.public double getSpatialResolution()
throws java.io.IOException,
AutomationException
getSpatialResolution in interface IQueryFilter2java.io.IOException - If there are interop problems.AutomationException - If the ArcObject component throws an exception.public void setSpatialResolution(double resolution)
throws java.io.IOException,
AutomationException
setSpatialResolution in interface IQueryFilter2resolution - The resolution (in)java.io.IOException - If there are interop problems.AutomationException - If the ArcObject component throws an exception.public java.lang.String getPostfixClause()
throws java.io.IOException,
AutomationException
getPostfixClause in interface IQueryFilterDefinitionjava.io.IOException - If there are interop problems.AutomationException - If the ArcObject component throws an exception.public void setPostfixClause(java.lang.String clause)
throws java.io.IOException,
AutomationException
setPostfixClause in interface IQueryFilterDefinitionclause - The clause (in)java.io.IOException - If there are interop problems.AutomationException - If the ArcObject component throws an exception.public IFilterDefs getFilterDefs() throws java.io.IOException, AutomationException
getFilterDefs in interface IQueryFilterDefinitionjava.io.IOException - If there are interop problems.AutomationException - If the ArcObject component throws an exception.public void setFilterDefsByRef(IFilterDefs filters) throws java.io.IOException, AutomationException
setFilterDefsByRef in interface IQueryFilterDefinitionfilters - A reference to a com.esri.arcgis.geodatabase.IFilterDefs (in)java.io.IOException - If there are interop problems.AutomationException - If the ArcObject component throws an exception.public java.lang.String getPrefixClause()
throws java.io.IOException,
AutomationException
getPrefixClause in interface IQueryFilterDefinition2java.io.IOException - If there are interop problems.AutomationException - If the ArcObject component throws an exception.public void setPrefixClause(java.lang.String clause)
throws java.io.IOException,
AutomationException
setPrefixClause in interface IQueryFilterDefinition2clause - The clause (in)java.io.IOException - If there are interop problems.AutomationException - If the ArcObject component throws an exception.public void getPaginationClause(int[] offset,
int[] rowCount)
throws java.io.IOException,
AutomationException
getPaginationClause in interface IQueryFilterDefinition3offset - The offset (out: use single element array)rowCount - The rowCount (out: use single element array)java.io.IOException - If there are interop problems.AutomationException - If the ArcObject component throws an exception.public void setPaginationClause(int offset,
int rowCount)
throws java.io.IOException,
AutomationException
setPaginationClause in interface IQueryFilterDefinition3offset - The offset (in)rowCount - The rowCount (in)java.io.IOException - If there are interop problems.AutomationException - If the ArcObject component throws an exception.public IFIDSet getFIDSet() throws java.io.IOException, AutomationException
getFIDSet in interface IQueryFilterFIDSetjava.io.IOException - If there are interop problems.AutomationException - If the ArcObject component throws an exception.public void setFIDSetByRef(IFIDSet fIDSet) throws java.io.IOException, AutomationException
setFIDSetByRef in interface IQueryFilterFIDSetfIDSet - A reference to a com.esri.arcgis.geodatabase.IFIDSet (in)java.io.IOException - If there are interop problems.AutomationException - If the ArcObject component throws an exception.public IClone esri_clone() throws java.io.IOException, AutomationException
esri_clone in interface IClonejava.io.IOException - If there are interop problems.AutomationException - If the ArcObject component throws an exception.public void assign(IClone src) throws java.io.IOException, AutomationException
assign in interface IClonesrc - A reference to a com.esri.arcgis.system.IClone (in)java.io.IOException - If there are interop problems.AutomationException - If the ArcObject component throws an exception.public boolean isEqual(IClone other) throws java.io.IOException, AutomationException
isEqual in interface ICloneother - A reference to a com.esri.arcgis.system.IClone (in)java.io.IOException - If there are interop problems.AutomationException - If the ArcObject component throws an exception.public boolean isIdentical(IClone other) throws java.io.IOException, AutomationException
isIdentical in interface ICloneother - A reference to a com.esri.arcgis.system.IClone (in)java.io.IOException - If there are interop problems.AutomationException - If the ArcObject component throws an exception.public void isDirty()
throws java.io.IOException,
AutomationException
isDirty in interface IPersistStreamjava.io.IOException - If there are interop problems.AutomationException - If the ArcObject component throws an exception.public void load(IStream pstm) throws java.io.IOException, AutomationException
load in interface IPersistStreampstm - A reference to a com.esri.arcgis.system.IStream (in)java.io.IOException - If there are interop problems.AutomationException - If the ArcObject component throws an exception.public void save(IStream pstm, int fClearDirty) throws java.io.IOException, AutomationException
save in interface IPersistStreampstm - A reference to a com.esri.arcgis.system.IStream (in)fClearDirty - The fClearDirty (in)java.io.IOException - If there are interop problems.AutomationException - If the ArcObject component throws an exception.public void getSizeMax(_ULARGE_INTEGER[] pcbSize) throws java.io.IOException, AutomationException
getSizeMax in interface IPersistStreampcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)java.io.IOException - If there are interop problems.AutomationException - If the ArcObject component throws an exception.public void getClassID(GUID[] pClassID) throws java.io.IOException, AutomationException
getClassID in interface IPersistpClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)java.io.IOException - If there are interop problems.AutomationException - If the ArcObject component throws an exception.public void serialize(IXMLSerializeData data) throws java.io.IOException, AutomationException
serialize in interface IXMLSerializedata - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)java.io.IOException - If there are interop problems.AutomationException - If the ArcObject component throws an exception.public void deserialize(IXMLSerializeData data) throws java.io.IOException, AutomationException
deserialize in interface IXMLSerializedata - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)java.io.IOException - If there are interop problems.AutomationException - If the ArcObject component throws an exception.public void writeExternal(java.io.ObjectOutput out)
throws java.io.IOException
writeExternal in interface java.io.Externalizablejava.io.IOExceptionpublic void readExternal(java.io.ObjectInput in)
throws java.io.IOException,
java.lang.ClassNotFoundException
readExternal in interface java.io.Externalizablejava.io.IOExceptionjava.lang.ClassNotFoundException