01: /***************************************************************
02: * This file is part of the [fleXive](R) project.
03: *
04: * Copyright (c) 1999-2008
05: * UCS - unique computing solutions gmbh (http://www.ucs.at)
06: * All rights reserved
07: *
08: * The [fleXive](R) project is free software; you can redistribute
09: * it and/or modify it under the terms of the GNU General Public
10: * License as published by the Free Software Foundation;
11: * either version 2 of the License, or (at your option) any
12: * later version.
13: *
14: * The GNU General Public License can be found at
15: * http://www.gnu.org/copyleft/gpl.html.
16: * A copy is found in the textfile GPL.txt and important notices to the
17: * license from the author are found in LICENSE.txt distributed with
18: * these libraries.
19: *
20: * This library is distributed in the hope that it will be useful,
21: * but WITHOUT ANY WARRANTY; without even the implied warranty of
22: * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23: * GNU General Public License for more details.
24: *
25: * For further information about UCS - unique computing solutions gmbh,
26: * please see the company website: http://www.ucs.at
27: *
28: * For further information about [fleXive](R), please see the
29: * project website: http://www.flexive.org
30: *
31: *
32: * This copyright notice MUST APPEAR in all copies of the file!
33: ***************************************************************/package com.flexive.shared.value.renderer;
34:
35: import com.flexive.shared.FxLanguage;
36: import com.flexive.shared.value.FxValue;
37:
38: import java.io.IOException;
39: import java.io.Writer;
40:
41: /**
42: * A locale-specific renderer for FxValue objects.
43: *
44: * @author Daniel Lichtenberger (daniel.lichtenberger@flexive.com), UCS - unique computing solutions gmbh (http://www.ucs.at)
45: * @version $Rev: 181 $
46: */
47: public interface FxValueRenderer {
48: /**
49: * Formats the given value in the renderer's locale. If <code>value</code> is
50: * multi-lingual, then the translation in the renderer's locale is used.
51: * If no translation is available, the default translation is used
52: * (see {@link com.flexive.shared.value.FxValue#getBestTranslation()} }).
53: *
54: * @param value the value to be formatted
55: * @return the formatted value
56: */
57: String format(FxValue value);
58:
59: /**
60: * Formats the given value in the renderer's locale. If <code>value</code> is multi-lingual,
61: * then the translation for the given translationLanguage is used.
62: * If no translation is available, the default translation is used
63: * (see {@link com.flexive.shared.value.FxValue#getBestTranslation()} }).
64: *
65: * @param value the value to be formatted
66: * @param translationLanguage the translation which should be retrieved from the value
67: * @return the formatted value
68: */
69: String format(FxValue value, FxLanguage translationLanguage);
70:
71: /**
72: * Renders the given value in the renderer's locale to the output writer. If <code>value</code> is
73: * multi-lingual, then the translation in the renderer's locale is used.
74: * If no translation is available, the default translation is used
75: * (see {@link com.flexive.shared.value.FxValue#getBestTranslation()} }).
76: *
77: * @param out the output writer
78: * @param value the value to be rendered
79: * @return the FxValueRenderer instance
80: * @throws java.io.IOException if the value could not be written
81: */
82: FxValueRenderer render(Writer out, FxValue value)
83: throws IOException;
84:
85: /**
86: * Renders the given value in the renderer's locale to the output writer. If <code>value</code> is
87: * multi-lingual, then the translation for the given translationLanguage is used.
88: * If no translation is available, the default translation is used
89: * (see {@link com.flexive.shared.value.FxValue#getBestTranslation()} }).
90: *
91: * @param out the output writer
92: * @param value the value to be rendered
93: * @param translationLanguage the translation which should be retrieved from the value
94: * @return the FxValueRenderer instance
95: * @throws java.io.IOException if the value could not be written
96: */
97: FxValueRenderer render(Writer out, FxValue value,
98: FxLanguage translationLanguage) throws IOException;
99: }
|