com.esri.arcgis.catalog
Class GxFileFilter

java.lang.Object
  extended by com.esri.arcgis.catalog.GxFileFilter
All Implemented Interfaces:
IGxFileFilter, com.esri.arcgis.interop.RemoteObjRef, IPersist, IPersistStream, Externalizable, Serializable

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

The catalog's file filter.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

See Also:
Serialized Form

Constructor Summary
GxFileFilter()
          Constructs a GxFileFilter using ArcGIS Engine.
GxFileFilter(Object obj)
          Deprecated. As of ArcGIS 9.2, replaced by normal Java casts.
GxFileFilter theGxFileFilter = (GxFileFilter) obj;
 
Method Summary
 void addFileType(String extension, String description, String filePathImage)
          Add the file type to the collection.
 void addIGxFileFilterEventsListener(IGxFileFilterEvents theListener)
          addIGxFileFilterEventsListener.
 void deleteFileType(int index)
          Remove the file type.
 boolean equals(Object o)
          Compare this object with another
 boolean filter(String filePath)
          Checks to see if the indicated file passes the filter.
 int findFileType(String extension)
          The index of the file type in the filter or -1.
 void getClassID(GUID[] pClassID)
          getClassID
static String getClsid()
          getClsid.
 void getFileType(int index, String[] extension, String[] description, 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.
 void getSizeMax(_ULARGE_INTEGER[] pcbSize)
          getSizeMax
 int hashCode()
          the hashcode for this object
 void isDirty()
          isDirty
 void load(IStream pstm)
          load
 void readExternal(ObjectInput in)
           
 void removeIGxFileFilterEventsListener(IGxFileFilterEvents theListener)
          removeIGxFileFilterEventsListener.
 void save(IStream pstm, int fClearDirty)
          save
 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

GxFileFilter

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

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

GxFileFilter

public GxFileFilter(Object obj)
             throws 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:
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

addIGxFileFilterEventsListener

public void addIGxFileFilterEventsListener(IGxFileFilterEvents theListener)
                                    throws IOException
addIGxFileFilterEventsListener. Listen to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.catalog.IGxFileFilterEvents interface.
Throws:
IOException - If there are communications problems.

removeIGxFileFilterEventsListener

public void removeIGxFileFilterEventsListener(IGxFileFilterEvents theListener)
                                       throws IOException
removeIGxFileFilterEventsListener. Stop listening to events generated by this class.

Parameters:
theListener - An object that implements the com.esri.arcgis.catalog.IGxFileFilterEvents interface.
Throws:
IOException - If there are communications problems.

filter

public boolean filter(String filePath)
               throws IOException,
                      AutomationException
Checks to see if the indicated file passes the filter.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
filter in interface IGxFileFilter
Parameters:
filePath - The filePath (in)
Returns:
The passesFilter
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

findFileType

public int findFileType(String extension)
                 throws IOException,
                        AutomationException
The index of the file type in the filter or -1.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
findFileType in interface IGxFileFilter
Parameters:
extension - The extension (in)
Returns:
The index
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFileTypeCount

public int getFileTypeCount()
                     throws IOException,
                            AutomationException
The number of file types for the filter.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
getFileTypeCount in interface IGxFileFilter
Returns:
The count
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

getFileType

public void getFileType(int index,
                        String[] extension,
                        String[] description,
                        String[] imageFile,
                        int[] smallBitmap,
                        int[] largeBitmap)
                 throws IOException,
                        AutomationException
Returns information on the file type at the specified index in the file filter.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

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:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

addFileType

public void addFileType(String extension,
                        String description,
                        String filePathImage)
                 throws IOException,
                        AutomationException
Add the file type to the collection.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
addFileType in interface IGxFileFilter
Parameters:
extension - The extension (in)
description - The description (in)
filePathImage - The filePathImage (in)
Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.

deleteFileType

public void deleteFileType(int index)
                    throws IOException,
                           AutomationException
Remove the file type.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Specified by:
deleteFileType in interface IGxFileFilter
Parameters:
index - The index (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.

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