io.scif.services

Interface FilePatternService

All Superinterfaces:

Comparable<org.scijava.Prioritized>, org.scijava.Contextual, org.scijava.Disposable, org.scijava.plugin.HasPluginInfo, org.scijava.Identifiable, org.scijava.Initializable, org.scijava.Locatable, org.scijava.log.Logged, org.scijava.Prioritized, org.scijava.plugin.RichPlugin, SCIFIOService, org.scijava.plugin.SciJavaPlugin, org.scijava.service.Service, org.scijava.Versioned

All Known Implementing Classes:

DefaultFilePatternService

public interface FilePatternService
extends SCIFIOService

A collection of utility methods to facilitate FilePattern use.

Author:

Mark Hiner

See Also:

FilePattern

Method Summary

Modifier and Type	Method and Description
String[]	findImagePatterns(org.scijava.io.location.BrowsableLocation base) Finds the list of names matching the provided base and generates all patterns that match the list.
String[]	findImagePatterns(org.scijava.io.location.BrowsableLocation base, org.scijava.io.location.BrowsableLocation dir, Collection<org.scijava.io.location.BrowsableLocation> nameList) Generates a list of all the patterns that match the provided list of file names.
String	findPattern(org.scijava.io.location.BrowsableLocation file) Identifies the group pattern from a given file within that group.
String	findPattern(org.scijava.io.location.BrowsableLocation name, org.scijava.io.location.BrowsableLocation dir) Identifies the group pattern from a given file within that group.
String	findPattern(org.scijava.io.location.BrowsableLocation name, org.scijava.io.location.BrowsableLocation dir, Collection<org.scijava.io.location.BrowsableLocation> nameList) Identifies the group pattern from a given file within that group.
String	findPattern(org.scijava.io.location.BrowsableLocation name, org.scijava.io.location.BrowsableLocation dir, Collection<org.scijava.io.location.BrowsableLocation> nameList, int[] excludeAxes) Identifies the group pattern from a given file within that group.
String	findPattern(String path) Identifies the group pattern from a given file within that group.
String	findPattern(String[] names) Generate a pattern from a list of file names.

Methods inherited from interface org.scijava.service.Service

initialize, registerEventHandlers

Methods inherited from interface org.scijava.plugin.RichPlugin

getIdentifier, log

Methods inherited from interface org.scijava.Contextual

context, getContext, setContext

Methods inherited from interface org.scijava.Prioritized

compareTo, getPriority, setPriority

Methods inherited from interface org.scijava.plugin.HasPluginInfo

getInfo, setInfo

Methods inherited from interface org.scijava.Locatable

getLocation

Methods inherited from interface org.scijava.Versioned

getVersion

Methods inherited from interface org.scijava.Disposable

dispose

Method Detail

findPattern

String findPattern(String path)
            throws IOException

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

Parameters:

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

Throws:

IOException

findPattern

String findPattern(org.scijava.io.location.BrowsableLocation file)
            throws IOException

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

Parameters:

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

Throws:

IOException

findPattern

String findPattern(org.scijava.io.location.BrowsableLocation name,
                   org.scijava.io.location.BrowsableLocation dir)
            throws IOException

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.

Throws:

IOException

findPattern

String findPattern(org.scijava.io.location.BrowsableLocation name,
                   org.scijava.io.location.BrowsableLocation dir,
                   Collection<org.scijava.io.location.BrowsableLocation> 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

String findPattern(org.scijava.io.location.BrowsableLocation name,
                   org.scijava.io.location.BrowsableLocation dir,
                   Collection<org.scijava.io.location.BrowsableLocation> 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

String findPattern(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.

findImagePatterns

String[] findImagePatterns(org.scijava.io.location.BrowsableLocation base)
                    throws IOException

Finds the list of names matching the provided base and generates all patterns that match the list.

Throws:

IOException

findImagePatterns

String[] findImagePatterns(org.scijava.io.location.BrowsableLocation base,
                           org.scijava.io.location.BrowsableLocation dir,
                           Collection<org.scijava.io.location.BrowsableLocation> nameList)
                    throws IOException

Generates a list of all the patterns that match the provided list of file names.

Throws:

IOException