RDFFeatureWriter Class Reference

#include <RDFFeatureWriter.h>

Inheritance diagram for RDFFeatureWriter:

Collaboration diagram for RDFFeatureWriter:

Public Types
typedef vector< Parameter >	ParameterList

Public Member Functions
	RDFFeatureWriter ()
virtual	~RDFFeatureWriter ()
virtual ParameterList	getSupportedParameters () const
virtual void	setParameters (map< string, string > &params)
virtual void	setTrackMetadata (QString trackid, TrackMetadata metadata)
virtual void	write (QString trackid, const Transform &transform, const Vamp::Plugin::OutputDescriptor &output, const Vamp::Plugin::FeatureList &features, std::string summaryType="")
virtual void	setFixedEventTypeURI (QString uri)
virtual void	finish ()
virtual QString	getWriterTag () const
virtual void	testOutputFile (QString trackId, TransformId transformId)
	Throw FailedToOpenOutputStream if we can already tell that we will be unable to write to the output file. More...
virtual void	flush ()

Protected Types
enum	FileWriteSupport { SupportOneFilePerTrackTransform = 1, SupportOneFilePerTrack = 2, SupportOneFileTotal = 4 }
typedef pair< QString, TransformId >	TrackTransformPair
typedef map< TrackTransformPair, QFile * >	FileMap
typedef map< QFile *, QTextStream * >	FileStreamMap

Protected Member Functions
QTextStream *	getOutputStream (QString, TransformId)
QString	getOutputFilename (QString, TransformId)
QFile *	getOutputFile (QString, TransformId)

Protected Attributes
FileMap	m_files
FileStreamMap	m_streams
QTextStream *	m_prevstream
int	m_support
QString	m_extension
QString	m_baseDir
bool	m_manyFiles
QString	m_singleFileName
bool	m_stdout
bool	m_append
bool	m_force

Private Types
typedef map< QString, PluginRDFDescription >	RDFDescriptionMap
typedef map< QString, TrackMetadata >	TrackMetadataMap
typedef pair< QString, Transform >	StringTransformPair
typedef pair< QTextStream *, QString >	StreamBuffer

Private Member Functions
virtual void	reviewFileForAppending (QString filename)
void	writePrefixes (QTextStream *)
void	writeSignalDescription (QTextStream *, QString)
void	writeLocalFeatureTypes (QTextStream *, const Transform &, const Vamp::Plugin::OutputDescriptor &, PluginRDFDescription &, std::string summaryType)
void	writeSparseRDF (QTextStream *stream, const Transform &transform, const Vamp::Plugin::OutputDescriptor &output, const Vamp::Plugin::FeatureList &features, PluginRDFDescription &desc, QString timelineURI)
void	writeTrackLevelRDF (QTextStream *stream, const Transform &transform, const Vamp::Plugin::OutputDescriptor &output, const Vamp::Plugin::FeatureList &features, PluginRDFDescription &desc, QString signalURI)
void	writeDenseRDF (QTextStream *stream, const Transform &transform, const Vamp::Plugin::OutputDescriptor &output, const Vamp::Plugin::FeatureList &features, PluginRDFDescription &desc, QString signalURI, QString timelineURI)

Private Attributes
RDFDescriptionMap	m_rdfDescriptions
TrackMetadataMap	m_metadata
QString	m_fixedEventTypeURI
set< QString >	m_startedTrackIds
map< QTextStream *, set< Transform > >	m_startedStreamTransforms
map< QString, QString >	m_trackTrackURIs
map< QString, QString >	m_trackTimelineURIs
map< QString, QString >	m_trackSignalURIs
map< Transform, QString >	m_transformURIs
map< Transform, QString >	m_syntheticEventTypeURIs
map< Transform, QString >	m_syntheticSignalTypeURIs
map< StringTransformPair, StreamBuffer >	m_openDenseFeatures
QString	m_userAudioFileUri
QString	m_userTrackUri
QString	m_userMakerUri
bool	m_plain
bool	m_network
bool	m_networkRetrieved
long	m_count

