io.github.msdk.datamodel

Class SimpleSample

java.lang.Object

io.github.msdk.datamodel.SimpleSample

All Implemented Interfaces:

Sample

public class SimpleSample
extends Object
implements Sample

Implementation of Sample

Constructor Summary

Constructors

Constructor and Description
SimpleSample(String name) Constructor for SimpleSample.
SimpleSample(String name, RawDataFile rawDataFile) Constructor for SimpleSample.

Method Summary

Modifier and Type	Method and Description
String	getName() getName.
File	getOriginalFile() Returns the original file name and path where the file was loaded from, or null if this file was created by MSDK.
RawDataFile	getRawDataFile() Returns a raw data file or null if this sample has no associated raw data.
void	setName(String name)
void	setOriginalFile(File originalFile)
void	setRawDataFile(RawDataFile rawDataFile)

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleSample

public SimpleSample(@Nonnull
                    String name)

Constructor for SimpleSample.

Parameters:

name - a String object.

SimpleSample

public SimpleSample(@Nonnull
                    String name,
                    @Nullable
                    RawDataFile rawDataFile)

Constructor for SimpleSample.

Parameters:

name - a String object.

rawDataFile - a RawDataFile object.

Method Detail

getName

@Nonnull
public String getName()

getName.

Specified by:

getName in interface Sample

Returns:

Short descriptive name

setName

public void setName(@Nonnull
                    String name)

Parameters:

name - a String object.

getRawDataFile

@Nullable
public RawDataFile getRawDataFile()

Returns a raw data file or null if this sample has no associated raw data.

Specified by:

getRawDataFile in interface Sample

Returns:

a RawDataFile object.

setRawDataFile

public void setRawDataFile(@Nullable
                           RawDataFile rawDataFile)

Parameters:

rawDataFile - a RawDataFile object.

getOriginalFile

@Nullable
public File getOriginalFile()

Returns the original file name and path where the file was loaded from, or null if this file was created by MSDK.

Specified by:

getOriginalFile in interface Sample

Returns:

Original filename and path.

setOriginalFile

public void setOriginalFile(@Nullable
                            File originalFile)

Parameters:

originalFile - a File object.