DefaultFileFilter (HDFView 2.14)

Object
- FileFilter
- - hdf.view.DefaultFileFilter

```
public class DefaultFileFilter
extends FileFilter
```
A convenience implementation of FileFilter that filters out all files except for those type extensions that it knows about.

Version:

2.4 9/6/2007

Author:

Peter X. Cao

Constructor Summary

Constructors
Constructor and Description
`DefaultFileFilter()` Creates a file filter.
`DefaultFileFilter(String extension)` Creates a file filter that accepts files with the given extension.
`DefaultFileFilter(String[] filters)` Creates a file filter from the given string array.
`DefaultFileFilter(String[] filters, String description)` Creates a file filter from the given string array and description.
`DefaultFileFilter(String extension, String description)` Creates a file filter that accepts the given file type.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`accept(File f)` Return true if this file should be shown in the directory pane, false if it shouldn't.
`void`	`addExtension(String extension)` Adds a filetype "dot" extension to filter against.
`String`	`getDescription()`
`String`	`getExtension(File f)` Return the extension portion of the file's name.
`static FileFilter`	`getFileFilter()`
`static FileFilter`	`getFileFilterBinary()`
`static FileFilter`	`getFileFilterBMP()`
`static FileFilter`	`getFileFilterGIF()`
`static FileFilter`	`getFileFilterHDF4()`
`static FileFilter`	`getFileFilterHDF5()`
`static FileFilter`	`getFileFilterJPEG()`
`static FileFilter`	`getFileFilterPNG()`
`static FileFilter`	`getFileFilterText()`
`static FileFilter`	`getFileFilterTIFF()`
`static byte[]`	`getHDF5UserBlock(String filename)` Read HDF5 user block data into byte array.
`static FileFilter`	`getImageFileFilter()`
`boolean`	`isExtensionListInDescription()`
`static boolean`	`isHDF4(String filename)` look at the first 4 bytes of the file to see if it is an HDF4 file.
`static boolean`	`isHDF5(String filename)` look at the first 8 bytes of the file to see if it is an HDF5 file.
`static boolean`	`isNetcdf(String filename)` look at the first 4 bytes of the file to see if it is a netCDF file byte[0]=67, byte[1]=68, byte[2]=70, byte[3]=1 or
`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.
`static boolean`	`setHDF5UserBlock(String fin, String fout, byte[] buf)` Write HDF5 user block data into byte array.

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DefaultFileFilter
```
public DefaultFileFilter()
```
    Creates a file filter. If no filters are added, then all files are accepted.
    
    See Also:
    
    addExtension(java.lang.String)
  - DefaultFileFilter
```
public DefaultFileFilter(String extension)
```
    Creates a file filter that accepts files with the given extension. Example: new DefaultFileFilter("jpg");
    
    Parameters:
    
    extension - the file extension to filter on
    
    See Also:
    
    addExtension(java.lang.String)
  - DefaultFileFilter
```
public DefaultFileFilter(String extension,
                         String description)
```
    Creates a file filter that accepts the given file type. Example: new DefaultFileFilter("jpg", "JPEG Image Images"); Note that the "." before the extension is not needed. If provided, it will be ignored.
    
    Parameters:
    
    extension - the file extension to filter on
    
    description - the file extension full description
    
    See Also:
    
    addExtension(java.lang.String)
  - DefaultFileFilter
```
public DefaultFileFilter(String[] filters)
```
    Creates a file filter from the given string array. Example: new DefaultFileFilter(String {"gif", "jpg"}); Note that the "." before the extension is not needed and will be ignored.
    
    Parameters:
    
    filters - the list of filter names
    
    See Also:
    
    addExtension(java.lang.String)
  - DefaultFileFilter
```
public DefaultFileFilter(String[] filters,
                         String description)