Detailed Description

Definition at line 41 of file RDFFeatureWriter.h.

Member Typedef Documentation

RDFDescriptionMap

typedef map<QString, PluginRDFDescription> RDFFeatureWriter::RDFDescriptionMap

private

Definition at line 65 of file RDFFeatureWriter.h.

TrackMetadataMap

typedef map<QString, TrackMetadata> RDFFeatureWriter::TrackMetadataMap

private

Definition at line 68 of file RDFFeatureWriter.h.

StringTransformPair

typedef pair<QString, Transform> RDFFeatureWriter::StringTransformPair

private

Definition at line 117 of file RDFFeatureWriter.h.

StreamBuffer

typedef pair<QTextStream *, QString> RDFFeatureWriter::StreamBuffer

private

Definition at line 118 of file RDFFeatureWriter.h.

TrackTransformPair

typedef pair<QString, TransformId> FileFeatureWriter::TrackTransformPair

protectedinherited

Definition at line 59 of file FileFeatureWriter.h.

FileMap

typedef map<TrackTransformPair, QFile *> FileFeatureWriter::FileMap

protectedinherited

Definition at line 60 of file FileFeatureWriter.h.

FileStreamMap

typedef map<QFile *, QTextStream *> FileFeatureWriter::FileStreamMap

protectedinherited

Definition at line 61 of file FileFeatureWriter.h.

ParameterList

typedef vector<Parameter> FeatureWriter::ParameterList

inherited

Definition at line 47 of file FeatureWriter.h.

Member Enumeration Documentation

FileWriteSupport

enum FileFeatureWriter::FileWriteSupport

protectedinherited

Enumerator
SupportOneFilePerTrackTransform
SupportOneFilePerTrack
SupportOneFileTotal

Definition at line 50 of file FileFeatureWriter.h.

Constructor & Destructor Documentation

RDFFeatureWriter()

RDFFeatureWriter::RDFFeatureWriter

(

)

Definition at line 36 of file RDFFeatureWriter.cpp.

~RDFFeatureWriter()

RDFFeatureWriter::~RDFFeatureWriter ( )

virtual

Definition at line 48 of file RDFFeatureWriter.cpp.

Member Function Documentation

getSupportedParameters()

RDFFeatureWriter::ParameterList RDFFeatureWriter::getSupportedParameters ( ) const

virtual

Reimplemented from FileFeatureWriter.

Definition at line 53 of file RDFFeatureWriter.cpp.

References FeatureWriter::Parameter::description, FileFeatureWriter::getSupportedParameters(), FeatureWriter::Parameter::hasArg, and FeatureWriter::Parameter::name.

setParameters()

void RDFFeatureWriter::setParameters ( map< string, string > &  params )

virtual

Reimplemented from FileFeatureWriter.

Definition at line 87 of file RDFFeatureWriter.cpp.

References m_network, m_plain, m_userAudioFileUri, m_userMakerUri, m_userTrackUri, and FileFeatureWriter::setParameters().

Referenced by RDFExporter::RDFExporter().

setTrackMetadata()

void RDFFeatureWriter::setTrackMetadata ( QString  trackid, TrackMetadata  metadata  )

virtual

Reimplemented from FeatureWriter.

Definition at line 112 of file RDFFeatureWriter.cpp.

References m_metadata.

write()

void RDFFeatureWriter::write ( QString  trackid, const Transform &  transform, const Vamp::Plugin::OutputDescriptor &  output, const Vamp::Plugin::FeatureList &  features, std::string  summaryType = ""  )

virtual

Implements FeatureWriter.

Definition at line 126 of file RDFFeatureWriter.cpp.

