01: /*
02: * Copyright 2004-2006 the original author or authors.
03: *
04: * Licensed under the Apache License, Version 2.0 (the "License");
05: * you may not use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.apache.org/licenses/LICENSE-2.0
09: *
10: * Unless required by applicable law or agreed to in writing, software
11: * distributed under the License is distributed on an "AS IS" BASIS,
12: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13: * See the License for the specific language governing permissions and
14: * limitations under the License.
15: */
16:
17: package org.compass.core.converter.dynamic;
18:
19: import org.compass.core.converter.ConversionException;
20: import org.compass.core.converter.Converter;
21: import org.compass.core.converter.basic.FormatConverter;
22:
23: /**
24: * A converter that evaluates dynamic expressions using a dynamic
25: * expression library or scripting library.
26: *
27: * @author kimchy
28: */
29: public interface DynamicConverter extends Converter {
30:
31: static final String DATA_CONTEXT_KEY = "data";
32:
33: /**
34: * Copies over the dynamic converter.
35: */
36: DynamicConverter copy();
37:
38: /**
39: * Sets the expression this dynamic converter will ecaluate.
40: *
41: * @param expression The expression to evaluate
42: * @throws ConversionException
43: */
44: void setExpression(String expression) throws ConversionException;
45:
46: /**
47: * If the dynamic expression evaluates to a formatable object (like Date),
48: * the format converter that will be used to format it.
49: */
50: void setFormatConverter(FormatConverter formatConverter);
51:
52: /**
53: * The return type of the evaluated expression.
54: */
55: void setType(Class type);
56:
57: /**
58: * The return type of the evaluated expression.
59: */
60: Class getType();
61: }
|