org.hps.record.evio

Class EvioFileUtilities

java.lang.Object

org.hps.record.evio.EvioFileUtilities

public final class EvioFileUtilities
extends Object

A miscellaneous collection of EVIO file utility methods.

Author:

Jeremy McCormick, SLAC

Field Summary

Fields

Modifier and Type	Field and Description
private static Logger	LOGGER Initialize the logger.
private static long	MILLISECONDS Milliseconds constant for conversion to/from second.

Constructor Summary

Constructors

Modifier	Constructor and Description
private	EvioFileUtilities() Prevent class instantiation.

Method Summary

Modifier and Type	Method and Description
static Integer	getRunFromName(File file) Get the run number from the file name.
static Integer	getSequenceFromName(File file) Get the EVIO file sequence number, which is the number at the end of the file name.
static org.jlab.coda.jevio.EvioReader	open(File file) Open an EVIO file using an EvioReader in memory mapping mode.
static org.jlab.coda.jevio.EvioReader	open(File file, boolean sequential) Open an EVIO file, using the cached file path if necessary.
static org.jlab.coda.jevio.EvioReader	open(String path) Open an EVIO file from a path string.
static void	sortBySequence(List<File> evioFileList) Sort a list of EVIO files by their sequence numbers.

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

private static final Logger LOGGER

Initialize the logger.

MILLISECONDS

private static final long MILLISECONDS

Milliseconds constant for conversion to/from second.

See Also:

Constant Field Values

Constructor Detail

EvioFileUtilities

private EvioFileUtilities()

Prevent class instantiation.

Method Detail

getRunFromName

public static Integer getRunFromName(File file)

Get the run number from the file name.

Parameters:

file - the EVIO file

Returns:

the run number

Throws:

Exception - if there is a problem parsing out the run number

getSequenceFromName

public static Integer getSequenceFromName(File file)

Get the EVIO file sequence number, which is the number at the end of the file name.

Parameters:

file - the EVIO file

Returns:

the file's sequence number

Throws:

Exception - if there is an error parsing out the sequence number

open

public static org.jlab.coda.jevio.EvioReader open(File file)
                                           throws IOException,
                                                  org.jlab.coda.jevio.EvioException

Open an EVIO file using an EvioReader in memory mapping mode.

Parameters:

file - the EVIO file

Returns:

the new EvioReader for the file

Throws:

IOException - if there is an IO problem

org.jlab.coda.jevio.EvioException - if there is an error reading the EVIO data

open

public static org.jlab.coda.jevio.EvioReader open(File file,
                                                  boolean sequential)
                                           throws IOException,
                                                  org.jlab.coda.jevio.EvioException

Open an EVIO file, using the cached file path if necessary.

Parameters:

file - the EVIO file

sequential - true to enable sequential reading

Returns:

the new EvioReader for the file

Throws:

IOException - if there is an IO problem

org.jlab.coda.jevio.EvioException - if there is an error reading the EVIO data

open

public static org.jlab.coda.jevio.EvioReader open(String path)
                                           throws IOException,
                                                  org.jlab.coda.jevio.EvioException

Open an EVIO file from a path string.

Parameters:

path - the path string

Returns:

the new EvioReader for the file

Throws:

IOException - if there is an IO problem

org.jlab.coda.jevio.EvioException - if there is an error reading the EVIO data

sortBySequence

public static void sortBySequence(List<File> evioFileList)

Sort a list of EVIO files by their sequence numbers.

Parameters:

evioFileList - the list of files to sort