loci.formats

Class FilePattern

java.lang.Object

loci.formats.FilePattern

public class FilePattern
extends java.lang.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

Source code:

Trac, Gitweb

Author:

Curtis Rueden ctrueden at wisc.edu

Constructor Summary

Constructors

Constructor and Description
FilePattern(Location file) Creates a pattern object using the given file as a template.
FilePattern(java.lang.String pattern) Creates a pattern object for files with the given pattern string.
FilePattern(java.lang.String name, java.lang.String dir) Creates a pattern object using the given filename and directory path as a template.

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	findPattern(java.io.File file) Identifies the group pattern from a given file within that group.
static java.lang.String	findPattern(Location file) Identifies the group pattern from a given file within that group.
static java.lang.String	findPattern(java.lang.String path) Identifies the group pattern from a given file within that group.
static java.lang.String	findPattern(java.lang.String[] names) Generate a pattern from a list of file names.
static java.lang.String	findPattern(java.lang.String name, java.lang.String dir) Identifies the group pattern from a given file within that group.
static java.lang.String	findPattern(java.lang.String name, java.lang.String dir, java.lang.String[] nameList) Identifies the group pattern from a given file within that group.
static java.lang.String	findPattern(java.lang.String name, java.lang.String dir, java.lang.String[] nameList, int[] excludeAxes) Identifies the group pattern from a given file within that group.
static java.lang.String[]	findSeriesPatterns(java.lang.String base)
static java.lang.String[]	findSeriesPatterns(java.lang.String base, java.lang.String dir, java.lang.String[] nameList)
java.lang.String	getBlock(int i) Gets the specified numerical block.
java.lang.String[]	getBlocks() Gets each numerical block.
int[]	getCount()
java.lang.String[][]	getElements()
java.lang.String	getErrorMessage() Gets the file pattern error message, if any.
java.lang.String[]	getFiles() Gets a listing of all files matching the given file pattern.
java.math.BigInteger[]	getFirst()
java.math.BigInteger[]	getLast()
java.lang.String	getPattern() Gets the file pattern string.
java.lang.String	getPrefix() Gets the pattern's text string before any numerical ranges.
java.lang.String	getPrefix(int i) Gets the pattern's text string before the given numerical block.
java.lang.String[]	getPrefixes() Gets the pattern's text string before each numerical block.
java.math.BigInteger[]	getStep()
java.lang.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.
static void	main(java.lang.String[] args) Method for testing file pattern logic.

Methods inherited from class java.lang.Object

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

Constructor Detail

FilePattern

public FilePattern(Location file)

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

FilePattern

public FilePattern(java.lang.String name,
           java.lang.String dir)

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

FilePattern

public FilePattern(java.lang.String pattern)

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

Method Detail

isRegex

public boolean isRegex()

Returns whether or not this pattern is a regular expression.

getPattern

public java.lang.String getPattern()

Gets the file pattern string.

isValid

public boolean isValid()

Gets whether the file pattern string is valid.

getErrorMessage

public java.lang.String getErrorMessage()

Gets the file pattern error message, if any.

getFiles

public java.lang.String[] getFiles()

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

getElements

public java.lang.String[][] getElements()

getCount

public int[] getCount()

getBlock

public java.lang.String getBlock(int i)

Gets the specified numerical block.

getBlocks

public java.lang.String[] getBlocks()

Gets each numerical block.

getPrefix

public java.lang.String getPrefix()

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

getSuffix

public java.lang.String getSuffix()

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

getPrefix

public java.lang.String getPrefix(int i)

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

getPrefixes

public java.lang.String[] getPrefixes()

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

findPattern

public static java.lang.String findPattern(java.lang.String path)

Identifies the group pattern from a given file within that group.

Parameters:

path - The file path to use as a template for the match.

findPattern

public static java.lang.String findPattern(Location file)

Identifies the group pattern from a given file within that group.

Parameters:

file - The file to use as a template for the match.

findPattern

public static java.lang.String findPattern(java.io.File file)

Identifies the group pattern from a given file within that group.

Parameters:

file - The file to use as a template for the match.

findPattern

public static java.lang.String findPattern(java.lang.String name,
                           java.lang.String dir)

Identifies the group pattern from a given file within that group.

Parameters:

name - The filename to use as a template for the match.

dir - The directory in which to search for matching files.

findPattern

public static java.lang.String findPattern(java.lang.String name,
                           java.lang.String dir,
                           java.lang.String[] nameList)

Identifies the group pattern from a given file within that group.

Parameters:

name - The filename to use as a template for the match.

dir - The directory prefix to use for matching files.

nameList - The names through which to search for matching files.

findPattern

public static java.lang.String findPattern(java.lang.String name,
                           java.lang.String dir,
                           java.lang.String[] nameList,
                           int[] excludeAxes)

Identifies the group pattern from a given file within that group.

Parameters:

name - The filename to use as a template for the match.

dir - The directory prefix to use for matching files.

nameList - The names through which to search for matching files.

excludeAxes - The list of axis types which should be excluded from the pattern.

findPattern

public static java.lang.String findPattern(java.lang.String[] names)

Generate a pattern from a list of file names. The pattern generated will be a regular expression. Currently assumes that all file names are in the same directory.

findSeriesPatterns

public static java.lang.String[] findSeriesPatterns(java.lang.String base)

findSeriesPatterns

public static java.lang.String[] findSeriesPatterns(java.lang.String base,
                                    java.lang.String dir,
                                    java.lang.String[] nameList)

main

public static void main(java.lang.String[] args)

Method for testing file pattern logic.

getFirst

public java.math.BigInteger[] getFirst()

getLast

public java.math.BigInteger[] getLast()

getStep

public java.math.BigInteger[] getStep()