```
    Creates a file filter from the given string array and description. Example: new DefaultFileFilter(String {"gif", "jpg"}, "Gif and JPG Images"); Note that the "." before the extension is not needed and will be ignored.
    
    Parameters:
    
    filters - the list of filter names
    
    description - the name of the filter list
    
    See Also:
    
    addExtension(java.lang.String)
- Method Detail
  - accept
```
public boolean accept(File f)
```
    Return true if this file should be shown in the directory pane, false if it shouldn't. Files that begin with "." are ignored.
    
    Specified by:
    
    accept in class FileFilter
    
    See Also:
    
    getExtension(java.io.File)
  - getExtension
```
public String getExtension(File f)
```
    Return the extension portion of the file's name.
    
    Parameters:
    
    f - The file to get the extension portion of the name for
    
    Returns:
    
    The extension portion of the given file's name
    
    See Also:
    
    getExtension(java.io.File), FileFilter.accept(java.io.File)
  - 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": DefaultFileFilter filter = new DefaultFileFilter(); filter.addExtension("jpg"); filter.addExtension("tif"); or filter.addExtension("jpg, tif"); Note that the "." before the extension is not needed and will be ignored.
    
    Parameters:
    
    extension - the file extension to add to the file filter
  - getDescription
```
public String getDescription()
```
    Specified by:
    
    getDescription in class FileFilter
    
    Returns:
    
    the human readable description of this filter. For example: "JPEG and GIF Image Files (*.jpg, *.gif)"
  - setDescription
```
public void setDescription(String description)
```
    Sets the human readable description of this filter. For example: filter.setDescription("Gif and JPG Images");
    
    Parameters:
    
    description - the full description of the file filter
  - 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();
    
    Parameters:
    
    b - the show state of the extension list
  - 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();
  - getFileFilter
```
public static FileFilter getFileFilter()
```
    Returns:
    
    a file filter for HDF4/5 file.
  - getFileFilterHDF4
```
public static FileFilter getFileFilterHDF4()
```
    Returns:
    
    s file filter for HDF4 file.
  - getFileFilterHDF5
```
public static FileFilter getFileFilterHDF5()
```
    Returns:
    
    a file filter for HDF5 file.
  - getFileFilterJPEG
```
public static FileFilter getFileFilterJPEG()
```
    Returns:
    
    a file filter for JPEG image files.
  - getFileFilterTIFF
```
public static FileFilter getFileFilterTIFF()
```
    Returns:
    
    a file filter for TIFF image files.
  - getFileFilterPNG
```
public static FileFilter getFileFilterPNG()
```
    Returns:
    
    a file filter for PNG image files.
  - getFileFilterBMP
```
public static FileFilter getFileFilterBMP()
```
    Returns:
    
    a file filter for BMP image files.
  - getFileFilterGIF
```
public static FileFilter getFileFilterGIF()
```
    Returns:
    
    a file filter for GIF image files.
  - getImageFileFilter
```
public static FileFilter getImageFileFilter()
```
    Returns:
    
    a file filter for GIF, JPEG, BMP, or PNG image files.
  - getFileFilterText
```
public static FileFilter getFileFilterText()
```
    Returns:
    
    a file filter for text file.
  - getFileFilterBinary
```
public static FileFilter getFileFilterBinary()
```
    Returns:
    
    a file filter for binary file.
  - isHDF4
```
public static boolean isHDF4(String filename)
```
    look at the first 4 bytes of the file to see if it is an HDF4 file. byte[0]=14, byte[1]=3, byte[2]=19, byte[3]=1 or if it is a netCDF file byte[0]=67, byte[1]=68, byte[2]=70, byte[3]=1 or
    
    Parameters:
    
    filename - The name of the file to check
    
    Returns:
    
    true if the specified file is an HDF4 file; false otherwise
  - isHDF5
```
public static boolean isHDF5(String filename)
```
    look at the first 8 bytes of the file to see if it is an HDF5 file. byte[0]=-199 which is 137 in unsigned byte, byte[1]=72, byte[2]=68, byte[3]=70, byte[4]=13, byte[5]=10, byte[6]=26, byte[7]=10
    
    Parameters:
    
    filename - The name of the file to check
    
    Returns:
    
    true if the specified file is an HDF5 file; false otherwise
  - isNetcdf
```
public static boolean isNetcdf(String filename)
```
    look at the first 4 bytes of the file to see if it is a netCDF file byte[0]=67, byte[1]=68, byte[2]=70, byte[3]=1 or
    
    Parameters:
    
    filename - The name of the file to check
    
    Returns:
    
    true if the specified file is a NetCDF file; false otherwise
  - getHDF5UserBlock
```
public static byte[] getHDF5UserBlock(String filename)
```
    Read HDF5 user block data into byte array.
    
    Parameters:
    
    filename - The name of the file to read the HDF5 user block from
    
    Returns:
    
    a byte array of user block, or null if there is user data.
  - setHDF5UserBlock
```
public static boolean setHDF5UserBlock(String fin,
                                       String fout,
                                       byte[] buf)
```
    Write HDF5 user block data into byte array.
    
    Parameters:
    
    fin - The name of the file to copy to the output file
    
    fout - The name of the file to write HDF5 user block data to
    
    buf - The HDF5 user block data to write into the output file
    
    Returns:
    
    a byte array of user block, or null if there is user data.

Class DefaultFileFilter

Constructor Summary

Method Summary

Methods inherited from class Object

Constructor Detail

DefaultFileFilter

DefaultFileFilter

DefaultFileFilter

DefaultFileFilter

DefaultFileFilter

Method Detail

accept

getExtension

addExtension

getDescription

setDescription

setExtensionListInDescription

isExtensionListInDescription

getFileFilter

getFileFilterHDF4

getFileFilterHDF5

getFileFilterJPEG

getFileFilterTIFF

getFileFilterPNG

getFileFilterBMP

getFileFilterGIF

getImageFileFilter

getFileFilterText

getFileFilterBinary

isHDF4

isHDF5

isNetcdf

getHDF5UserBlock

setHDF5UserBlock