de.unikassel.android.sdcframework.data.independent
Class FileReferenceSampleData

Package class diagram package FileReferenceSampleData
java.lang.Object
  extended by de.unikassel.android.sdcframework.data.independent.AbstractSampleData
      extended by de.unikassel.android.sdcframework.data.independent.FileReferenceSampleData
All Implemented Interfaces:
SampleData, SerializableData

public final class FileReferenceSampleData
extends AbstractSampleData

The device specific sample data of a sensor device providing samples as binary data files in a related format.

See Also:
AudioDevice, AudioDeviceScanner

Field Summary
private  String file
          The file name and relative path
 
Constructor Summary
FileReferenceSampleData()
          Constructor
FileReferenceSampleData(FileReferenceSampleData sampleData)
          Constructor
 
Method Summary
 SampleData doClone()
          Method to clone sample data
 boolean equals(Object o)
           
 String getFile()
          Getter for the file
 String getRelatedData()
          Getter for related data
 void setFile(String file)
          Setter for the file
 void updateRelatedData(String fileName)
          Update method for related data ( used to update relative file location for transmitted samples )
 
Methods inherited from class de.unikassel.android.sdcframework.data.independent.AbstractSampleData
clone, toXML
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

file

private String file
The file name and relative path

Constructor Detail

FileReferenceSampleData

public FileReferenceSampleData()
Constructor


FileReferenceSampleData

public FileReferenceSampleData(FileReferenceSampleData sampleData)
Constructor

Parameters:
sampleData - the sample data to copy construct from
Method Detail

doClone

public final SampleData doClone()
Description copied from interface: SampleData
Method to clone sample data

Returns:
a copy of the sample data

equals

public final boolean equals(Object o)
Overrides:
equals in class Object

setFile

public final void setFile(String file)
Setter for the file

Parameters:
file - the path to the file

getFile

public final String getFile()
Getter for the file

Returns:
the file

getRelatedData

public final String getRelatedData()
Description copied from interface: SampleData
Getter for related data

Specified by:
getRelatedData in interface SampleData
Overrides:
getRelatedData in class AbstractSampleData
Returns:
the path to a related data file if existing, null otherwise

updateRelatedData

public final void updateRelatedData(String fileName)
Description copied from interface: SampleData
Update method for related data ( used to update relative file location for transmitted samples )

Specified by:
updateRelatedData in interface SampleData
Overrides:
updateRelatedData in class AbstractSampleData
Parameters:
fileName - the new filename