01: /*
02: * Licensed to the Apache Software Foundation (ASF) under one or more
03: * contributor license agreements. See the NOTICE file distributed with
04: * this work for additional information regarding copyright ownership.
05: * The ASF licenses this file to You under the Apache License, Version 2.0
06: * (the "License"); you may not use this file except in compliance with
07: * the License. You may obtain a copy of the License at
08: *
09: * http://www.apache.org/licenses/LICENSE-2.0
10: *
11: * Unless required by applicable law or agreed to in writing, software
12: * distributed under the License is distributed on an "AS IS" BASIS,
13: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14: * See the License for the specific language governing permissions and
15: * limitations under the License.
16: */
17: package org.apache.cocoon.forms.datatype.convertor;
18:
19: import org.xml.sax.SAXException;
20: import org.xml.sax.ContentHandler;
21:
22: import java.util.Locale;
23:
24: /**
25: * The purpose of a Convertor is to convert between Object and String
26: * representations of the same thing. For example, convert
27: * {@link Long}s or {@link java.util.Date Date}s to strings, and vice
28: * versa. The behaviour of this conversion process can depend on the
29: * user's Locale.
30: *
31: * <p>If you need to do mass conversion of a lot of values, it may be
32: * beneficial to pass a {@link FormatCache} object to the convert methods.
33: * Some convertors need to build and configure parser or formatting objects,
34: * which can be expensive if it needs to be done repeatedly.
35: *
36: * @version $Id: Convertor.java 449149 2006-09-23 03:58:05Z crossley $
37: */
38: public interface Convertor {
39:
40: /**
41: * Converts string representation into the object of convertor's type.
42: *
43: * @param formatCache can be null if not needed
44: */
45: ConversionResult convertFromString(String value, Locale locale,
46: FormatCache formatCache);
47:
48: String convertToString(Object value, Locale locale,
49: FormatCache formatCache);
50:
51: Class getTypeClass();
52:
53: /**
54: * Generates a bit of information about this convertor (optional).
55: */
56: void generateSaxFragment(ContentHandler contentHandler,
57: Locale locale) throws SAXException;
58:
59: public interface FormatCache {
60: public Object get();
61:
62: public void store(Object object);
63: }
64: }
|