info.bioinfweb.commons.text

Class UniqueNameMap

java.lang.Object

info.bioinfweb.commons.text.UniqueNameMap

public class UniqueNameMap
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
UniqueNameMap(UniqueNameMapParameters parameters)

Method Summary

Modifier and Type	Method and Description
java.lang.String	addName(java.lang.String name) Adds an original name as the key and its processed version as the values to the map.
void	addNames(java.util.Collection<java.lang.String> names)
void	clear()
boolean	containsKey(java.lang.Object key)
boolean	containsValue(java.lang.Object value)
java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.String>>	entrySet()
protected java.util.Map<java.lang.String,java.lang.String>	getMap()
UniqueNameMapParameters	getParameters()
java.lang.String	getProcessedName(java.lang.String originalName)
boolean	isEmpty()
java.util.Set<java.lang.String>	keySet()
java.lang.String	remove(java.lang.Object key)
int	size()
java.util.Collection<java.lang.String>	values()
void	writeNameMap(java.io.File file) Writes the contents of the current name map in text format as tab separated values.
void	writeNameMap(java.io.OutputStream stream) Writes the contents of the current name map in text format as tab separated values.

Methods inherited from class java.lang.Object

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

Constructor Detail

UniqueNameMap

public UniqueNameMap(UniqueNameMapParameters parameters)

Method Detail

getParameters

public UniqueNameMapParameters getParameters()

getMap

protected java.util.Map<java.lang.String,java.lang.String> getMap()

addName

public java.lang.String addName(java.lang.String name)

Adds an original name as the key and its processed version as the values to the map.

Parameters:

name - the original name (stored as the key in the new map entry)

Returns:

the processed name (stored as the value in the new map entry)

addNames

public void addNames(java.util.Collection<java.lang.String> names)

getProcessedName

public java.lang.String getProcessedName(java.lang.String originalName)

clear

public void clear()

containsKey

public boolean containsKey(java.lang.Object key)

containsValue

public boolean containsValue(java.lang.Object value)

entrySet

public java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.String>> entrySet()

isEmpty

public boolean isEmpty()

keySet

public java.util.Set<java.lang.String> keySet()

remove

public java.lang.String remove(java.lang.Object key)

size

public int size()

values

public java.util.Collection<java.lang.String> values()

writeNameMap

public void writeNameMap(java.io.OutputStream stream)

Writes the contents of the current name map in text format as tab separated values. Every line contains one name pair, where the first column contains the processed name and the second column the original name.

Parameters:

stream - the stream to write the table to

writeNameMap

public void writeNameMap(java.io.File file)
                  throws java.io.FileNotFoundException,
                         java.io.IOException

Writes the contents of the current name map in text format as tab separated values. Every line contains one name pair, where the first column contains the processed name and the second column the original name.

Parameters:

file - the file to write the table to

Throws:

java.io.FileNotFoundException - if the file exists but is a directory rather than a regular file, does not exist but cannot be created, or cannot be opened for any other reason

java.lang.SecurityException - if a security manager exists and its checkWrite method denies write access to the file.

java.io.IOException