org.gvsig.tools.namestranslator

Interface NamesTranslator

All Superinterfaces:

java.lang.Cloneable

All Known Implementing Classes:

AbstractNamesTranslator, BaseNamesTranslator, DummyNamesTranslator, ExportJDBCAttributeNamesTranslator, TrimNamesTranslator

public interface NamesTranslator
extends Cloneable

Method Summary

Modifier and Type	Method and Description
int	addSource(java.lang.String sourceName)
void	clear()
NamesTranslator	clone() Creates a copy of the object.
static NamesTranslator	createBaseTranslator()
static NamesTranslator	createDummyTranslator()
static NamesTranslator	createTrimTranslator(int maxNameLen)
java.util.List<java.lang.String>	getAllTranslations(java.lang.String sourceName)
java.lang.String	getSource(int index) Returns the source name corresponding to the translation indicated in the "index" parameter.
java.lang.String	getSource(java.lang.String translatedName) Returns the source name corresponding to the translation indicated in the "translationName" parameter.
java.util.List<java.lang.String>	getSourceNames() Return the list of source names.
java.lang.String	getSuggestion(java.lang.String name) Check if the name passed as a parameter collides with any existing translation.
java.util.List<java.lang.String>	getTranslatedNames() Return the list of translated names.
java.lang.String[]	getTranslatedNamesAsArray() Return the list of translated names as a String array.
java.lang.String	getTranslation(int index) Returns the translation corresponding to the source name indicated in the "index" parameter.
java.lang.String	getTranslation(java.lang.String sourceName) Returns the translation corresponding to the source name indicated in the "sourceName" parameter.
boolean	hasDuplicateSources()
boolean	isValid(java.lang.String name) Returns true if the name passed as a parameter does not collide with any of the existing translations.
void	rebuild()
void	setSourceNames(java.lang.Iterable<java.lang.String> names) Assign the list of source names and generate the list of translations from them.
void	setSourceNames(java.lang.Iterable objs, java.util.function.Function<java.lang.Object,java.lang.String> name_getter) Assign the list of source names and generate the list of translations from them.
void	setSourceNames(java.lang.String[] names) Assign the list of source names and generate the list of translations from them.
int	setTranslation(int sourcePosition, java.lang.String translatedName)
int	setTranslation(java.lang.String sourceName, java.lang.String translatedName) Assign the translation "translationName" to the name "sourceName".
void	updateSourceNames(java.lang.Iterable<java.lang.String> names)
void	updateSourceNames(java.lang.Iterable objs, java.util.function.Function<java.lang.Object,java.lang.String> name_getter)
void	updateSourceNames(java.lang.String[] names)

Methods inherited from interface org.gvsig.tools.lang.Cloneable

cloneQuietly, cloneQuietly

Method Detail

createTrimTranslator

static NamesTranslator createTrimTranslator(int maxNameLen)

createBaseTranslator

static NamesTranslator createBaseTranslator()

createDummyTranslator

static NamesTranslator createDummyTranslator()

setSourceNames

void setSourceNames(java.lang.String[] names)

Assign the list of source names and generate the list of translations from them. If any of the source names collide with another, it will create the translation using the "getSugestion" method.

Parameters:

names -

setSourceNames

void setSourceNames(java.lang.Iterable<java.lang.String> names)

Assign the list of source names and generate the list of translations from them. If any of the source names collide with another, it will create the translation using the "getSugestion" method.

Parameters:

names -

setSourceNames

void setSourceNames(java.lang.Iterable objs,
                    java.util.function.Function<java.lang.Object,java.lang.String> name_getter)

Assign the list of source names and generate the list of translations from them. If any of the source names collide with another, it will create the translation using the "getSugestion" method.

Parameters:

objs -

name_getter -

getSourceNames

java.util.List<java.lang.String> getSourceNames()

Return the list of source names.

Returns:

getTranslatedNames

java.util.List<java.lang.String> getTranslatedNames()

Return the list of translated names.

Returns:

getTranslatedNamesAsArray

java.lang.String[] getTranslatedNamesAsArray()

Return the list of translated names as a String array.

Returns:

getTranslation

java.lang.String getTranslation(java.lang.String sourceName)

Returns the translation corresponding to the source name indicated in the "sourceName" parameter.

Parameters:

sourceName -

Returns:

getSource

java.lang.String getSource(java.lang.String translatedName)

Returns the source name corresponding to the translation indicated in the "translationName" parameter.

Parameters:

translatedName -

Returns:

getTranslation

java.lang.String getTranslation(int index)

Returns the translation corresponding to the source name indicated in the "index" parameter.

Parameters:

index -

Returns:

getSource

java.lang.String getSource(int index)

Returns the source name corresponding to the translation indicated in the "index" parameter.

Parameters:

index -

Returns:

getSuggestion

java.lang.String getSuggestion(java.lang.String name)

Check if the name passed as a parameter collides with any existing translation. If it collides it generates a new name from the past as a parameter and returns it. If it does not collide, it returns.

Parameters:

name -

Returns:

isValid

boolean isValid(java.lang.String name)

Returns true if the name passed as a parameter does not collide with any of the existing translations.

Parameters:

name -

Returns:

setTranslation

int setTranslation(java.lang.String sourceName,
                   java.lang.String translatedName)

Assign the translation "translationName" to the name "sourceName". If it collides with some other, change the translation of the colliding and return its index. If it does not collide it returns -1.

Parameters:

sourceName -

translatedName -

Returns:

setTranslation

int setTranslation(int sourcePosition,
                   java.lang.String translatedName)

rebuild

void rebuild()

addSource

int addSource(java.lang.String sourceName)

clone

NamesTranslator clone()
               throws java.lang.CloneNotSupportedException

Description copied from interface: Cloneable

Creates a copy of the object.

Returns:

a copy of the object

Throws:

java.lang.CloneNotSupportedException - if the instance of the object cannot be cloned. As this is extending Cloneable so its sure it implements it, so this exception may be used for problems on specific object instances.

See Also:

Object#clone()}.

updateSourceNames

void updateSourceNames(java.lang.String[] names)

updateSourceNames

void updateSourceNames(java.lang.Iterable<java.lang.String> names)

updateSourceNames

void updateSourceNames(java.lang.Iterable objs,
                       java.util.function.Function<java.lang.Object,java.lang.String> name_getter)

getAllTranslations

java.util.List<java.lang.String> getAllTranslations(java.lang.String sourceName)

clear

void clear()

hasDuplicateSources

boolean hasDuplicateSources()