References Transform::getIdentifier(), PluginRDFIndexer::getInstance(), FileFeatureWriter::getOutputStream(), Transform::getPluginIdentifier(), PluginRDFIndexer::indexConfiguredURLs(), m_network, m_networkRetrieved, m_plain, m_rdfDescriptions, FileFeatureWriter::m_singleFileName, m_startedStreamTransforms, m_startedTrackIds, FileFeatureWriter::m_stdout, m_trackSignalURIs, m_trackTimelineURIs, PluginRDFDescription::OutputDense, PluginRDFDescription::OutputTrackLevel, writeDenseRDF(), writeLocalFeatureTypes(), writePrefixes(), writeSignalDescription(), writeSparseRDF(), and writeTrackLevelRDF().

Referenced by RDFExporter::write().

setFixedEventTypeURI()

void RDFFeatureWriter::setFixedEventTypeURI ( QString  uri )

virtual

Definition at line 120 of file RDFFeatureWriter.cpp.

References m_fixedEventTypeURI.

Referenced by RDFExporter::write().

finish()

void RDFFeatureWriter::finish ( )

virtual

Reimplemented from FileFeatureWriter.

Definition at line 769 of file RDFFeatureWriter.cpp.

References FileFeatureWriter::finish(), m_openDenseFeatures, and m_startedStreamTransforms.

getWriterTag()

virtual QString RDFFeatureWriter::getWriterTag ( ) const

inlinevirtual

Implements FeatureWriter.

Definition at line 62 of file RDFFeatureWriter.h.

reviewFileForAppending()

void RDFFeatureWriter::reviewFileForAppending ( QString  filename )

privatevirtual

Reimplemented from FileFeatureWriter.

Definition at line 259 of file RDFFeatureWriter.cpp.

References m_count.

writePrefixes()

void RDFFeatureWriter::writePrefixes ( QTextStream *  sptr )

private

Definition at line 241 of file RDFFeatureWriter.cpp.

Referenced by write().

writeSignalDescription()

void RDFFeatureWriter::writeSignalDescription ( QTextStream *  sptr, QString  trackId  )

private

Definition at line 293 of file RDFFeatureWriter.cpp.

References m_count, m_metadata, m_trackSignalURIs, m_trackTimelineURIs, m_trackTrackURIs, m_userAudioFileUri, m_userMakerUri, m_userTrackUri, FeatureWriter::TrackMetadata::maker, and FeatureWriter::TrackMetadata::title.

Referenced by write().

writeLocalFeatureTypes()

void RDFFeatureWriter::writeLocalFeatureTypes ( QTextStream *  , const Transform &  , const Vamp::Plugin::OutputDescriptor &  , PluginRDFDescription &  , std::string  summaryType  )

private

!! bin names, extents and so on can be written out using e.g. vamp:bin_names ( "a" "b" "c" )

Definition at line 398 of file RDFFeatureWriter.cpp.

References Transform::getIdentifier(), PluginRDFDescription::getOutputDisposition(), PluginRDFDescription::getOutputEventTypeURI(), PluginRDFDescription::getOutputFeatureAttributeURI(), PluginRDFDescription::getOutputSignalTypeURI(), m_count, m_fixedEventTypeURI, m_plain, m_syntheticEventTypeURIs, m_syntheticSignalTypeURIs, m_transformURIs, PluginRDFDescription::OutputDense, PluginRDFDescription::OutputTrackLevel, and RDFTransformFactory::writeTransformToRDF().

Referenced by write().

writeSparseRDF()

void RDFFeatureWriter::writeSparseRDF ( QTextStream *  stream, const Transform &  transform, const Vamp::Plugin::OutputDescriptor &  output, const Vamp::Plugin::FeatureList &  features, PluginRDFDescription &  desc, QString  timelineURI  )

private

!! named bins?

Definition at line 519 of file RDFFeatureWriter.cpp.

References Transform::getIdentifier(), PluginRDFDescription::getOutputEventTypeURI(), PluginRDFDescription::haveDescription(), m_count, m_fixedEventTypeURI, m_plain, m_syntheticEventTypeURIs, and m_transformURIs.

