net.sourceforge.nite.meta.impl
Class NiteSignal

java.lang.Object
  net.sourceforge.nite.meta.impl.NiteSignal

All Implemented Interfaces:

NSignal

public class NiteSignal
extends java.lang.Object
implements NSignal

A signal as referred to in the metadata

Author:

jonathan

Field Summary

Fields inherited from interface net.sourceforge.nite.meta.NSignal

AGENT_SIGNAL, AUDIO_SIGNAL, INTERACTION_SIGNAL, VIDEO_SIGNAL

Constructor Summary

NiteSignal(NMetaData meta, int media, int type, java.lang.String name, java.lang.String format, java.lang.String extension, java.lang.String modifier)

Method Summary

java.lang.String	getExtension() returns the extension of the signal, without the "."
java.lang.String	getFilename(java.lang.String obsname, java.lang.String agentname) returns the full path and filename of the signal, given the current observation and agent names (agent name can be null for interaction signals of course)
java.lang.String	getFormat() returns the format of the signal.
int	getMediaType() getMediaType returns either VIDEO_SIGNAL or AUDIO_SIGNAL.
java.lang.String	getName() returns the name of the signal - used in file name
java.lang.String	getSignalPathModifier(java.lang.String observation) returns the path modifier, replacing 'observation' with the given observation name
int	getType() getType returns either INTERACTION_SIGNAL or AGENT_SIGNAL.

Methods inherited from class java.lang.Object

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

Constructor Detail

NiteSignal

public NiteSignal(NMetaData meta,
                  int media,
                  int type,
                  java.lang.String name,
                  java.lang.String format,
                  java.lang.String extension,
                  java.lang.String modifier)

Method Detail

getName

public java.lang.String getName()

returns the name of the signal - used in file name

Specified by:

getName in interface NSignal

getType

public int getType()

getType returns either INTERACTION_SIGNAL or AGENT_SIGNAL.

Specified by:

getType in interface NSignal

getMediaType

public int getMediaType()

getMediaType returns either VIDEO_SIGNAL or AUDIO_SIGNAL.

Specified by:

getMediaType in interface NSignal

getFormat

public java.lang.String getFormat()

returns the format of the signal. Returns an arbitrary string (whatever appears in the format attribute of the signal in the metadata file).

Specified by:

getFormat in interface NSignal

getExtension

public java.lang.String getExtension()

returns the extension of the signal, without the "."

Specified by:

getExtension in interface NSignal

getSignalPathModifier

public java.lang.String getSignalPathModifier(java.lang.String observation)

returns the path modifier, replacing 'observation' with the given observation name

Specified by:

getSignalPathModifier in interface NSignal

getFilename

public java.lang.String getFilename(java.lang.String obsname,
                                    java.lang.String agentname)

returns the full path and filename of the signal, given the current observation and agent names (agent name can be null for interaction signals of course)

Specified by:

getFilename in interface NSignal