com.esri.arcgis.trackinganalyst
Class TemporalQueryFilter

java.lang.Object
  com.esri.arcgis.trackinganalyst.TemporalQueryFilter

All Implemented Interfaces:

IQueryFilter, IQueryFilter2, IQueryFilterDefinition, ISpatialFilter, ITemporalQueryFilter, ITemporalQueryFilter2, com.esri.arcgis.interop.RemoteObjRef, IClone, IDocumentVersionSupportGEN, IPersist, IPersistStream, ISupportErrorInfo, IXMLSerialize, java.io.Externalizable, java.io.Serializable

public class TemporalQueryFilter
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, ITemporalQueryFilter, ITemporalQueryFilter2, ISpatialFilter, IClone, ISupportErrorInfo, IPersist, IPersistStream, IQueryFilter, IQueryFilter2, IQueryFilterDefinition, IXMLSerialize, IDocumentVersionSupportGEN, java.io.Externalizable

COM Class 'TemporalQueryFilter'. Generated 3/19/2015 1:20:45 PM from 'C:\ArcGIS\COM\esriTrackingAnalyst.olb'

Description 'Controls properties for the temporal query filter.' 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 =

See Also:

Serialized Form

Field Summary

static long

serialVersionUID

Fields inherited from interface com.esri.arcgis.geodatabaseextensions.ITemporalQueryFilter2

IID, IID6d3465e9_f6f4_43d6_bba9_87eee56c146e, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabaseextensions.ITemporalQueryFilter

IIDd0cee203_56da_11d5_ae49_00104ba2abcc

Fields inherited from interface com.esri.arcgis.geodatabase.ISpatialFilter

IID, IIDfdfebd94_ed75_11d0_9a95_080009ec734b, xxDummy

Fields inherited from interface com.esri.arcgis.system.IClone

IID, IID9bff8aeb_e415_11d0_943c_080009eebecb, xxDummy

Fields inherited from interface com.esri.arcgis.system.ISupportErrorInfo

IID, IIDdf0b3d60_548f_101b_8e65_08002b2bd119, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersistStream

IID, IID00000109_0000_0000_c000_000000000046, xxDummy

Fields inherited from interface com.esri.arcgis.system.IPersist

IID0000010c_0000_0000_c000_000000000046

Fields inherited from interface com.esri.arcgis.geodatabase.IQueryFilter2

IID, IIDe5b21410_17a6_11d4_9f4b_00c04f79927c, xxDummy

Fields inherited from interface com.esri.arcgis.geodatabase.IQueryFilterDefinition

IID, IID90f3c7ca_30d5_454b_ab33_fb869991edfe, xxDummy

Fields inherited from interface com.esri.arcgis.system.IXMLSerialize

IID, IIDc8545045_6615_48e3_af27_52a0e5fc35e2, xxDummy

Constructor Summary

TemporalQueryFilter()
Constructs a TemporalQueryFilter using ArcGIS Engine.

TemporalQueryFilter(java.lang.Object obj)
Construct a TemporalQueryFilter using a reference to such an object returned from ArcGIS Engine or Server.

