cytoscape.util
Class CyFileFilter

java.lang.Object
  javax.swing.filechooser.FileFilter
      cytoscape.util.CyFileFilter

All Implemented Interfaces:

FilenameFilter

Direct Known Subclasses:

GMLFileFilter, SIFFileFilter, XGMMLFileFilter

public class CyFileFilter
extends FileFilter
implements FilenameFilter

A convenience implementation of FileFilter that filters out all files except for those type extensions that it knows about.

Extensions are of the type ".foo", which is typically found on Windows and Unix boxes, but not on Macinthosh. Case is ignored.

Author:

Larissa Kamenkovich, Brad Kohlenberg

Constructor Summary

CyFileFilter()
Creates a file filter.

CyFileFilter(String extension)
Creates a file filter that accepts files with the given extension.

CyFileFilter(String[] filters)
Creates a file filter from the given string array.

CyFileFilter(String[] filters, String description)
Creates a file filter from the given string array and description.

CyFileFilter(String[] filters, String description, String nature)
Creates a file filter from the given string array and description.

CyFileFilter(String extension, String description)
Creates a file filter that accepts the given file type.

CyFileFilter(String extension, String description, String nature)
Creates a file filter that accepts the given file type.

Method Summary

boolean	accept(File f) Returns true if this class is capable of processing the specified file.
boolean	accept(File dir, String fileName) Returns true if this class is capable of processing the specified file.
boolean	accept(String fileName) Returns true if this class is capable of processing the specified file.
boolean	accept(URL url, String contentType) Returns true if this class is capable of processing the specified URL
void	addContentType(String type) Adds a content-type to filter against.
void	addExtension(String extension) Adds a filetype "dot" extension to filter against.
String	getDescription() Returns the human readable description of this filter.
String	getExtension(File f) Return the extension portion of the file's name.
String	getExtension(String filename) DOCUMENT ME!
Set	getExtensionSet() Returns the Set of file extension names.
String	getFileNature() Returns the nature of the file.
GraphReader	getReader(String fileName) Returns the reader.
GraphReader	getReader(URL url, URLConnection conn) Returns the reader.
boolean	isExtensionListInDescription() Returns whether the extension list (.jpg, .gif, etc) should show up in the human readable description.
void	setDescription(String description) Sets the human readable description of this filter.
void	setExtensionListInDescription(boolean b) Determines whether the extension list (.jpg, .gif, etc) should show up in the human readable description.
void	setFileNature(String nature) Sets the nature of the files for this filter.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CyFileFilter

public CyFileFilter()

Creates a file filter. If no filters are added, then all files are accepted.

See Also:

addExtension(java.lang.String)

CyFileFilter

public CyFileFilter(String extension)

Creates a file filter that accepts files with the given extension. Example: new ExampleFileFilter("jpg");

See Also:

addExtension(java.lang.String)

CyFileFilter

public CyFileFilter(String extension,
                    String description)

Creates a file filter that accepts the given file type. Example: new ExampleFileFilter("jpg", "JPEG Image Images");

Note that the "." before the extension is not needed. If provided, it will be ignored.

See Also:

addExtension(java.lang.String)

CyFileFilter

public CyFileFilter(String[] filters)

Creates a file filter from the given string array. Example: new ExampleFileFilter(String {"gif", "jpg"});

Note that the "." before the extension is not needed adn will be ignored.

See Also:

addExtension(java.lang.String)

CyFileFilter

public CyFileFilter(String[] filters,
                    String description)

Creates a file filter from the given string array and description. Example: new ExampleFileFilter(String {"gif", "jpg"}, "Gif and JPG Images");

Note that the "." before the extension is not needed and will be ignored.

See Also:

addExtension(java.lang.String)

CyFileFilter

public CyFileFilter(String extension,
                    String description,
                    String nature)

Creates a file filter that accepts the given file type. Example: new ExampleFileFilter("jpg", "JPEG Image Images");

Note that the "." before the extension is not needed. If provided, it will be ignored.

