001package org.hl7.fhir.utilities;
002
003/*
004  Copyright (c) 2011+, HL7, Inc.
005  All rights reserved.
006  
007  Redistribution and use in source and binary forms, with or without modification, 
008  are permitted provided that the following conditions are met:
009    
010   * Redistributions of source code must retain the above copyright notice, this 
011     list of conditions and the following disclaimer.
012   * Redistributions in binary form must reproduce the above copyright notice, 
013     this list of conditions and the following disclaimer in the documentation 
014     and/or other materials provided with the distribution.
015   * Neither the name of HL7 nor the names of its contributors may be used to 
016     endorse or promote products derived from this software without specific 
017     prior written permission.
018  
019  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
020  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
021  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 
022  IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, 
023  INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 
024  NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 
025  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
026  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
027  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
028  POSSIBILITY OF SUCH DAMAGE.
029  
030 */
031
032
033
034import java.util.Date;
035import java.util.Map;
036import java.util.Set;
037
038public interface TranslationServices {
039  /**
040   * General translation functionality - given a string, translate it to a different language
041   * 
042   * @param context - for debugging purposes
043   * @param value - the string to translate
044   * @param targetLang - the target language to translate to. 
045   * 
046   * @return the translated string, or value if no translation is found
047   */
048  String translate(String context, String value, String targetLang);
049
050  /**
051   * General translation functionality - given a string, translate it to a different language, but also perform String.format on the outcome.
052   * 
053   * @param contest
054   * @param lang
055   * @param string2
056   * @param args
057   * @return
058   */
059  String translateAndFormat(String contest, String lang, String string2, Object... args);
060
061  /** 
062   * equivalent to the general translation operation, but the context that provides the transations specifies the target language
063   *  
064   * @param context
065   * @param value
066   * @return
067   */
068  String translate(String context, String value);
069
070  /**
071   * Get a list of all translations available for a phrase
072   * 
073   * @param value
074   * @return
075   */
076  Map<String, String> translations(String value);
077
078  /** 
079   * localization for converting a decimal to language specific representation
080   * 
081   * @param value
082   * @return
083   */
084  String toStr(float value);
085
086  /** 
087   * localization for converting a date to language specific representation
088   * 
089   * @param value
090   * @return
091   */
092  String toStr(Date value);
093
094  /**
095   * get a list of translation codes by category
096   * @param category
097   * @return
098   */
099  Set<String> listTranslations(String category);
100
101}