Method Summary

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.
java.lang.Object	convertToSupportedObject(int docVersion) Convert the object to another object that is supported.
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.
java.lang.Object	getEndingDate() Indicates the latest date included in the query.
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() Deprecated. Internal use only.
ISpatialReference	getOutputSpatialReference(java.lang.String fieldName) The spatial reference in which to output geometry for a given field.
java.lang.String	getPostfixClause() A clause that will be appended to the SELECT statement, following the where clause.
ITemporalOperator	getRelativeTimeOperator() The object that contains a relative time to offset the temporal values.
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.Object	getStartingDate() Indicates the earliest date included in the query.
java.lang.String	getSubFields() The comma delimited list of field names for the filter.
int	getTemporalConversion() The temporal conversion mode to use (if any) by the temporal query.
int	getTemporalOrder() Defines order in which temporal records are sorted.
int	getTemporalRelationship() The temporal relation used in the temporal query.
ITimeReference	getTimeReference() Defines data time reference.
java.lang.String	getWhereClause() The where clause for the filter.
int	hashCode() the hashcode for this object
void	interfaceSupportsErrorInfo(GUID riid) interfaceSupportsErrorInfo
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.
boolean	isSupportedAtVersion(int docVersion) Is this object valid at the given document version.
void	load(IStream pstm) load
void	readExternal(java.io.ObjectInput in)
void	release() Release a TemporalQueryFilter.
void	save(IStream pstm, int fClearDirty) save
void	serialize(IXMLSerializeData data) Serializes an object to XML.
void	setEndingDate(java.lang.Object pVal) Indicates the latest date included in the query.
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	setPostfixClause(java.lang.String clause) A clause that will be appended to the SELECT statement, following the where clause.
void	setRelativeTimeOperator(ITemporalOperator pVal) The object that contains a relative time to offset the temporal values.
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	setStartingDate(java.lang.Object pVal) Indicates the earliest date included in the query.
void	setSubFields(java.lang.String subFields) The comma delimited list of field names for the filter.
void	setTemporalConversion(int pVal) The temporal conversion mode to use (if any) by the temporal query.
void	setTemporalOrder(int pVal) Defines order in which temporal records are sorted.
void	setTemporalRelationship(int pVal) The temporal relation used in the temporal query.
void	setTimeReferenceByRef(ITimeReference timeReference) Defines data time reference.
void	setWhereClause(java.lang.String whereClause) The where clause for the filter.
void	writeExternal(java.io.ObjectOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

TemporalQueryFilter

public TemporalQueryFilter()
                    throws java.io.IOException,
                           java.net.UnknownHostException

Constructs a TemporalQueryFilter using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

TemporalQueryFilter

public TemporalQueryFilter(java.lang.Object obj)
                    throws java.io.IOException

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems TemporalQueryFilter theTemporalQueryFilter = (TemporalQueryFilter) obj;

Method Detail

getClsid

public static java.lang.String getClsid()

getClsid.

equals

public boolean equals(java.lang.Object o)

Compare this object with another

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

the hashcode for this object

Overrides:

hashCode in class java.lang.Object

getJintegraDispatch

public com.esri.arcgis.interop.Dispatch getJintegraDispatch()

Deprecated. Internal use only.

Specified by:

getJintegraDispatch in interface com.esri.arcgis.interop.RemoteObjRef

release

public void release()

Release a TemporalQueryFilter.

Specified by:

release in interface com.esri.arcgis.interop.RemoteObjRef

getTemporalOrder

public int getTemporalOrder()
                     throws java.io.IOException,
                            AutomationException

Defines order in which temporal records are sorted.

Specified by:

getTemporalOrder in interface ITemporalQueryFilter

Returns:

A com.esri.arcgis.geodatabaseextensions.enumTemporalOrder constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTemporalOrder

public void setTemporalOrder(int pVal)
                      throws java.io.IOException,
                             AutomationException

Defines order in which temporal records are sorted.

Specified by:

setTemporalOrder in interface ITemporalQueryFilter

Parameters:

pVal - A com.esri.arcgis.geodatabaseextensions.enumTemporalOrder constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTemporalRelationship

public int getTemporalRelationship()
                            throws java.io.IOException,
                                   AutomationException

The temporal relation used in the temporal query.

Specified by:

getTemporalRelationship in interface ITemporalQueryFilter

Returns:

A com.esri.arcgis.geodatabaseextensions.enumTemporalRelation constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTemporalRelationship

public void setTemporalRelationship(int pVal)
                             throws java.io.IOException,
                                    AutomationException

The temporal relation used in the temporal query.

Specified by:

setTemporalRelationship in interface ITemporalQueryFilter

Parameters:

pVal - A com.esri.arcgis.geodatabaseextensions.enumTemporalRelation constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getStartingDate

public java.lang.Object getStartingDate()
                                 throws java.io.IOException,
                                        AutomationException

Indicates the earliest date included in the query.

Specified by:

getStartingDate in interface ITemporalQueryFilter

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setStartingDate

public void setStartingDate(java.lang.Object pVal)
                     throws java.io.IOException,
                            AutomationException

Indicates the earliest date included in the query.

Specified by:

setStartingDate in interface ITemporalQueryFilter

Parameters:

pVal - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getEndingDate

public java.lang.Object getEndingDate()
                               throws java.io.IOException,
                                      AutomationException

Indicates the latest date included in the query.

Specified by:

getEndingDate in interface ITemporalQueryFilter

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setEndingDate

public void setEndingDate(java.lang.Object pVal)
                   throws java.io.IOException,
                          AutomationException

Indicates the latest date included in the query.

Specified by:

setEndingDate in interface ITemporalQueryFilter

Parameters:

pVal - A Variant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTemporalConversion

public int getTemporalConversion()
                          throws java.io.IOException,
                                 AutomationException

The temporal conversion mode to use (if any) by the temporal query.

Specified by:

getTemporalConversion in interface ITemporalQueryFilter

Returns:

A com.esri.arcgis.geodatabaseextensions.enumTemporalConversion constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTemporalConversion

public void setTemporalConversion(int pVal)
                           throws java.io.IOException,
                                  AutomationException

The temporal conversion mode to use (if any) by the temporal query.

Specified by:

setTemporalConversion in interface ITemporalQueryFilter

Parameters:

pVal - A com.esri.arcgis.geodatabaseextensions.enumTemporalConversion constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getRelativeTimeOperator

public ITemporalOperator getRelativeTimeOperator()
                                          throws java.io.IOException,
                                                 AutomationException

The object that contains a relative time to offset the temporal values.

Specified by:

getRelativeTimeOperator in interface ITemporalQueryFilter

Returns:

A reference to a com.esri.arcgis.geodatabaseextensions.ITemporalOperator

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setRelativeTimeOperator

public void setRelativeTimeOperator(ITemporalOperator pVal)
                             throws java.io.IOException,
                                    AutomationException

The object that contains a relative time to offset the temporal values.

Specified by:

setRelativeTimeOperator in interface ITemporalQueryFilter

Parameters:

pVal - A reference to a com.esri.arcgis.geodatabaseextensions.ITemporalOperator (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getTimeReference

public ITimeReference getTimeReference()
                                throws java.io.IOException,
                                       AutomationException

Defines data time reference.

Specified by:

getTimeReference in interface ITemporalQueryFilter2

Returns:

A reference to a com.esri.arcgis.system.ITimeReference

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setTimeReferenceByRef

public void setTimeReferenceByRef(ITimeReference timeReference)
                           throws java.io.IOException,
                                  AutomationException

Defines data time reference.

Specified by:

setTimeReferenceByRef in interface ITemporalQueryFilter2

Parameters:

timeReference - A reference to a com.esri.arcgis.system.ITimeReference (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSearchOrder

public int getSearchOrder()
                   throws java.io.IOException,
                          AutomationException

The search order used by the filter.

Specified by:

getSearchOrder in interface ISpatialFilter

Returns:

A com.esri.arcgis.geodatabase.esriSearchOrder constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSearchOrder

public void setSearchOrder(int order)
                    throws java.io.IOException,
                           AutomationException

The search order used by the filter.

Specified by:

setSearchOrder in interface ISpatialFilter

Parameters:

order - A com.esri.arcgis.geodatabase.esriSearchOrder constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSpatialRel

public int getSpatialRel()
                  throws java.io.IOException,
                         AutomationException

The spatial relationship checked by the filter.

Specified by:

getSpatialRel in interface ISpatialFilter

Returns:

A com.esri.arcgis.geodatabase.esriSpatialRelEnum constant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSpatialRel

public void setSpatialRel(int spatialRel)
                   throws java.io.IOException,
                          AutomationException

The spatial relationship checked by the filter.

Specified by:

setSpatialRel in interface ISpatialFilter

Parameters:

spatialRel - A com.esri.arcgis.geodatabase.esriSpatialRelEnum constant (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGeometry

public IGeometry getGeometry()
                      throws java.io.IOException,
                             AutomationException

The query geometry used to filter results.

Specified by:

getGeometry in interface ISpatialFilter

Returns:

A reference to a com.esri.arcgis.geometry.IGeometry

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGeometryByRef

public void setGeometryByRef(IGeometry geometry)
                      throws java.io.IOException,
                             AutomationException

The query geometry used to filter results.

Specified by:

setGeometryByRef in interface ISpatialFilter

Parameters:

geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGeometryExByRef

public void setGeometryExByRef(IGeometry geometry,
                               boolean rhs2)
                        throws java.io.IOException,
                               AutomationException

The query geometry used to filter results.

Specified by:

setGeometryExByRef in interface ISpatialFilter

Parameters:

geometry - A reference to a com.esri.arcgis.geometry.IGeometry (in)

rhs2 - The rhs2 (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isFilterOwnsGeometry

public boolean isFilterOwnsGeometry()
                             throws java.io.IOException,
                                    AutomationException

Indicates whether the filter owns the query geometry.

Specified by:

isFilterOwnsGeometry in interface ISpatialFilter

Returns:

The spatialFilterOwnsGeometry

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getGeometryField

public java.lang.String getGeometryField()
                                  throws java.io.IOException,
                                         AutomationException

The name of the Geometry field to which the filter applies.

Specified by:

getGeometryField in interface ISpatialFilter

Returns:

The geomField

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setGeometryField

public void setGeometryField(java.lang.String geomField)
                      throws java.io.IOException,
                             AutomationException

The name of the Geometry field to which the filter applies.

Specified by:

setGeometryField in interface ISpatialFilter

Parameters:

geomField - The geomField (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSpatialRelDescription

public java.lang.String getSpatialRelDescription()
                                          throws java.io.IOException,
                                                 AutomationException

The array elements which describe the spatial relation between the query geometry and the requested geometries. There are 9 chars in this string which can be either 'F', 'T' or '*'; e.g., TT*FFT***' represents CONTAIN.

Specified by:

getSpatialRelDescription in interface ISpatialFilter

Returns:

The spatialRelDescription

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSpatialRelDescription

public void setSpatialRelDescription(java.lang.String spatialRelDescription)
                              throws java.io.IOException,
                                     AutomationException

The array elements which describe the spatial relation between the query geometry and the requested geometries. There are 9 chars in this string which can be either 'F', 'T' or '*'; e.g., TT*FFT***' represents CONTAIN.

Specified by:

setSpatialRelDescription in interface ISpatialFilter

Parameters:

spatialRelDescription - The spatialRelDescription (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSubFields

public java.lang.String getSubFields()
                              throws java.io.IOException,
                                     AutomationException

The comma delimited list of field names for the filter.

Specified by:

getSubFields in interface IQueryFilter

Returns:

The subFields

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSubFields

public void setSubFields(java.lang.String subFields)
                  throws java.io.IOException,
                         AutomationException

The comma delimited list of field names for the filter.

Specified by:

setSubFields in interface IQueryFilter

Parameters:

subFields - The subFields (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

addField

public void addField(java.lang.String subField)
              throws java.io.IOException,
                     AutomationException

Appends a single field name to the list of sub-fields.

Specified by:

addField in interface IQueryFilter

Parameters:

subField - The subField (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getWhereClause

public java.lang.String getWhereClause()
                                throws java.io.IOException,
                                       AutomationException

The where clause for the filter.

Specified by:

getWhereClause in interface IQueryFilter

Returns:

The whereClause

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setWhereClause

public void setWhereClause(java.lang.String whereClause)
                    throws java.io.IOException,
                           AutomationException

The where clause for the filter.

Specified by:

setWhereClause in interface IQueryFilter

Parameters:

whereClause - The whereClause (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getOutputSpatialReference

public ISpatialReference getOutputSpatialReference(java.lang.String fieldName)
                                            throws java.io.IOException,
                                                   AutomationException

The spatial reference in which to output geometry for a given field.

Specified by:

getOutputSpatialReference in interface IQueryFilter

Parameters:

fieldName - The fieldName (in)

Returns:

A reference to a com.esri.arcgis.geometry.ISpatialReference

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setOutputSpatialReferenceByRef

public void setOutputSpatialReferenceByRef(java.lang.String fieldName,
                                           ISpatialReference outputSpatialReference)
                                    throws java.io.IOException,
                                           AutomationException

The spatial reference in which to output geometry for a given field.

Specified by:

setOutputSpatialReferenceByRef in interface IQueryFilter

Parameters:

fieldName - The fieldName (in)

outputSpatialReference - A reference to a com.esri.arcgis.geometry.ISpatialReference (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

esri_clone

public IClone esri_clone()
                  throws java.io.IOException,
                         AutomationException

Clones the receiver and assigns the result to *clone.

Specified by:

esri_clone in interface IClone

Returns:

A reference to a com.esri.arcgis.system.IClone

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

assign

public void assign(IClone src)
            throws java.io.IOException,
                   AutomationException

Assigns the properties of src to the receiver.

Specified by:

assign in interface IClone

Parameters:

src - A reference to a com.esri.arcgis.system.IClone (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isEqual

public boolean isEqual(IClone other)
                throws java.io.IOException,
                       AutomationException

Indicates if the receiver and other have the same properties.

Specified by:

isEqual in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The equal

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isIdentical

public boolean isIdentical(IClone other)
                    throws java.io.IOException,
                           AutomationException

Indicates if the receiver and other are the same object.

Specified by:

isIdentical in interface IClone

Parameters:

other - A reference to a com.esri.arcgis.system.IClone (in)

Returns:

The identical

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

interfaceSupportsErrorInfo

public void interfaceSupportsErrorInfo(GUID riid)
                                throws java.io.IOException,
                                       AutomationException

interfaceSupportsErrorInfo

Specified by:

interfaceSupportsErrorInfo in interface ISupportErrorInfo

Parameters:

riid - A Structure: com.esri.arcgis.support.ms.stdole.GUID (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getClassID

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

getClassID

Specified by:

getClassID in interface IPersist

Parameters:

pClassID - A Structure: com.esri.arcgis.support.ms.stdole.GUID (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isDirty

public void isDirty()
             throws java.io.IOException,
                    AutomationException

isDirty

Specified by:

isDirty in interface IPersistStream

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

load

public void load(IStream pstm)
          throws java.io.IOException,
                 AutomationException

load

Specified by:

load in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

save

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

save

Specified by:

save in interface IPersistStream

Parameters:

pstm - A reference to a com.esri.arcgis.system.IStream (in)

fClearDirty - The fClearDirty (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSizeMax

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

getSizeMax

Specified by:

getSizeMax in interface IPersistStream

Parameters:

pcbSize - A Structure: com.esri.arcgis.system._ULARGE_INTEGER (out: use single element array)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getSpatialResolution

public double getSpatialResolution()
                            throws java.io.IOException,
                                   AutomationException

The spatial resolution in which to output geometry.

Specified by:

getSpatialResolution in interface IQueryFilter2

Returns:

The resolution

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setSpatialResolution

public void setSpatialResolution(double resolution)
                          throws java.io.IOException,
                                 AutomationException

The spatial resolution in which to output geometry.

Specified by:

setSpatialResolution in interface IQueryFilter2

Parameters:

resolution - The resolution (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getPostfixClause

public java.lang.String getPostfixClause()
                                  throws java.io.IOException,
                                         AutomationException

A clause that will be appended to the SELECT statement, following the where clause. Most commonly used for clauses like ORDER BY.

Specified by:

getPostfixClause in interface IQueryFilterDefinition

Returns:

The clause

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setPostfixClause

public void setPostfixClause(java.lang.String clause)
                      throws java.io.IOException,
                             AutomationException

A clause that will be appended to the SELECT statement, following the where clause. Most commonly used for clauses like ORDER BY.

Specified by:

setPostfixClause in interface IQueryFilterDefinition

Parameters:

clause - The clause (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getFilterDefs

public IFilterDefs getFilterDefs()
                          throws java.io.IOException,
                                 AutomationException

The filter definitions specified for this query filter.

Specified by:

getFilterDefs in interface IQueryFilterDefinition

Returns:

A reference to a com.esri.arcgis.geodatabase.IFilterDefs

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

setFilterDefsByRef

public void setFilterDefsByRef(IFilterDefs filters)
                        throws java.io.IOException,
                               AutomationException

The filter definitions specified for this query filter.

Specified by:

setFilterDefsByRef in interface IQueryFilterDefinition

Parameters:

filters - A reference to a com.esri.arcgis.geodatabase.IFilterDefs (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

serialize

public void serialize(IXMLSerializeData data)
               throws java.io.IOException,
                      AutomationException

Serializes an object to XML.

Specified by:

serialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

deserialize

public void deserialize(IXMLSerializeData data)
                 throws java.io.IOException,
                        AutomationException

Deserializes an object from XML.

Specified by:

deserialize in interface IXMLSerialize

Parameters:

data - A reference to a com.esri.arcgis.system.IXMLSerializeData (in)

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

isSupportedAtVersion

public boolean isSupportedAtVersion(int docVersion)
                             throws java.io.IOException,
                                    AutomationException

Is this object valid at the given document version.

Remarks

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

Product Availability

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

Specified by:

isSupportedAtVersion in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

The supported

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

convertToSupportedObject

public java.lang.Object convertToSupportedObject(int docVersion)
                                          throws java.io.IOException,
                                                 AutomationException

Convert the object to another object that is supported.

Remarks

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

Product Availability

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

Specified by:

convertToSupportedObject in interface IDocumentVersionSupportGEN

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Returns:

A Variant

Throws:

java.io.IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

writeExternal

public void writeExternal(java.io.ObjectOutput out)
                   throws java.io.IOException

Specified by:

writeExternal in interface java.io.Externalizable

Throws:

java.io.IOException

readExternal

public void readExternal(java.io.ObjectInput in)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException

Specified by:

readExternal in interface java.io.Externalizable

Throws:

java.io.IOException

java.lang.ClassNotFoundException