at.tuwien.ifs.somtoolbox.data.metadata

Class AudioVectorMetaData

java.lang.Object

at.tuwien.ifs.somtoolbox.data.metadata.AbstractVectorMetaData

at.tuwien.ifs.somtoolbox.data.metadata.AudioVectorMetaData

Direct Known Subclasses:

MP3VectorMetaData

public class AudioVectorMetaData
extends AbstractVectorMetaData

Field Summary

Fields

Modifier and Type	Field and Description
private java.io.File	audioFile
private java.lang.String	orig

Constructor Summary

Constructors

Constructor and Description
AudioVectorMetaData(java.io.File file, java.lang.String id)

Method Summary

Modifier and Type	Method and Description
protected static java.io.File	checkFileExistence(java.lang.String filename) Check if the file exists (absolut or with pre- and suffix)
static AudioVectorMetaData	createMetaData(java.io.File audioFile)
static AudioVectorMetaData	createMetaData(java.lang.String id, java.io.File audioFile)
java.io.File	getAudioFile() Get the file this MetaData is describing.
java.lang.String	getDisplayLabel() Returns a String to display on screen.
java.lang.String	getID() Return the unique ID of the Vector.
boolean	matches(java.util.regex.Pattern pattern) Tests if the vectors MetaData matches the given Pattern.
boolean	matches(java.lang.String pattern, boolean ignoreCase) Tests if the vector's MetaData matches the given pattern.
protected static java.lang.String	stripFileNamePreAndSuffix(java.lang.String filename)

Methods inherited from class at.tuwien.ifs.somtoolbox.data.metadata.AbstractVectorMetaData

createMetaData, equals, hashCode, matches, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

orig

private final java.lang.String orig

audioFile

private final java.io.File audioFile

Constructor Detail

AudioVectorMetaData

public AudioVectorMetaData(java.io.File file,
                           java.lang.String id)

Method Detail

checkFileExistence

protected static java.io.File checkFileExistence(java.lang.String filename)
                                          throws java.io.FileNotFoundException

Check if the file exists (absolut or with pre- and suffix)

Parameters:

filename - The filename

Returns:

the File

Throws:

java.io.FileNotFoundException - if the file does not exist.

See Also:

CommonSOMViewerStateData.fileNamePrefix, CommonSOMViewerStateData.fileNameSuffix

stripFileNamePreAndSuffix

protected static java.lang.String stripFileNamePreAndSuffix(java.lang.String filename)

getAudioFile

public java.io.File getAudioFile()

Get the file this MetaData is describing.

Returns:

the audioFile

getID

public java.lang.String getID()

Description copied from class: AbstractVectorMetaData

Return the unique ID of the Vector. (The name/label it is identified by)

Specified by:

getID in class AbstractVectorMetaData

Returns:

the ID-String

createMetaData

public static AudioVectorMetaData createMetaData(java.lang.String id,
                                                 java.io.File audioFile)
                                          throws java.io.FileNotFoundException

Throws:

java.io.FileNotFoundException

createMetaData

public static AudioVectorMetaData createMetaData(java.io.File audioFile)
                                          throws java.io.FileNotFoundException

Throws:

java.io.FileNotFoundException

getDisplayLabel

public java.lang.String getDisplayLabel()

Description copied from class: AbstractVectorMetaData

Returns a String to display on screen.

Specified by:

getDisplayLabel in class AbstractVectorMetaData

Returns:

the (Display)Label

matches

public boolean matches(java.util.regex.Pattern pattern)

Description copied from class: AbstractVectorMetaData

Tests if the vectors MetaData matches the given Pattern.

Specified by:

matches in class AbstractVectorMetaData

Parameters:

pattern - the Pattern to test.

Returns:

true if the pattern matches.

See Also:

AbstractVectorMetaData.matches(String)

matches

public boolean matches(java.lang.String pattern,
                       boolean ignoreCase)

Description copied from class: AbstractVectorMetaData

Tests if the vector's MetaData matches the given pattern. It is the vectors metadata's decision whether it wants to be found by the given Pattern or not and how to handle wildcards.

Specified by:

matches in class AbstractVectorMetaData

Parameters:

pattern - The pattern to match.

ignoreCase - set true to ignore case considerations.

Returns:

true if the pattern matches.

See Also:

AbstractVectorMetaData.matches(Pattern), AbstractVectorMetaData.matches(String)