com.emphysic.myriad.core.data.util

Class FileSniffer

java.lang.Object

com.emphysic.myriad.core.data.util.FileSniffer

All Implemented Interfaces:

Sniffer

public class FileSniffer
extends java.lang.Object
implements Sniffer

FileSniffer - reads Datasets from files

Constructor Summary

Constructors

Constructor and Description
FileSniffer() Default constructor - exhaustive search is disabled
FileSniffer(boolean exhaustive) Instantiate a new sniffer

Method Summary

Modifier and Type	Method and Description
void	addDICOMExtension(java.lang.String extension) Adds a DICOM file extension to the current case-insensitive set e.g.
void	addImageExtension(java.lang.String extension) Adds an image file extensions to the case-insensitive set e.g.
void	addTextExtension(java.lang.String extension) Adds a text file extension to the case-insensitive set e.g.
void	delDICOMExtension(java.lang.String extension) Removes a DICOM/DICONDE extension if present.
void	delImageExtension(java.lang.String extension) Removes an image file extension if present.
void	delTextExtension(java.lang.String extension) Removes a text file extension if present
java.util.Set<java.lang.String>	getDicomExtensions() Retrieves the current set of case-insensitive DICOM/DICONDE file extensions (no leading ".")
java.util.Set<java.lang.String>	getImageExtensions() Retrieves the current list of case-insensitive image file extensions (no leading ".")
java.util.Set<java.lang.String>	getTextExtensions() Retrieves current list of text file extensions (no leading ".")
boolean	isExhaustive() Whether an input file is read based on extension or by an exhaustive match.
static boolean	isText(java.io.File file) Attempts to determine whether a file consists of text or is binary.
static IODataset	read(java.io.File inputFile) Attempts to automatically identify the contents of the specified file.
static IODataset	read(java.io.File inputFile, boolean loadContents) Attempts to automatically identify the contents in the specified file.
DicomDataset	readAsDICOM(java.io.File inputFile) Reads a DICOM/DICONDE file.
ImageDataset	readAsImage(java.io.File inputFile) Reads an image.
TextDataset	readAsText(java.io.File inputFile) Reads a text file
void	setExhaustive(boolean exhaustive) Sets whether to perform exhaustive matching or not.
IODataset	sniff(java.io.File inputFile) Attempts to automatically return a Dataset from a supported file format.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileSniffer

public FileSniffer(boolean exhaustive)

Instantiate a new sniffer

Parameters:

exhaustive - whether to match by filename only (false) or to attempt every match (true).

FileSniffer

public FileSniffer()

Default constructor - exhaustive search is disabled

Method Detail

sniff

public IODataset sniff(java.io.File inputFile)
                throws java.io.IOException

Attempts to automatically return a Dataset from a supported file format. Initial search is conducted based on filename extension; if exhaustive search was enabled on instantiation it will also attempt to parse the file regardless of name.

Specified by:

sniff in interface Sniffer

Parameters:

inputFile - File to examine

Returns:

Dataset of the first matching type found, or null if a match couldn't be found.

Throws:

java.io.IOException - if an I/O error occurs

See Also:

exhaustive

read

public static IODataset read(java.io.File inputFile)
                      throws java.io.IOException

Attempts to automatically identify the contents of the specified file. Does not load the file contents i.e. use IODataset.read() to access.

Parameters:

inputFile - file to read

Returns:

IODataset instance, or null if the file couldn't be read

Throws:

java.io.IOException - if an error occurs

read

public static IODataset read(java.io.File inputFile,
                             boolean loadContents)
                      throws java.io.IOException

Attempts to automatically identify the contents in the specified file.

Parameters:

inputFile - file to read

loadContents - whether to load the contents (true) or just initialize (false)

Returns:

the dataset or null if unable to read

Throws:

java.io.IOException - if an error occurs

isText

public static boolean isText(java.io.File file)
                      throws java.io.IOException

Attempts to determine whether a file consists of text or is binary. Based on the approach detailed at http://stackoverflow.com/a/277568/151744 . Attempts to read the first four bytes for an initial check against known UTF headers, then falls back to reading the entire contents looking for non-ASCII characters.

Parameters:

file - file to examine

Returns:

true if the file appears to be text, false otherwise

Throws:

java.io.IOException - if an I/O error occurs

readAsText

public TextDataset readAsText(java.io.File inputFile)

Reads a text file

Parameters:

inputFile - file to read

Returns:

Dataset of contents, or null if the file couldn't be read

readAsImage

public ImageDataset readAsImage(java.io.File inputFile)

Reads an image.

Parameters:

inputFile - file to read

Returns:

Dataset of pixels, or null if the file couldn't be read

readAsDICOM

public DicomDataset readAsDICOM(java.io.File inputFile)

Reads a DICOM/DICONDE file.

Parameters:

inputFile - file to read

Returns:

Dataset or null if the file couldn't be read.

getTextExtensions

public java.util.Set<java.lang.String> getTextExtensions()

Retrieves current list of text file extensions (no leading ".")

Returns:

text file extensions

addTextExtension

public void addTextExtension(java.lang.String extension)

Adds a text file extension to the case-insensitive set e.g. addTextExtension("TXT").

Parameters:

extension - extension to add

delTextExtension

public void delTextExtension(java.lang.String extension)

Removes a text file extension if present

Parameters:

extension - extension to remove

getImageExtensions

public java.util.Set<java.lang.String> getImageExtensions()

Retrieves the current list of case-insensitive image file extensions (no leading ".")

Returns:

image file extensions

addImageExtension

public void addImageExtension(java.lang.String extension)

Adds an image file extensions to the case-insensitive set e.g. addImageExtension("JPEG").

Parameters:

extension - extension to add

delImageExtension

public void delImageExtension(java.lang.String extension)

Removes an image file extension if present.

Parameters:

extension - extension to remove

getDicomExtensions

public java.util.Set<java.lang.String> getDicomExtensions()

Retrieves the current set of case-insensitive DICOM/DICONDE file extensions (no leading ".")

Returns:

DICOM extensions

addDICOMExtension

public void addDICOMExtension(java.lang.String extension)

Adds a DICOM file extension to the current case-insensitive set e.g. addDICOMExtension("DCM")

Parameters:

extension - extension to add

delDICOMExtension

public void delDICOMExtension(java.lang.String extension)

Removes a DICOM/DICONDE extension if present.

Parameters:

extension - extension to remove

setExhaustive

public void setExhaustive(boolean exhaustive)

Sets whether to perform exhaustive matching or not.

Parameters:

exhaustive - false to rely on filename extension alone, or true to attempt to read the file regardless of extension.

isExhaustive

public boolean isExhaustive()

Whether an input file is read based on extension or by an exhaustive match.

Returns:

true if the file is read by exhaustive match, false if the file is read by extension alone