Referenced by write().

writeTrackLevelRDF()

void RDFFeatureWriter::writeTrackLevelRDF ( QTextStream *  stream, const Transform &  transform, const Vamp::Plugin::OutputDescriptor &  output, const Vamp::Plugin::FeatureList &  features, PluginRDFDescription &  desc, QString  signalURI  )

private

Definition at line 611 of file RDFFeatureWriter.cpp.

References PluginRDFDescription::getOutputFeatureAttributeURI(), and SVDEBUG.

Referenced by write().

writeDenseRDF()

void RDFFeatureWriter::writeDenseRDF ( QTextStream *  stream, const Transform &  transform, const Vamp::Plugin::OutputDescriptor &  output, const Vamp::Plugin::FeatureList &  features, PluginRDFDescription &  desc, QString  signalURI, QString  timelineURI  )

private

Definition at line 651 of file RDFFeatureWriter.cpp.

References Transform::getBlockSize(), Transform::getDuration(), Transform::getIdentifier(), PluginRDFDescription::getOutputSignalTypeURI(), Transform::getSampleRate(), Transform::getStartTime(), Transform::getStepSize(), PluginRDFDescription::haveDescription(), m_count, m_openDenseFeatures, m_plain, m_syntheticSignalTypeURIs, m_transformURIs, and RealTime::realTime2Frame().

Referenced by write().

testOutputFile()

void FileFeatureWriter::testOutputFile ( QString  , TransformId    )

virtualinherited

Throw FailedToOpenOutputStream if we can already tell that we will be unable to write to the output file.

This is called to test the output stream before processing begins. The writer may legitimately succeed here but still fail later – this is really an optimisation to ensure that easy-to-recognise failure cases fail early.

Reimplemented from FeatureWriter.

Definition at line 227 of file FileFeatureWriter.cpp.

References FileFeatureWriter::getOutputFilename(), FileFeatureWriter::m_singleFileName, and FileFeatureWriter::m_stdout.

flush()

void FileFeatureWriter::flush ( )

virtualinherited

Reimplemented from FeatureWriter.

Definition at line 321 of file FileFeatureWriter.cpp.

References FileFeatureWriter::m_prevstream.

getOutputStream()

QTextStream * FileFeatureWriter::getOutputStream ( QString  trackId, TransformId  transformId  )

protectedinherited

Definition at line 293 of file FileFeatureWriter.cpp.

References FileFeatureWriter::getOutputFile(), FileFeatureWriter::m_prevstream, FileFeatureWriter::m_stdout, and FileFeatureWriter::m_streams.

Referenced by CSVFeatureWriter::write(), and write().

getOutputFilename()

QString FileFeatureWriter::getOutputFilename ( QString  trackId, TransformId  transformId  )

protectedinherited

Definition at line 168 of file FileFeatureWriter.cpp.

References FeatureWriter::getWriterTag(), FileFeatureWriter::m_append, FileFeatureWriter::m_baseDir, FileFeatureWriter::m_extension, FileFeatureWriter::m_force, FileFeatureWriter::m_manyFiles, FileFeatureWriter::m_singleFileName, FileFeatureWriter::m_stdout, and SVDEBUG.

Referenced by FileFeatureWriter::getOutputFile(), and FileFeatureWriter::testOutputFile().

getOutputFile()

QFile * FileFeatureWriter::getOutputFile ( QString  trackId, TransformId  transformId  )

protectedinherited

Definition at line 245 of file FileFeatureWriter.cpp.

References FileFeatureWriter::getOutputFilename(), FileFeatureWriter::m_append, FileFeatureWriter::m_files, FileFeatureWriter::m_manyFiles, FileFeatureWriter::m_singleFileName, FileFeatureWriter::reviewFileForAppending(), and SVDEBUG.

