io.github.msdk.io.txt

Class TxtExportAlgorithm

java.lang.Object

io.github.msdk.io.txt.TxtExportAlgorithm

public class TxtExportAlgorithm
extends Object

A class containing methods to export MsSpectrum objects to string representations or files.

Constructor Summary

Constructors

Constructor and Description
TxtExportAlgorithm()

Method Summary

Modifier and Type	Method and Description
static void	exportSpectra(File exportFile, Collection<MsSpectrum> spectra) Export one or more spectra to a file.
static void	exportSpectra(File exportFile, Collection<MsSpectrum> spectra, String delimiter) Export one or more spectra to a file.
static void	exportSpectrum(File exportFile, MsSpectrum spectrum) Export a single spectrum to a file.
static String	spectrumToString(MsSpectrum spectrum) Export a spectrum to a string.
static String	spectrumToString(MsSpectrum spectrum, String delimiter) Export a spectrum to a string.
static void	spectrumToWriter(MsSpectrum spectrum, Writer writer) Export a spectrum to a writer.
static void	spectrumToWriter(MsSpectrum spectrum, Writer writer, String delimiter) Export a spectrum to a writer.

Methods inherited from class java.lang.Object

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

Constructor Detail

TxtExportAlgorithm

public TxtExportAlgorithm()

Method Detail

exportSpectrum

public static void exportSpectrum(@Nonnull
                                  File exportFile,
                                  @Nonnull
                                  MsSpectrum spectrum)
                           throws IOException

Export a single spectrum to a file.

Parameters:

exportFile - a File object.

spectrum - a MsSpectrum object.

Throws:

IOException - if any.

exportSpectra

public static void exportSpectra(@Nonnull
                                 File exportFile,
                                 @Nonnull
                                 Collection<MsSpectrum> spectra)
                          throws IOException

Export one or more spectra to a file. A single space is used as the delimiter.

Parameters:

exportFile - a File object.

spectra - a Collection object.

Throws:

IOException - if any.

exportSpectra

public static void exportSpectra(@Nonnull
                                 File exportFile,
                                 @Nonnull
                                 Collection<MsSpectrum> spectra,
                                 @Nonnull
                                 String delimiter)
                          throws IOException

Export one or more spectra to a file.

Parameters:

exportFile - a File object.

spectra - a Collection object.

delimiter - a String object.

Throws:

IOException - if any.

spectrumToWriter

public static void spectrumToWriter(@Nonnull
                                    MsSpectrum spectrum,
                                    @Nonnull
                                    Writer writer)
                             throws IOException

Export a spectrum to a writer. A single space is used as the delimiter.

Parameters:

spectrum - a MsSpectrum object.

writer - a Writer object.

Throws:

IOException - if any.

spectrumToWriter

public static void spectrumToWriter(@Nonnull
                                    MsSpectrum spectrum,
                                    @Nonnull
                                    Writer writer,
                                    @Nonnull
                                    String delimiter)
                             throws IOException

Export a spectrum to a writer.

Parameters:

spectrum - a MsSpectrum object.

writer - a Writer object.

delimiter - a object.

Throws:

IOException - if any.

spectrumToString

@Nonnull
public static String spectrumToString(@Nonnull
                                               MsSpectrum spectrum)

Export a spectrum to a string. Uses a StringWriter object.

A single space is used as the delimiter.

Parameters:

spectrum - a MsSpectrum object.

Returns:

a String object.

spectrumToString

@Nonnull
public static String spectrumToString(@Nonnull
                                               MsSpectrum spectrum,
                                               @Nonnull
                                               String delimiter)

Export a spectrum to a string. Uses a StringWriter object.

Parameters:

spectrum - a MsSpectrum object.

delimiter - a String object.

Returns:

a String object.