io.scif.services

Class DefaultFilePatternService

java.lang.Object

org.scijava.AbstractContextual

org.scijava.plugin.AbstractRichPlugin

org.scijava.service.AbstractService

io.scif.services.DefaultFilePatternService

All Implemented Interfaces:

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

public class DefaultFilePatternService
extends org.scijava.service.AbstractService
implements FilePatternService

Default FilePatternService implementation.

Author:

Mark Hiner

See Also:

FilePatternService

Constructor Summary

Constructors

Constructor and Description
DefaultFilePatternService()

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> f) Identifies the group pattern from a given file within that group.
String	findPattern(org.scijava.io.location.BrowsableLocation file, 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 class org.scijava.service.AbstractService

getContext, setContext, toString

Methods inherited from class org.scijava.plugin.AbstractRichPlugin

getInfo, getPriority, setInfo, setPriority

Methods inherited from class org.scijava.AbstractContextual

context

Methods inherited from class java.lang.Object

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

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

Constructor Detail

DefaultFilePatternService

public DefaultFilePatternService()

Method Detail

findPattern

public String findPattern(String path)
                   throws IOException

Description copied from interface: FilePatternService

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

Specified by:

findPattern in interface FilePatternService

Parameters:

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

Throws:

IOException

findPattern

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

Description copied from interface: FilePatternService

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

Specified by:

findPattern in interface FilePatternService

Parameters:

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

Throws:

IOException

findPattern

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

Description copied from interface: FilePatternService

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

Specified by:

findPattern in interface FilePatternService

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

public String findPattern(org.scijava.io.location.BrowsableLocation name,
                          org.scijava.io.location.BrowsableLocation dir,
                          Collection<org.scijava.io.location.BrowsableLocation> f)

Description copied from interface: FilePatternService

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

Specified by:

findPattern in interface FilePatternService

Parameters:

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

dir - The directory prefix to use for matching files.

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

findPattern

public String findPattern(org.scijava.io.location.BrowsableLocation file,
                          org.scijava.io.location.BrowsableLocation dir,
                          Collection<org.scijava.io.location.BrowsableLocation> nameList,
                          int[] excludeAxes)

Description copied from interface: FilePatternService

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

Specified by:

findPattern in interface FilePatternService

Parameters:

file - 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 String findPattern(String[] names)

Description copied from interface: FilePatternService

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.

Specified by:

findPattern in interface FilePatternService

findImagePatterns

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

Description copied from interface: FilePatternService

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

Specified by:

findImagePatterns in interface FilePatternService

Throws:

IOException

findImagePatterns

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

Description copied from interface: FilePatternService

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

Specified by:

findImagePatterns in interface FilePatternService

Throws:

IOException