com.esri.arcgis.catalog
Class GxFileFilter

java.lang.Object
  com.esri.arcgis.catalog.GxFileFilter

All Implemented Interfaces:

IGxFileFilter, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, java.io.Externalizable, java.io.Serializable

public class GxFileFilter
extends java.lang.Object
implements com.esri.arcgis.interop.RemoteObjRef, IGxFileFilter, IPersistStream, java.io.Externalizable

COM Class 'GxFileFilter'. Generated 3/19/2015 1:20:49 PM from 'C:\ArcGIS\COM\esriCatalog.olb'

Description 'The catalog's file 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.catalog.IGxFileFilter

IID, IIDbdbbb3f7_d0b2_11d1_aed9_080009ec734b, 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

Constructor Summary

GxFileFilter()
Constructs a GxFileFilter using ArcGIS Engine.

GxFileFilter(java.lang.Object obj)
Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GxFileFilter theGxFileFilter = (GxFileFilter) obj;

Method Summary

void	addFileType(java.lang.String extension, java.lang.String description, java.lang.String filePathImage) Add the file type to the collection.
void	addIGxFileFilterEventsListener(IGxFileFilterEvents theListener) addIGxFileFilterEventsListener.
void	deleteFileType(int index) Remove the file type.
boolean	equals(java.lang.Object o) Compare this object with another
boolean	filter(java.lang.String filePath) Checks to see if the indicated file passes the filter.
int	findFileType(java.lang.String extension) The index of the file type in the filter or -1.
void	getClassID(GUID[] pClassID) getClassID
static java.lang.String	getClsid() getClsid.
void	getFileType(int index, java.lang.String[] extension, java.lang.String[] description, java.lang.String[] imageFile, int[] smallBitmap, int[] largeBitmap) Returns information on the file type at the specified index in the file filter.
int	getFileTypeCount() The number of file types for the filter.
com.esri.arcgis.interop.Dispatch	getJintegraDispatch() Deprecated. Internal use only.
void	getSizeMax(_ULARGE_INTEGER[] pcbSize) getSizeMax
int	hashCode() the hashcode for this object
void	isDirty() isDirty
void	load(IStream pstm) load
void	readExternal(java.io.ObjectInput in)
void	release() Release a GxFileFilter.
void	removeIGxFileFilterEventsListener(IGxFileFilterEvents theListener) removeIGxFileFilterEventsListener.
void	save(IStream pstm, int fClearDirty) save
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

GxFileFilter

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

Constructs a GxFileFilter using ArcGIS Engine.

Throws:

java.io.IOException - if there are interop problems

java.net.UnknownHostException - if there are interop problems

GxFileFilter

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

Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GxFileFilter theGxFileFilter = (GxFileFilter) obj;

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

Parameters:

obj - an object returned from ArcGIS Engine or Server

Throws:

java.io.IOException - if there are interop problems

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

addIGxFileFilterEventsListener

public void addIGxFileFilterEventsListener(IGxFileFilterEvents theListener)
                                    throws java.io.IOException

addIGxFileFilterEventsListener. Listen to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.catalog.IGxFileFilterEvents interface.

Throws:

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

removeIGxFileFilterEventsListener

public void removeIGxFileFilterEventsListener(IGxFileFilterEvents theListener)
                                       throws java.io.IOException

removeIGxFileFilterEventsListener. Stop listening to events generated by this class.

Parameters:

theListener - An object that implements the com.esri.arcgis.catalog.IGxFileFilterEvents interface.

Throws:

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

release

public void release()

Release a GxFileFilter.

Specified by:

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

filter

public boolean filter(java.lang.String filePath)
               throws java.io.IOException,
                      AutomationException

Checks to see if the indicated file passes the filter.

Specified by:

filter in interface IGxFileFilter

Parameters:

filePath - The filePath (in)

Returns:

The passesFilter

Throws:

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

AutomationException - If the ArcObject component throws an exception.

findFileType

public int findFileType(java.lang.String extension)
                 throws java.io.IOException,
                        AutomationException

The index of the file type in the filter or -1.

Specified by:

findFileType in interface IGxFileFilter

Parameters:

extension - The extension (in)

Returns:

The index

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFileTypeCount

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

The number of file types for the filter.

Specified by:

getFileTypeCount in interface IGxFileFilter

Returns:

The count

Throws:

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

AutomationException - If the ArcObject component throws an exception.

getFileType

public void getFileType(int index,
                        java.lang.String[] extension,
                        java.lang.String[] description,
                        java.lang.String[] imageFile,
                        int[] smallBitmap,
                        int[] largeBitmap)
                 throws java.io.IOException,
                        AutomationException

Returns information on the file type at the specified index in the file filter.

Specified by:

getFileType in interface IGxFileFilter

Parameters:

index - The index (in)

extension - The extension (out: use single element array)

description - The description (out: use single element array)

imageFile - The imageFile (out: use single element array)

smallBitmap - The smallBitmap (A COM typedef) (out: use single element array)

largeBitmap - The largeBitmap (A COM typedef) (out: use single element array)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

addFileType

public void addFileType(java.lang.String extension,
                        java.lang.String description,
                        java.lang.String filePathImage)
                 throws java.io.IOException,
                        AutomationException

Add the file type to the collection.

Specified by:

addFileType in interface IGxFileFilter

Parameters:

extension - The extension (in)

description - The description (in)

filePathImage - The filePathImage (in)

Throws:

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

AutomationException - If the ArcObject component throws an exception.

deleteFileType

public void deleteFileType(int index)
                    throws java.io.IOException,
                           AutomationException

Remove the file type.

Specified by:

deleteFileType in interface IGxFileFilter

Parameters:

index - The index (in)

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.

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.

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