nz.ac.waikato.mcennis.rat.dataAquisition
Class ReadAudioFiles

java.lang.Object
  nz.ac.waikato.mcennis.rat.graph.model.ModelShell
      nz.ac.waikato.mcennis.rat.dataAquisition.ReadAudioFiles

All Implemented Interfaces:

Component, DataAquisition, Model

public class ReadAudioFiles
extends ModelShell
implements DataAquisition

FIXME: temporarily disabled to fix jAudio dependency Module for creating a set of song actors where the features extracted from the audio are added as weka Instance objects. A Instances object is added to the graph object without being tied to the inidividual Instance objects. Parameters are:

• Parameter AlgorithmClass:
  • Key for this data aquisition algorithms. Typically not changed.
  • String Object
  • max: 1
  • min: 1
  • Typically not altered
  • Default: FileReader
• Parameter Name:
  • Globally unique name for this data aquisition algorithm.
  • String Object
  • max: 1
  • min: 1
  • Default: FileReader
• Parameter Category:
  • Category of data aquisition algorithm
  • String Object
  • max: 1
  • min: 1
  • Typically not altered
  • Default: File Crawler
• Parameter Directory:
  • Directory LiveJournal FOAF's are stored in.
  • File Object
  • max: 1
  • min: 1
  • File must be a vailid directory.
  • Default: None
• Parameter SettingsFile:
  • XML file containing the configuration for running jAudio.
  • File Object
  • max: 1
  • min: 1
  • File must be a vailid XML file.
  • Default: settings.xml
• Parameter FeaturesFile:
  • XML file defining the features present in jAudio.
  • File Object
  • max: 1
  • min: 1
  • File must be a vailid XML file.
  • Default: features.xml
• Parameter Mode:
  • Mode of the actor node these audio files attach to.
  • String Object
  • max: 1
  • min: 1
  • Default: Song
• Parameter PropertyID:
  • ID for the property created on the given node.
  • String Object
  • max: 1
  • min: 1
  • Default: SongVector
• Parameter InstancesID:
  • Property ID for the master Instances object used for audio vector metadata. This property is stored on the root graph.
  • String Object
  • max: 1
  • min: 1
  • Default: Training

Field Summary

Fields inherited from class nz.ac.waikato.mcennis.rat.graph.model.ModelShell

listener

Constructor Summary

ReadAudioFiles()

Method Summary

void	cancel() Stop all collection at the end of the next entity (file, web-page, etc.)
protected void	createInstances(AggregatorContainer container)
Graph	get() Obtain a reference to the graph this object holds
java.util.List<IODescriptor>	getInputType() The input type describes all the different kinds of graph objects that are utilized (and hence required) by this object.
java.util.List<IODescriptor>	getOutputType() The output type describes all the different kinds of graph objects that are created during the execution of this algorithm.
Properties	getParameter() List of all parameters this component accepts.
Parameter	getParameter(java.lang.String param) Returns the specific parameter identified by its key-name.
void	init(Properties map) Parameters of this module: input: None output: {parameter:Mode} Type: Actor Description: node for this song instance {parameter:PropertyID} Type: Actor Property Mode: {parameter:Mode} Description: audio data vector {parameter:InstancesID} Type: Graph Property Graph: {root} Description: audio vector metadata
protected Batch	loadSettings(java.lang.Object[] settings)
ReadAudioFiles	prototype() All Components implement the prototype pattern.
void	set(Graph g) Set the graph to be populated by this object
void	start() Begin executing the data aquisition module

Methods inherited from class nz.ac.waikato.mcennis.rat.graph.model.ModelShell

addListener, fireChange

Methods inherited from class java.lang.Object

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

Methods inherited from interface nz.ac.waikato.mcennis.rat.graph.model.Model

addListener

Constructor Detail

ReadAudioFiles

public ReadAudioFiles()

Method Detail

start

public void start()

Description copied from interface: DataAquisition

Begin executing the data aquisition module

Specified by:

start in interface DataAquisition

loadSettings

protected Batch loadSettings(java.lang.Object[] settings)

createInstances

protected void createInstances(AggregatorContainer container)

set

public void set(Graph g)

Description copied from interface: DataAquisition

Set the graph to be populated by this object

Specified by:

set in interface DataAquisition

Parameters:

g - graph to be created for analysis

get

public Graph get()

Description copied from interface: DataAquisition

Obtain a reference to the graph this object holds

Specified by:

get in interface DataAquisition

Returns:

graph created by this object

cancel

public void cancel()

Description copied from interface: DataAquisition

Stop all collection at the end of the next entity (file, web-page, etc.)

Specified by:

cancel in interface DataAquisition

getInputType

public java.util.List<IODescriptor> getInputType()

Description copied from interface: Component

The input type describes all the different kinds of graph objects that are utilized (and hence required) by this object. This result is only guaranteed to be fixed if structural parameters are not modified. This is an empty array if there is no input.

Specified by:

getInputType in interface Component

Returns:

IODescriptor array for this component

See Also:

IODescriptor

getOutputType

public java.util.List<IODescriptor> getOutputType()

Description copied from interface: Component

The output type describes all the different kinds of graph objects that are created during the execution of this algorithm. The result is only guaranteed to be fixed if structural parameters are not modified. This is an empty array if there is no output.

Specified by:

getOutputType in interface Component

Returns:

IODescriptor array for this component

See Also:

IODescriptor

getParameter

public Properties getParameter()

Description copied from interface: Component

List of all parameters this component accepts. Each parameter also has a distinct key-name used when initializing the object using the init method. If there are no parameters, null is returned.

Specified by:

getParameter in interface Component

Returns:

read-only array of Parameters

getParameter

public Parameter getParameter(java.lang.String param)

Description copied from interface: Component

Returns the specific parameter identified by its key-name. If no parameter is found with this key-name, null is returned.

Specified by:

getParameter in interface Component

Parameters:

param - key-name of the parameter

Returns:

named parameter

init

public void init(Properties map)

Parameters of this module:

• input: None
• output:
  • {parameter:Mode}
    • Type: Actor
    • Description: node for this song instance
  • {parameter:PropertyID}
    • Type: Actor Property
    • Mode: {parameter:Mode}
    • Description: audio data vector
  • {parameter:InstancesID}
    • Type: Graph Property
    • Graph: {root}
    • Description: audio vector metadata

Specified by:

init in interface Component

Parameters:

map - properties to load - null is permitted.

prototype

public ReadAudioFiles prototype()

Description copied from interface: Component

All Components implement the prototype pattern. The new parameter has no common resources to the original that are not static resources o the class.

Specified by:

prototype in interface Component

Returns:

default-parameter version of the same class as the original.