org.gvsig.tools.namestranslator

Class BaseNamesTranslator

java.lang.Object

org.gvsig.tools.namestranslator.AbstractNamesTranslator

org.gvsig.tools.namestranslator.BaseNamesTranslator

All Implemented Interfaces:

java.lang.Cloneable, NamesTranslator, Persistent

Direct Known Subclasses:

ExportJDBCAttributeNamesTranslator, TrimNamesTranslator

public class BaseNamesTranslator
extends AbstractNamesTranslator
implements NamesTranslator, Persistent

Nested Class Summary

Nested classes/interfaces inherited from class org.gvsig.tools.namestranslator.AbstractNamesTranslator

AbstractNamesTranslator.SimpleList, AbstractNamesTranslator.SimpleMap

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_FIELD_NAME
protected boolean	hasTranslations
protected AbstractNamesTranslator.SimpleMap	source2translation
protected AbstractNamesTranslator.SimpleList	translatedNames
protected AbstractNamesTranslator.SimpleMap	translation2source

Fields inherited from class org.gvsig.tools.namestranslator.AbstractNamesTranslator

sourceNames

Constructor Summary

Constructors

Constructor and Description
BaseNamesTranslator()

Method Summary

Modifier and Type	Method and Description
int	addSource(java.lang.String sourceName)
protected void	build()
void	clear()
NamesTranslator	clone() Creates a copy of the object.
java.util.List<java.lang.String>	getAllTranslations(java.lang.String sourceName)
java.lang.String	getSource(java.lang.String translatedName) Returns the source name corresponding to the translation indicated in the "translationName" parameter.
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	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	loadFromState(PersistentState state) Set the state of the object from the state passed as parameter.
void	rebuild()
static void	registerPersistence()
void	saveToState(PersistentState state) Saves the internal state of the object on the provided PersistentState object.
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 class org.gvsig.tools.namestranslator.AbstractNamesTranslator

getSource, getSourceNames, getTranslatedNamesAsArray, setSourceNames, setSourceNames, setSourceNames

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gvsig.tools.namestranslator.NamesTranslator

createBaseTranslator, createDummyTranslator, createTrimTranslator, getSource, getSourceNames, getTranslatedNamesAsArray, setSourceNames, setSourceNames, setSourceNames

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

cloneQuietly, cloneQuietly

Field Detail

source2translation

protected AbstractNamesTranslator.SimpleMap source2translation

translation2source

protected AbstractNamesTranslator.SimpleMap translation2source

hasTranslations

protected boolean hasTranslations

DEFAULT_FIELD_NAME

public static final java.lang.String DEFAULT_FIELD_NAME

See Also:

Constant Field Values

translatedNames

protected AbstractNamesTranslator.SimpleList translatedNames

Constructor Detail

BaseNamesTranslator

public BaseNamesTranslator()

Method Detail

clone

public NamesTranslator clone()
                      throws java.lang.CloneNotSupportedException

Description copied from interface: Cloneable

Creates a copy of the object.

Specified by:

clone in interface NamesTranslator

Overrides:

clone in class AbstractNamesTranslator

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()}.

build

protected void build()

Specified by:

build in class AbstractNamesTranslator

getTranslatedNames

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

Description copied from interface: NamesTranslator

Return the list of translated names.

Specified by:

getTranslatedNames in interface NamesTranslator

Returns:

getTranslation

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

Description copied from interface: NamesTranslator

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

Specified by:

getTranslation in interface NamesTranslator

Returns:

getSource

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

Description copied from interface: NamesTranslator

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

Specified by:

getSource in interface NamesTranslator

Returns:

getTranslation

public java.lang.String getTranslation(int index)

Description copied from interface: NamesTranslator

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

Specified by:

getTranslation in interface NamesTranslator

Returns:

addSource

public int addSource(java.lang.String sourceName)

Specified by:

addSource in interface NamesTranslator

setTranslation

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

Description copied from interface: NamesTranslator

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.

Specified by:

setTranslation in interface NamesTranslator

Returns:

setTranslation

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

Specified by:

setTranslation in interface NamesTranslator

getSuggestion

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

Description copied from interface: NamesTranslator

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.

Specified by:

getSuggestion in interface NamesTranslator

Returns:

isValid

public boolean isValid(java.lang.String name)

Description copied from interface: NamesTranslator

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

Specified by:

isValid in interface NamesTranslator

Overrides:

isValid in class AbstractNamesTranslator

Returns:

registerPersistence

public static void registerPersistence()

saveToState

public void saveToState(PersistentState state)
                 throws PersistenceException

Description copied from interface: Persistent

Saves the internal state of the object on the provided PersistentState object.

Specified by:

saveToState in interface Persistent

Overrides:

saveToState in class AbstractNamesTranslator

Throws:

PersistenceException

loadFromState

public void loadFromState(PersistentState state)
                   throws PersistenceException

Description copied from interface: Persistent

Set the state of the object from the state passed as parameter.

Specified by:

loadFromState in interface Persistent

Overrides:

loadFromState in class AbstractNamesTranslator

Throws:

PersistenceException

rebuild

public void rebuild()

Specified by:

rebuild in interface NamesTranslator

updateSourceNames

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

Specified by:

updateSourceNames in interface NamesTranslator

updateSourceNames

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

Specified by:

updateSourceNames in interface NamesTranslator

updateSourceNames

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

Specified by:

updateSourceNames in interface NamesTranslator

getAllTranslations

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

Specified by:

getAllTranslations in interface NamesTranslator

clear

public void clear()

Specified by:

clear in interface NamesTranslator

hasDuplicateSources

public boolean hasDuplicateSources()

Specified by:

hasDuplicateSources in interface NamesTranslator