See Also:

addExtension(java.lang.String)

CyFileFilter

public CyFileFilter(String[] filters,
                    String description,
                    String nature)

Creates a file filter from the given string array and description. Example: new ExampleFileFilter(String {"gif", "jpg"}, "Gif and JPG Images");

Note that the "." before the extension is not needed and will be ignored.

See Also:

addExtension(java.lang.String)

Method Detail

accept

public boolean accept(File f)

Returns true if this class is capable of processing the specified file.

Specified by:

accept in class FileFilter

Parameters:

f - File

accept

public boolean accept(File dir,
                      String fileName)

Returns true if this class is capable of processing the specified file.

Specified by:

accept in interface FilenameFilter

Parameters:

dir - Directory.

fileName - File name.

accept

public boolean accept(String fileName)

Returns true if this class is capable of processing the specified file.

Parameters:

fileName - File name.

accept

public boolean accept(URL url,
                      String contentType)

Returns true if this class is capable of processing the specified URL

Parameters:

url - the URL

contentType - the content-type of the URL

getExtension

public String getExtension(File f)

Return the extension portion of the file's name.

See Also:

getExtension(java.io.File), FileFilter.accept(java.io.File)

getExtension

public String getExtension(String filename)

DOCUMENT ME!

Parameters:

filename - DOCUMENT ME!

Returns:

DOCUMENT ME!

addExtension

public void addExtension(String extension)

Adds a filetype "dot" extension to filter against.

For example: the following code will create a filter that filters out all files except those that end in ".jpg" and ".tif":

ExampleFileFilter filter = new ExampleFileFilter(); filter.addExtension("jpg"); filter.addExtension("tif");

Note that the "." before the extension is not needed and will be ignored.

addContentType

public void addContentType(String type)

Adds a content-type to filter against.

For example: the following code will create a filter that filters out all streams except those that are of type "text/xgmml+xml" and "text/xgmml":

ExampleFileFilter filter = new ExampleFileFilter(); filter.addContentType("text/xgmml+xml"); filter.addContentType("text/xgmml");

getDescription

public String getDescription()

Returns the human readable description of this filter. For example: "JPEG and GIF Image Files (*.jpg, *.gif)"

Specified by:

getDescription in class FileFilter

See Also:

setDescription, setExtensionListInDescription, isExtensionListInDescription, FileFilter.getDescription()

setDescription

public void setDescription(String description)

Sets the human readable description of this filter. For example: filter.setDescription("Gif and JPG Images");

See Also:

setDescription, setExtensionListInDescription, isExtensionListInDescription

setExtensionListInDescription

public void setExtensionListInDescription(boolean b)

Determines whether the extension list (.jpg, .gif, etc) should show up in the human readable description.

Only relevent if a description was provided in the constructor or using setDescription();

See Also:

getDescription, setDescription, isExtensionListInDescription

isExtensionListInDescription

public boolean isExtensionListInDescription()

Returns whether the extension list (.jpg, .gif, etc) should show up in the human readable description.

Only relevent if a description was provided in the constructor or using setDescription();

See Also:

getDescription, setDescription, setExtensionListInDescription

getExtensionSet

public Set getExtensionSet()

Returns the Set of file extension names.

getReader

public GraphReader getReader(String fileName)

Returns the reader. This should be overridden by file type subclasses.

getReader

public GraphReader getReader(URL url,
                             URLConnection conn)

Returns the reader. This should be overridden by file type subclasses.

getFileNature

public String getFileNature()

Returns the nature of the file. "Nature" refers to a grouping of file types. For instance, GML, XGMML, and SIF are all file formats that contain graphs, therefore they belong to the GRAPH_NATURE. This allows the ImportHandler to return all file types with the same nature.

setFileNature

public void setFileNature(String nature)

Sets the nature of the files for this filter. The files can be of the nature: Node, Edge, Graph, or Vizmap;

See Also:

setDescription, setExtensionListInDescription, isExtensionListInDescription