Referenced by FileFeatureWriter::getOutputStream().

Member Data Documentation

m_rdfDescriptions

RDFDescriptionMap RDFFeatureWriter::m_rdfDescriptions

private

Definition at line 66 of file RDFFeatureWriter.h.

Referenced by write().

m_metadata

TrackMetadataMap RDFFeatureWriter::m_metadata

private

Definition at line 69 of file RDFFeatureWriter.h.

Referenced by setTrackMetadata(), and writeSignalDescription().

m_fixedEventTypeURI

QString RDFFeatureWriter::m_fixedEventTypeURI

private

Definition at line 71 of file RDFFeatureWriter.h.

Referenced by setFixedEventTypeURI(), writeLocalFeatureTypes(), and writeSparseRDF().

m_startedTrackIds

set<QString> RDFFeatureWriter::m_startedTrackIds

private

Definition at line 105 of file RDFFeatureWriter.h.

Referenced by write().

m_startedStreamTransforms

map<QTextStream *, set<Transform> > RDFFeatureWriter::m_startedStreamTransforms

private

Definition at line 107 of file RDFFeatureWriter.h.

Referenced by finish(), and write().

m_trackTrackURIs

map<QString, QString> RDFFeatureWriter::m_trackTrackURIs

private

Definition at line 109 of file RDFFeatureWriter.h.

Referenced by writeSignalDescription().

m_trackTimelineURIs

map<QString, QString> RDFFeatureWriter::m_trackTimelineURIs

private

Definition at line 110 of file RDFFeatureWriter.h.

Referenced by write(), and writeSignalDescription().

m_trackSignalURIs

map<QString, QString> RDFFeatureWriter::m_trackSignalURIs

private

Definition at line 111 of file RDFFeatureWriter.h.

Referenced by write(), and writeSignalDescription().

m_transformURIs

map<Transform, QString> RDFFeatureWriter::m_transformURIs

private

Definition at line 113 of file RDFFeatureWriter.h.

Referenced by writeDenseRDF(), writeLocalFeatureTypes(), and writeSparseRDF().

m_syntheticEventTypeURIs

map<Transform, QString> RDFFeatureWriter::m_syntheticEventTypeURIs

private

Definition at line 114 of file RDFFeatureWriter.h.

Referenced by writeLocalFeatureTypes(), and writeSparseRDF().

m_syntheticSignalTypeURIs

map<Transform, QString> RDFFeatureWriter::m_syntheticSignalTypeURIs

private

Definition at line 115 of file RDFFeatureWriter.h.

Referenced by writeDenseRDF(), and writeLocalFeatureTypes().

m_openDenseFeatures

map<StringTransformPair, StreamBuffer> RDFFeatureWriter::m_openDenseFeatures

private

Definition at line 119 of file RDFFeatureWriter.h.

Referenced by finish(), and writeDenseRDF().

m_userAudioFileUri

QString RDFFeatureWriter::m_userAudioFileUri

private

Definition at line 120 of file RDFFeatureWriter.h.

Referenced by setParameters(), and writeSignalDescription().

m_userTrackUri

QString RDFFeatureWriter::m_userTrackUri

private

Definition at line 121 of file RDFFeatureWriter.h.

Referenced by setParameters(), and writeSignalDescription().

m_userMakerUri

QString RDFFeatureWriter::m_userMakerUri

private

Definition at line 122 of file RDFFeatureWriter.h.

Referenced by setParameters(), and writeSignalDescription().

m_plain

bool RDFFeatureWriter::m_plain

private

Definition at line 124 of file RDFFeatureWriter.h.

Referenced by setParameters(), write(), writeDenseRDF(), writeLocalFeatureTypes(), and writeSparseRDF().

m_network

bool RDFFeatureWriter::m_network

private

Definition at line 126 of file RDFFeatureWriter.h.

Referenced by setParameters(), and write().

m_networkRetrieved

