marytts.util.io

Class BasenameList

java.lang.Object

marytts.util.io.BasenameList

public class BasenameList
extends Object

The BasenameList class produces and stores an alphabetically-sorted array of basenames issued from the .wav files present in a given directory.

Author:

sacha

Constructor Summary

Constructors

Constructor and Description
BasenameList() Default constructor for an empty list.
BasenameList(String fileName) This constructor loads the basename list from a random access file.
BasenameList(String[] str) Constructor from an array of strings.
BasenameList(String dirName, String extension) This constructor lists the .
BasenameList(String setFromDir, String setFromExt, Vector setVec) Default constructor from an existing vector and fields.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(String str) Adds a basename to the list.
void	add(String[] str) Adds an array of basenames to the list.
void	clear() Clear the list.
boolean	contains(BasenameList bnl) Check if the list contains another given one.
boolean	contains(String str) Check if the given basename is part of the list.
BasenameList	duplicate() Duplicates the list (i.e., emits an autonomous copy of it).
boolean	equals(BasenameList bnl) Check if two lists are equal.
String	getDir() An accessor for the original directory.
String	getExt() An accessor for the original extension.
int	getLength() An accessor for the list's length
String[]	getListAsArray() An accessor for the list of basenames, returned as an array of strings
Vector	getListAsVector() Another accessor for the list of basenames, returned as a vector of strings
String	getName(int i) Return a copy of the basename at index i.
boolean	hasChanged()
void	load(String fileName) Read the basenameList from a file
boolean	remove(BasenameList bnl) Removes a list from another list.
boolean	remove(String str) Removes a basename from the list, if it was present.
void	sort() Ensure that the list is alphabetically sorted.
BasenameList	subList(int fromIndex, int toIndex) Returns an autonomous sublist between fromIndex, inclusive, and toIndex, exclusive.
void	write(File file) Write the basenameList to a File.
void	write(String fileName) Write the basenameList to a file, identified by its name.

Methods inherited from class java.lang.Object

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

Constructor Detail

BasenameList

public BasenameList()

Default constructor for an empty list.

BasenameList

public BasenameList(String setFromDir,
            String setFromExt,
            Vector setVec)

Default constructor from an existing vector and fields.

Parameters:

setFromDir - setFromDir

setFromExt - setFromExt

setVec - setVec

BasenameList

public BasenameList(String[] str)

Constructor from an array of strings.

Parameters:

str - str

BasenameList

public BasenameList(String dirName,
            String extension)

This constructor lists the . extension files from directory dir, and initializes an an array with their list of alphabetically sorted basenames.

Parameters:

dirName - The name of the directory to list the files from.

extension - The extension of the files to list.

BasenameList

public BasenameList(String fileName)
             throws IOException

This constructor loads the basename list from a random access file.

Parameters:

fileName - The file to read from.

Throws:

IOException - IOException

Method Detail

write

public void write(String fileName)
           throws IOException

Write the basenameList to a file, identified by its name.

Parameters:

fileName - fileName

Throws:

IOException - IOException

write

public void write(File file)
           throws IOException

Write the basenameList to a File.

Parameters:

file - file

Throws:

IOException - IOException

load

public void load(String fileName)
          throws IOException

Read the basenameList from a file

Parameters:

fileName - fileName

Throws:

IOException - IOException

add

public void add(String str)

Adds a basename to the list.

Parameters:

str - str

add

public void add(String[] str)

Adds an array of basenames to the list.

Parameters:

str - str

remove

public boolean remove(String str)

Removes a basename from the list, if it was present.

Parameters:

str - The basename to remove.

Returns:

true if the list was containing the basename.

remove

public boolean remove(BasenameList bnl)

Removes a list from another list.

Parameters:

bnl - The basename list to remove.

Returns:

true if the list was containing any element of the list to remove.

duplicate

public BasenameList duplicate()

Duplicates the list (i.e., emits an autonomous copy of it).

Returns:

BasenameList (fromdir, fromext, (vector) (bList.clone)

subList

public BasenameList subList(int fromIndex,
                   int toIndex)

Returns an autonomous sublist between fromIndex, inclusive, and toIndex, exclusive.

Parameters:

fromIndex - fromIndex

toIndex - toIndex

Returns:

basenameList(this.fromDir, this.fromExt, subVec)

getListAsArray

public String[] getListAsArray()

An accessor for the list of basenames, returned as an array of strings

Returns:

string ret

getListAsVector

public Vector getListAsVector()

Another accessor for the list of basenames, returned as a vector of strings

Returns:

bList

getLength

public int getLength()

An accessor for the list's length

Returns:

bList.size

getDir

public String getDir()

An accessor for the original directory. Returns null if the original directory is undefined.

Returns:

fromDir

getExt

public String getExt()

An accessor for the original extension. Returns null if the original extension is undefined.

Returns:

fromExt

getName

public String getName(int i)

Return a copy of the basename at index i.

Parameters:

i - The index of the basename to consider.

Returns:

The corresponding basename.

contains

public boolean contains(String str)

Check if the given basename is part of the list.

Parameters:

str - The basename to check for.

Returns:

true if yes, false if no.

contains

public boolean contains(BasenameList bnl)

Check if the list contains another given one.

Parameters:

bnl - The list of basenames to check for.

Returns:

true if yes, false if no.

equals

public boolean equals(BasenameList bnl)

Check if two lists are equal.

Parameters:

bnl - The list of basenames to check for.

Returns:

true if yes, false if no.

sort

public void sort()

Ensure that the list is alphabetically sorted.

clear

public void clear()

Clear the list.

hasChanged

public boolean hasChanged()