Class ParamHistoryManager

java.lang.Object

ca.phon.script.params.history.ParamHistoryManager

Direct Known Subclasses:

QueryHistoryManager

public class ParamHistoryManager
extends Object

Manager for ParamHistoryType objects. This method provides the application logic for the generated JAXB classes. Methods in this class should be used for manipulating ParamHistoryTypes.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ParamHistoryManager.EventType	Event types
static class	ParamHistoryManager.ParamHistoryEvent
static interface	ParamHistoryManager.ParamHistoryListener

Constructor Summary

Constructors

Constructor	Description
ParamHistoryManager(ParamHistoryType paramHistory)
ParamHistoryManager(File paramHistoryFile)
ParamHistoryManager(InputStream inputStream)

Method Summary

Modifier and Type	Method	Description
void	addParamHistoryListener(ParamHistoryManager.ParamHistoryListener listener)
ParamSetType	addParamSet(ParamSetType paramSet)	Add the given param set.
ParamSetType	addParamSet(ScriptParameters params)
ParamSetType	addParamSet(PhonScript script)
void	fireParamHistoryEvent(ParamHistoryManager.ParamHistoryEvent event)
void	fireParamSetAdded(ParamSetType paramSet)
void	fireParamSetRemoved(ParamSetType paramSet)
void	fireParamSetRenamed(ParamSetType paramSet)
void	fixHashes(PhonScript script)	Update hash values of all entries using provided script.
List<ParamSetType>	getNamedParamSets()
ParamHistoryType	getParamHistory()
ParamSetType	getParamSet(int idx)
ParamSetType	getParamSet(PhonScript script)
ParamSetType	getParamSet(String hash)
ParamSetType	getParamSetByName(String name)
ScriptParameters	getScriptParameters(PhonScript script)
List<ParamSetType>	getUnnamedParamSets()
int	indexOf(String hash)
int	indexOfName(String name)
static ParamHistoryType	loadParamHistoryFromFile(File paramHistoryFile)
static ParamHistoryType	loadParamHistoryFromStream(InputStream inputStream)
ParamSetType	nameParamSet(String name, ScriptParameters params)
ParamSetType	nameParamSet(String name, PhonScript script)
ParamSetType	nameParamSet(String name, String hash)	Name a param set which already exists.
void	removeAll()
List<ParamSetType>	removeAllUnnamedParamSets()
void	removeParamHistoryListener(ParamHistoryManager.ParamHistoryListener listener)
ParamSetType	removeParamSet(int idx)
ParamSetType	removeParamSet(String hash)
void	save(File paramHistoryFile)
static void	saveParamHistory(ParamHistoryType paramHistory, File paramHistoryFile)
static void	saveParamHistory(ParamHistoryType paramHistory, OutputStream outputStream)
int	size()

Methods inherited from class java.lang.Object

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

Constructor Details

ParamHistoryManager

public ParamHistoryManager(ParamHistoryType paramHistory)

ParamHistoryManager

public ParamHistoryManager(File paramHistoryFile)
                    throws IOException

Throws:

IOException

ParamHistoryManager

public ParamHistoryManager(InputStream inputStream)
                    throws IOException

Throws:

IOException

Method Details

loadParamHistoryFromFile

public static ParamHistoryType loadParamHistoryFromFile(File paramHistoryFile)
                                                 throws IOException

Throws:

IOException

loadParamHistoryFromStream

public static ParamHistoryType loadParamHistoryFromStream(InputStream inputStream)
                                                   throws IOException

Throws:

IOException

saveParamHistory

public static void saveParamHistory(ParamHistoryType paramHistory,
 File paramHistoryFile)
                             throws IOException

Throws:

IOException

saveParamHistory

public static void saveParamHistory(ParamHistoryType paramHistory,
 OutputStream outputStream)
                             throws IOException

Throws:

IOException

getParamHistory

public ParamHistoryType getParamHistory()

size

public int size()

indexOf

public int indexOf(String hash)

indexOfName

public int indexOfName(String name)

getParamSetByName

public ParamSetType getParamSetByName(String name)

getParamSet

public ParamSetType getParamSet(PhonScript script)
                         throws PhonScriptException

Throws:

PhonScriptException

getParamSet

public ParamSetType getParamSet(String hash)

getParamSet

public ParamSetType getParamSet(int idx)

removeParamSet

public ParamSetType removeParamSet(String hash)

removeParamSet

public ParamSetType removeParamSet(int idx)

getUnnamedParamSets

public List<ParamSetType> getUnnamedParamSets()

getNamedParamSets

public List<ParamSetType> getNamedParamSets()

nameParamSet

public ParamSetType nameParamSet(String name,
 PhonScript script)
                          throws PhonScriptException

Throws:

PhonScriptException

nameParamSet

public ParamSetType nameParamSet(String name,
 ScriptParameters params)

nameParamSet

public ParamSetType nameParamSet(String name,
 String hash)

Name a param set which already exists.

Parameters:

name -

hash -

Returns:

getScriptParameters

public ScriptParameters getScriptParameters(PhonScript script)
                                     throws PhonScriptException

Throws:

PhonScriptException

addParamSet

public ParamSetType addParamSet(PhonScript script)
                         throws PhonScriptException

Throws:

PhonScriptException

addParamSet

public ParamSetType addParamSet(ScriptParameters params)

addParamSet

public ParamSetType addParamSet(ParamSetType paramSet)

Add the given param set. If these parameters already exist in the file, the old reference is moved to the end of the list and date is updated.

Parameters:

paramSet -

Returns:

the paramSet modified by this method (could be different than the param)

save

public void save(File paramHistoryFile)
          throws IOException

Throws:

IOException

removeAll

public void removeAll()

removeAllUnnamedParamSets

public List<ParamSetType> removeAllUnnamedParamSets()

fixHashes

public void fixHashes(PhonScript script)
               throws PhonScriptException

Update hash values of all entries using provided script. (used for stock param sets after loading)

Parameters:

script -

Throws:

PhonScriptException

fireParamSetAdded

public void fireParamSetAdded(ParamSetType paramSet)

fireParamSetRemoved

public void fireParamSetRemoved(ParamSetType paramSet)

fireParamSetRenamed

public void fireParamSetRenamed(ParamSetType paramSet)

fireParamHistoryEvent

public void fireParamHistoryEvent(ParamHistoryManager.ParamHistoryEvent event)

addParamHistoryListener

public void addParamHistoryListener(ParamHistoryManager.ParamHistoryListener listener)

removeParamHistoryListener

public void removeParamHistoryListener(ParamHistoryManager.ParamHistoryListener listener)