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: /**
39: * Interface for a FxValue formatter. Formatters provide a datatype-specific and
40: * locale-specific way for rendering FxValue instances to the user interface.
41: * Formatters are usually not instantiated directly, but used by a
42: * {@link FxValueRenderer} to format FxValues. A FxValueRenderer for a given language
43: * can be retrieved using the {@link FxValueRendererFactory}.
44: *
45: * @author Daniel Lichtenberger (daniel.lichtenberger@flexive.com), UCS - unique computing solutions gmbh (http://www.ucs.at)
46: * @version $Rev: 181 $
47: */
48: public interface FxValueFormatter<DataType, ValueType extends FxValue<DataType, ValueType>> {
49: /**
50: * Formats a FxValue object.
51: *
52: * @param container the FxValue container object
53: * @param value the value to be formatted.
54: * @param outputLanguage the language to be used for rendering the value. This may
55: * or may not be the language for which the value was stored in the FxValue container.
56: *
57: * @return the formatted value
58: */
59: String format(ValueType container, DataType value,
60: FxLanguage outputLanguage);
61: }
|