bool RDFFeatureWriter::m_networkRetrieved

private

Definition at line 127 of file RDFFeatureWriter.h.

Referenced by write().

m_count

long RDFFeatureWriter::m_count

private

Definition at line 129 of file RDFFeatureWriter.h.

Referenced by reviewFileForAppending(), writeDenseRDF(), writeLocalFeatureTypes(), writeSignalDescription(), and writeSparseRDF().

m_files

FileMap FileFeatureWriter::m_files

protectedinherited

Definition at line 62 of file FileFeatureWriter.h.

Referenced by FileFeatureWriter::finish(), FileFeatureWriter::getOutputFile(), and FileFeatureWriter::~FileFeatureWriter().

m_streams

FileStreamMap FileFeatureWriter::m_streams

protectedinherited

Definition at line 63 of file FileFeatureWriter.h.

Referenced by FileFeatureWriter::finish(), FileFeatureWriter::getOutputStream(), and FileFeatureWriter::~FileFeatureWriter().

m_prevstream

QTextStream* FileFeatureWriter::m_prevstream

protectedinherited

Definition at line 64 of file FileFeatureWriter.h.

Referenced by FileFeatureWriter::finish(), FileFeatureWriter::flush(), and FileFeatureWriter::getOutputStream().

m_support

int FileFeatureWriter::m_support

protectedinherited

Definition at line 72 of file FileFeatureWriter.h.

Referenced by FileFeatureWriter::FileFeatureWriter(), FileFeatureWriter::getSupportedParameters(), and FileFeatureWriter::setParameters().

m_extension

QString FileFeatureWriter::m_extension

protectedinherited

Definition at line 73 of file FileFeatureWriter.h.

Referenced by FileFeatureWriter::FileFeatureWriter(), and FileFeatureWriter::getOutputFilename().

m_baseDir

QString FileFeatureWriter::m_baseDir

protectedinherited

Definition at line 74 of file FileFeatureWriter.h.

Referenced by FileFeatureWriter::getOutputFilename(), and FileFeatureWriter::setParameters().

m_manyFiles

bool FileFeatureWriter::m_manyFiles

protectedinherited

Definition at line 75 of file FileFeatureWriter.h.

Referenced by FileFeatureWriter::FileFeatureWriter(), FileFeatureWriter::getOutputFile(), FileFeatureWriter::getOutputFilename(), and FileFeatureWriter::setParameters().

m_singleFileName

QString FileFeatureWriter::m_singleFileName

protectedinherited

Definition at line 76 of file FileFeatureWriter.h.

Referenced by FileFeatureWriter::FileFeatureWriter(), FileFeatureWriter::finish(), FileFeatureWriter::getOutputFile(), FileFeatureWriter::getOutputFilename(), FileFeatureWriter::setParameters(), FileFeatureWriter::testOutputFile(), CSVFeatureWriter::write(), and write().

m_stdout

bool FileFeatureWriter::m_stdout

protectedinherited

Definition at line 77 of file FileFeatureWriter.h.

Referenced by FileFeatureWriter::finish(), FileFeatureWriter::getOutputFilename(), FileFeatureWriter::getOutputStream(), FileFeatureWriter::setParameters(), FileFeatureWriter::testOutputFile(), CSVFeatureWriter::write(), and write().

m_append

bool FileFeatureWriter::m_append

protectedinherited

Definition at line 78 of file FileFeatureWriter.h.

Referenced by FileFeatureWriter::getOutputFile(), FileFeatureWriter::getOutputFilename(), and FileFeatureWriter::setParameters().

m_force

bool FileFeatureWriter::m_force

protectedinherited

Definition at line 79 of file FileFeatureWriter.h.

Referenced by FileFeatureWriter::getOutputFilename(), and FileFeatureWriter::setParameters().

---

The documentation for this class was generated from the following files:

• RDFFeatureWriter.h
• RDFFeatureWriter.cpp