io.scif

Class FilePattern

java.lang.Object

io.scif.FilePattern

public class FilePattern
extends Object

FilePattern is a collection of methods for handling file patterns, a way of succinctly representing a collection of files meant to be part of the same data series. Examples:

• C:\data\BillM\sdub<1-12>.pic
• C:\data\Kevin\80<01-59>0<2-3>.pic
• /data/Josiah/cell-Z<0-39>.C<0-1>.tiff

Author:

Curtis Rueden

Constructor Summary

Constructors

Constructor and Description
FilePattern(org.scijava.io.location.BrowsableLocation baseLoc, String pattern, org.scijava.io.handle.DataHandleService dataHandleService) Creates a pattern object for files with the given pattern string.
FilePattern(FilePatternService filePatternService, org.scijava.io.location.BrowsableLocation name, org.scijava.io.location.BrowsableLocation dir, org.scijava.io.handle.DataHandleService dataHandleService) Creates a pattern object using the given filename and directory path as a template.
FilePattern(FilePatternService filePatternService, org.scijava.io.location.BrowsableLocation file, org.scijava.io.handle.DataHandleService dataHandleService) Creates a pattern object using the given file as a template.

Method Summary

Modifier and Type	Method and Description
String	getBlock(int i) Gets the specified numerical block.
String[]	getBlocks() Gets each numerical block.
int[]	getCount()
String[][]	getElements()
String	getErrorMessage() Gets the file pattern error message, if any.
org.scijava.io.location.Location[]	getFiles() Gets a listing of all files matching the given file pattern.
String	getPattern() Gets the file pattern string.
String	getPrefix() Gets the pattern's text string before any numerical ranges.
String	getPrefix(int i) Gets the pattern's text string before the given numerical block.
String[]	getPrefixes() Gets the pattern's text string before each numerical block.
String	getSuffix() Gets the pattern's text string after all numerical ranges.
boolean	isRegex() Returns whether or not this pattern is a regular expression.
boolean	isValid() Gets whether the file pattern string is valid.

Methods inherited from class java.lang.Object

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

Constructor Detail

FilePattern

public FilePattern(FilePatternService filePatternService,
                   org.scijava.io.location.BrowsableLocation file,
                   org.scijava.io.handle.DataHandleService dataHandleService)
            throws IOException

Creates a pattern object using the given file as a template.

Throws:

IOException

FilePattern

public FilePattern(FilePatternService filePatternService,
                   org.scijava.io.location.BrowsableLocation name,
                   org.scijava.io.location.BrowsableLocation dir,
                   org.scijava.io.handle.DataHandleService dataHandleService)
            throws IOException

Creates a pattern object using the given filename and directory path as a template.

Throws:

IOException

FilePattern

public FilePattern(org.scijava.io.location.BrowsableLocation baseLoc,
                   String pattern,
                   org.scijava.io.handle.DataHandleService dataHandleService)
            throws IOException

Creates a pattern object for files with the given pattern string.

Throws:

IOException

Method Detail

isRegex

public boolean isRegex()

Returns whether or not this pattern is a regular expression.

getPattern

public String getPattern()

Gets the file pattern string.

isValid

public boolean isValid()

Gets whether the file pattern string is valid.

getErrorMessage

public String getErrorMessage()

Gets the file pattern error message, if any.

getFiles

public org.scijava.io.location.Location[] getFiles()

Gets a listing of all files matching the given file pattern.

getElements

public String[][] getElements()

getCount

public int[] getCount()

getBlock

public String getBlock(int i)

Gets the specified numerical block.

getBlocks

public String[] getBlocks()

Gets each numerical block.

getPrefix

public String getPrefix()

Gets the pattern's text string before any numerical ranges.

getSuffix

public String getSuffix()

Gets the pattern's text string after all numerical ranges.

getPrefix

public String getPrefix(int i)

Gets the pattern's text string before the given numerical block.

getPrefixes

public String[] getPrefixes()

Gets the pattern's text string before each numerical block.