Application: gvSIG desktop » Library: org.gvsig.tools

/**

 * gvSIG. Desktop Geographic Information System.

 *

 * Copyright (C) 2007-2020 gvSIG Association.

 *

 * This program is free software; you can redistribute it and/or

 * modify it under the terms of the GNU General Public License

 * as published by the Free Software Foundation; either version 3

 * of the License, or (at your option) any later version.

 *

 * This program is distributed in the hope that it will be useful,

 * but WITHOUT ANY WARRANTY; without even the implied warranty of

 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

 * GNU General Public License for more details.

 *

 * You should have received a copy of the GNU General Public License

 * along with this program; if not, write to the Free Software

 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

 * MA 02110-1301, USA.

 *

 * For any additional information, do not hesitate to contact us

 * at info AT gvsig.com, or visit our website www.gvsig.com.

 */

package org.gvsig.tools.namestranslator;

import java.util.List;

import java.util.function.Function;

import org.gvsig.tools.lang.Cloneable;

/**

 *

 * @author jjdelcerro

 */

public interface NamesTranslator extends Cloneable {

  public static NamesTranslator createTrimTranslator(int maxNameLen) {

    return new TrimNamesTranslator(maxNameLen);

  }

  public static NamesTranslator createBaseTranslator() {

      return new BaseNamesTranslator();

  }

  public static NamesTranslator createDummyTranslator() {

    return new DummyNamesTranslator();

  }

  /**

   * 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.

   * 

   * @param names 

   */

  public void setSourceNames(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.

   *

   * @param names 

   */

  public void setSourceNames(Iterable<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.

   *

   * @param objs

   * @param name_getter 

   */

  public void setSourceNames(Iterable objs, Function<Object, String> name_getter);

  /** 

   * Return the list of source names.

   * 

   * @return 

   */

  public List<String> getSourceNames();

  /** 

   * Return the list of translated names.

   * 

   * @return 

   */

  public List<String> getTranslatedNames();

  /** 

   * Return the list of translated names as a String array.

   * 

   * @return 

   */

  public String[] getTranslatedNamesAsArray();

  /**

   * Returns the translation corresponding to the source name indicated 

   * in the "sourceName" parameter.

   * 

   * @param sourceName

   * @return 

   */

  public String getTranslation(String sourceName);

  /**

   * Returns the source name corresponding to the translation indicated 

   * in the "translationName" parameter.

   * 

   * @param translatedName

   * @return 

   */

  public String getSource(String translatedName);

  /**

   * Returns the translation corresponding to the source name indicated 

   * in the "index" parameter.

   * 

   * @param index

   * @return 

   */

  public String getTranslation(int index);

  /**

   * Returns the source name corresponding to the translation indicated 

   * in the "index" parameter.

   * 

   * @param index

   * @return 

   */

  public String getSource(int index);

  /**

   * 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.

   * 

   * @param name

   * @return 

   */

  public String getSuggestion(String name);

  /**

   * Returns true if the name passed as a parameter does not collide 

   * with any of the existing translations.

   * 

   * @param name

   * @return 

   */

  public boolean isValid(String name);

  /**

   * 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.

   * 

   * @param sourceName

   * @param translatedName

   * @return 

   */

  public int setTranslation(String sourceName, String translatedName);

  public void rebuild();

  public int addSource(String sourceName);

  @Override

  public NamesTranslator clone() throws CloneNotSupportedException;

  public void updateSourceNames(String[] names);

  public void updateSourceNames(Iterable<String> names);

  public void updateSourceNames(Iterable objs, Function<Object, String> name_getter);

}